Skip to main content
POST
Iniciar ligação

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

Idempotency-Key
string

Chave única para evitar envio duplicado. Alternativa: x-idempotency-key.

x-idempotency-key
string

Chave única para idempotência (alternativa a Idempotency-Key).

Corpo

application/json

Chamada de voz: from, to, type e conteúdo em payload.

from
string
obrigatório

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

type
enum<string>
obrigatório

Tipo da ação inicial. ivr: payload.flowId ou payload.flow (grafo inline).

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

speak: text, opcional voice/language. play: audioUrl. gather: objeto gather. template: templateId, variables.

to
string[]
obrigatório

Destinos E.164 sem + (ex.: 5511999887766).

Required array length: 1 - 500 elements
gather
object
record
boolean

Gravar a chamada após atender. Padrão: false.

amdMode
enum<string>

Detecção de caixa postal (AMD). Padrão: disabled.

Opções disponíveis:
disabled,
detect,
premium
machineDetection
string
obsoleto

Legado — use amdMode.

clientState
string
schedule
object

Programación opcional (sendAt ISO 8601). Aún no implementado en POST /v1/voice/calls — usa el panel (Nueva llamada → Programar) o espera soporte en API v1.

localization
object

Tradução do script por destinatário (speakText, gatherPrompt).

i18n
object

Mapa locale → string ou { speakText, gatherPrompt? } (modo manual).

options
object
metadata
object

Metadados do cliente gravados no registro da chamada.

Resposta

Chamada enfileirada.

success
boolean
obrigatório
Exemplo:

true

data
object
obrigatório