Chamadas

Iniciar chamada (BIC)

Inicia uma chamada de voz do negócio para o usuário (business-initiated call). Body: { to, sdp?, sdpType?:"offer", bizOpaqueCallbackData? }. Números Meta: o sdp é OBRIGATÓRIO — a oferta RFC 8866 do SEU cliente WebRTC (lado do negócio deve usar a=setup:active) — e exige permissão prévia do usuário (senão a Meta retorna 138006 → META_CALL_PERMISSION_REQUIRED); cobrança por minuto pela Meta, direto na sua WABA, só quando atendida. Números web (não-oficiais): OMITA o sdp — a mídia é tratada no servidor — sem etapa de permissão e sem cobrança da Meta. **Requer uma chave com escopo de número.**

POST

calls

curl --request POST \
  --url https://pilotstatus.com.br/v1/calls \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "to": "+5511999999999",
  "sdp": "v=0\r\n...",
  "bizOpaqueCallbackData": "order-42"
}
'

{
  "id": "call_01HZX...",
  "externalCallId": "wacid.ABGG...",
  "status": "INITIATED"
}

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Corpo

application/json

string

obrigatório

Número do usuário a ligar.

Exemplo:

"+5511999999999"

sdp

string

Oferta SDP do seu cliente WebRTC (a=setup:active). Obrigatório em números Meta; omita em números web.

sdpType

string

Sempre "offer" (padrão).

Exemplo:

"offer"

bizOpaqueCallbackData

string

Dado opaco ecoado no evento de término.

Exemplo:

"order-42"

Resposta

Iniciar chamada

Listar chamadas

Detalhe da chamada

⌘I

Iniciar chamada (BIC)

curl --request POST \
  --url https://pilotstatus.com.br/v1/calls \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "to": "+5511999999999",
  "sdp": "v=0\r\n...",
  "bizOpaqueCallbackData": "order-42"
}
'

{
  "id": "call_01HZX...",
  "externalCallId": "wacid.ABGG...",
  "status": "INITIATED"
}