WhatsApp · WhatsApp Phone Numbers
Checks country availability.
GET
https://api.pozy.ai/v1/whatsapp/phone-numbers/availabilityDeprecatedcheckWhatsAppNumberAvailability
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 |
|---|---|---|
countryrequired | string | |
numberType | string | One of local, mobile, national, toll_free |
sms | boolean |
Example
curl -X GET "https://api.pozy.ai/v1/whatsapp/phone-numbers/availability?country=US" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/whatsapp/phone-numbers/availability?country=US", {
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/availability",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"country": "US",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
countrystringnumberTypestringavailablebooleanpreOrderablebooleanaddressConstraintstringOne of
geo,country,none.areasarray of stringareaOptionsarray of objectndcstringnamestringcountinteger
soldOutAreasarray of objectndcstringnamestringpreOrderableboolean
areaAvailabilityobjectinStockarray of object5 child fields
ndcstringnamestringcountintegerndcsarray of stringaliasesarray of string
preOrderarray of object4 child fields
ndcstringnamestringndcsarray of stringaliasesarray of string
outOfStockarray of object5 child fields
ndcstringnamestringlistedintegerndcsarray of stringaliasesarray of string
200 response
{
"country": "US",
"numberType": "string",
"available": true,
"preOrderable": true,
"addressConstraint": "geo",
"areas": [
"string"
],
"areaOptions": [
{
"ndc": "string",
"name": "Acme",
"count": 42
}
],
"soldOutAreas": [
{
"ndc": "string",
"name": "Acme",
"preOrderable": true
}
],
"areaAvailability": {
"inStock": [
{
"ndc": "string",
"name": "Acme",
"count": 42,
"ndcs": [
"string"
],
"aliases": [
"string"
]
}
],
"preOrder": [
{
"ndc": "string",
"name": "Acme",
"ndcs": [
"string"
],
"aliases": [
"string"
]
}
],
"outOfStock": [
{
"ndc": "string",
"name": "Acme",
"listed": 1,
"ndcs": [
"string"
],
"aliases": [
"string"
]
}
]
}
}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 countriesGETSearch available numbersGETGet 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