WhatsApp · WhatsApp Calling

Initiate outbound call

Initiates an outbound call.

POSThttps://api.pozy.ai/v1/whatsapp/calls
initiateWhatsAppCall

Guides: WhatsApp calling, Idempotency and safe retries

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Headers

NameTypeNotes
Idempotency-KeystringUp to 255 charactersRetries with the same key return the original result. See Idempotency

Request body

application/json, required

  • accountIdstringrequired
  • tostringrequired
  • actionstring

    One of send_call_permission_request.

  • bodyTextstring

    Up to 1024 characters.

  • forwardTostring
  • recordOverrideboolean
  • biz_opaque_callback_datastring

    Up to 512 characters.

Example

curl -X POST "https://api.pozy.ai/v1/whatsapp/calls" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "to": "+14155550123"
}'

Response

200 on success

  • successboolean
  • callIdstring
  • carrierCallControlIdstring
  • statusstring

    One of dialing.

  • directionstring

    One of outbound.

  • tostring
  • forwardTostring

    Can be null.

  • recordingEnabledboolean
200 response
{
  "success": true,
  "callId": "6f502e3f20741dfe2abae39e",
  "carrierCallControlId": "6c367f42f99a6851724a1342",
  "status": "dialing",
  "direction": "outbound",
  "to": "+14155550123",
  "forwardTo": "string",
  "recordingEnabled": true
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in WhatsApp Calling