Skip to main content
POST
Iniciar ligação

Autorizações

Authorization
string
header
obrigatório

API Key no formato Bearer (ex.: sk_live_...).

Corpo

application/json
from
string
obrigatório

Id do número no workspace ou E.164.

to
obrigatório

Destino E.164 (+...). Preferencialmente um array (canônico); string aceita por compatibilidade.

Required array length: 1 - 100 elements
type
enum<string>
obrigatório

Tipo da ação inicial: speak (TTS em payload.text), play (payload.audioUrl), gather (payload.gather), template (payload.templateId).

Opções disponíveis:
speak,
play,
gather,
template
payload
object
obrigatório

Conteúdo conforme type. speak: text, opcional voice/language. play: audioUrl. gather: objeto gather. template: templateId + variables opcionais.

record
boolean
machineDetection
string
Exemplo:

"detect"

clientState
string

Resposta

Chamada enfileirada.

success
boolean
obrigatório
data
object
obrigatório