WhatsApp · WhatsApp Calling

Start caller-ID verification for a customer-brought number

Starts a caller-ID verification for a customer-brought number.

POSThttps://api.pozy.ai/v1/phone-numbers/{id}/whatsapp/caller-id-verification
startWhatsAppCallerIdVerification

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, optional

  • methodstring

    One of sms, call. Default sms.

Example

curl -X POST "https://api.pozy.ai/v1/phone-numbers/6bfebd43ddc270f6d2c56fc5/whatsapp/caller-id-verification" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "method": "sms"
}'

Response

200 on success

  • verifiedboolean
  • codeSentboolean
  • methodstring

    One of sms, call.

200 response
{
  "verified": true,
  "codeSent": true,
  "method": "sms"
}

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