WhatsApp · WhatsApp Phone Numbers
Searches available numbers.
GET
https://api.pozy.ai/v1/whatsapp/phone-numbers/availableDeprecatedsearchAvailableWhatsAppNumbers
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
Query parameters
| Name | Type | Notes |
|---|---|---|
country | string | Default US |
numberType | string | One of local, mobile, national, toll_free |
areaCode | string | |
type | string | |
prefix | string | |
locality | string | |
contains | string | |
limit | integer | Default 20At most 100 |
Example
curl -X GET "https://api.pozy.ai/v1/whatsapp/phone-numbers/available?limit=20" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/whatsapp/phone-numbers/available?limit=20", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/whatsapp/phone-numbers/available",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"limit": 20,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
countrystringnumberTypestringnumbersarray of objectphoneNumberstringlocalitystringbestEffortboolean
200 response
{
"country": "US",
"numberType": "string",
"numbers": [
{
"phoneNumber": "+14155550123",
"locality": "string",
"bestEffort": true
}
]
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in WhatsApp Phone Numbers
GETGet number statusGETGet pricing analyticsGETList phone numbersPOSTPurchase phone numberGETList offerable number countriesGETCheck country availabilityGETGet KYC form specPOSTSubmit KYCPOSTUpload a KYC documentPOSTPre-validate KYC addressPOSTCreate a hosted KYC linkPATCHMove a number to another profileGETGet declined requirementsPOSTResubmit a declined numberGETGet phone numberDELRelease phone number