WhatsApp · WhatsApp Phone Numbers

List offerable number countries

Returns offerable number countries.

GEThttps://api.pozy.ai/v1/whatsapp/phone-numbers/countries
DeprecatedlistWhatsAppNumberCountries

Request

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

Example

curl -X GET "https://api.pozy.ai/v1/whatsapp/phone-numbers/countries" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • countriesarray of object
    • codestring
    • tierinteger

      One of 1, 2, 3, 4.

    • monthlyCentsinteger
    • needsKycboolean
    • outboundCallingAvailableboolean
200 response
{
  "countries": [
    {
      "code": "string",
      "tier": 1,
      "monthlyCents": 1,
      "needsKyc": true,
      "outboundCallingAvailable": 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 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 Phone Numbers