WhatsApp Phone Numbers
Search available numbers
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
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
City
containsstring
Pattern to match within the number
limitinteger
Response
Available numbers.