Calls

Start call (BIC)

Starts a business-initiated voice call to the user. Body: { to, sdp?, sdpType?:"offer", bizOpaqueCallbackData? }. Meta numbers: sdp is REQUIRED — the RFC 8866 offer from YOUR WebRTC client (business side must use a=setup:active) — and a prior user permission is required (otherwise Meta returns 138006 → META_CALL_PERMISSION_REQUIRED); billed per minute by Meta, directly on your WABA, only when answered. Web (unofficial) numbers: OMIT sdp — media is handled server-side — no permission step and no Meta billing. **Requires a number-scoped key.**

POST

calls

Start call (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"
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Body

application/json

string

required

User phone number to call.

Example:

"+5511999999999"

sdp

string

SDP offer from your WebRTC client (a=setup:active). Required on Meta numbers; omit on web numbers.

sdpType

string

Always "offer" (defaulted).

Example:

"offer"

bizOpaqueCallbackData

string

Opaque data echoed back on the terminate event.

Example:

"order-42"

Response

Start call

List calls

Get call

⌘I

Start call (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"
}