WhatsApp · WhatsApp Calling

Update calling config

Updates calling config. Fields you leave out keep their current values.

PATCHhttps://api.pozy.ai/v1/whatsapp/phone-numbers/{id}/calling
DeprecatedupdateWhatsAppCallingLegacy

Guide: WhatsApp calling

Request

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

Path parameters

NameTypeNotes
idrequiredstring

Request body

application/json, required

  • accountIdstringrequired
  • forwardTostring
  • sipAuthUsernamestring

    Can be null.

  • sipAuthPasswordstring

    Can be null.

  • recordingEnabledboolean
  • callIconCountriesarray of string

    Can be null.

  • maxCallDurationSecondsinteger

    30 to 14400. Can be null.

  • forwardCallerIdstring

    One of business, caller.

Example

curl -X PATCH "https://api.pozy.ai/v1/whatsapp/phone-numbers/6bfebd43ddc270f6d2c56fc5/calling" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9"
}'

Response

200 on success

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.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in WhatsApp Calling