WhatsApp Phone Numbers

Search available numbers

Changed on

Deprecated alias of /v1/phone-numbers/available; same contract. New integrations should use that path.

Search the provider's inventory for numbers available to purchase in a country (default US). Optional filters narrow the results. The country must be offerable (see GET /v1/whatsapp/phone-numbers/countries).

get/v1/whatsapp/phone-numbers/available

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/whatsapp/phone-numbers/available
  • Auth: HTTP bearer

Query parameters

countrystring
numberType'local' | 'mobile' | 'national' | 'toll_free'

Number type; defaults to the country's WhatsApp-safe type (the same name as on purchase, availability and kyc)

areaCodestring

Area code or national dialing code the number must start with, e.g. 415 or 91

typestring

Alias of numberType, kept for existing callers

prefixstring

Alias of areaCode, kept for existing callers

localitystring

A city name, matched against the numbering plan (accents and common aliases allowed) and searched by that city's area codes; a name no city of the plan matches returns no numbers. areaCode takes a city name too.

containsstring

Pattern to match within the number

limitinteger

Response

Available numbers.

countrystring
numberTypestring

Changes

  • f8c8f34fb41aRevision changes
    • warning

      added the new account enum value to the / response property for the response status

  • d556591af3f6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status