WhatsApp Phone Numbers

Check country availability

Changed on

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

A pre-purchase check, so you can warn BEFORE a customer invests in KYC (regulated review is async, 1-3 days). It tells you whether we have deliverable inventory, and what address the customer needs. Call this before starting the KYC form for regulated countries.

Address constraints

  • addressConstraint: geo: the registered address MUST be in one of the returned areas (the only place we have stock). A different-area address passes pre-approval but the number can never be assigned.
  • addressConstraint: country: any in-country address works.
  • addressConstraint: none: field-only / instant country, no address.
get/v1/whatsapp/phone-numbers/availability

Request

Query parameters

countrystring required

ISO-2 country code.

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

Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.

smsboolean

Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.

Response

Availability + address constraint.

countrystring
numberTypestring
availableboolean

Whether deliverable voice inventory exists right now.

preOrderableboolean

Nothing deliverable now, but this pair can be pre-ordered: submit KYC as usual and we buy regular stock the moment it returns, otherwise the carrier sources the number (usually 2 to 4 weeks, never guaranteed). Only document tiers (3/4) qualify.

addressConstraint'geo' | 'country' | 'none'
areasstring[]

For geo only: the area(s) the registered address must be in.

Changes

    • warning

      added the new account enum value to the / response property for the response 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

    • info

      added the optional property to the response with the status