Skip to main content
POST

Authorizations

Authorization
string
header
required

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Headers

Idempotency-Key
string

Idempotency key. Alternative: x-idempotency-key.

x-idempotency-key
string

Body

application/json

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

type
enum<string>
required

Call content type. Default: speak.

Available options:
speak,
play,
template
payload
object
required

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

to
string[]
required

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

Required array length: 1 - 500 elements
from
string
required

Instância WhatsApp: id, telefone E.164 ou nome (não use pool).

options
object
clientState
string

Response

Call queued.

success
boolean
Example:

true

data
object