WhatsApp · WhatsApp Phone Numbers
Fetches number status.
GET
https://api.pozy.ai/v1/whatsapp/number-infogetWhatsAppNumberInfo
Guides: Phone numbers for WhatsApp, Connect WhatsApp, Group chats
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the contacts resource group disabled get 403 resource_group_disabled. Authentication
Query parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string |
Example
curl -X GET "https://api.pozy.ai/v1/whatsapp/number-info?accountId=696e0b682d0a31188e7a2ba9" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/whatsapp/number-info?accountId=696e0b682d0a31188e7a2ba9", {
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/number-info",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"accountId": "696e0b682d0a31188e7a2ba9",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
phoneobject10 child fields
display_phone_numberstringverified_namestringname_statusstringquality_ratingstringmessaging_limit_tierstringthroughputobject1 child field
levelstring
statusstringis_official_business_accountbooleanplatform_typestringhealth_statusobject
wabaobjectCan be null.
namestringbusiness_verification_statusstringtimezone_idstringhealth_statusobject
200 response
{
"phone": {
"display_phone_number": "+14155550123",
"verified_name": "Acme",
"name_status": "Acme",
"quality_rating": "string",
"messaging_limit_tier": "string",
"throughput": {
"level": "string"
},
"status": "active",
"is_official_business_account": true,
"platform_type": "instagram",
"health_status": {}
},
"waba": {
"name": "Acme",
"business_verification_status": "active",
"timezone_id": "64522c650887b67424b724a9",
"health_status": {}
}
}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 pricing analyticsGETList phone numbersPOSTPurchase phone numberGETList offerable number countriesGETSearch available numbersGETCheck 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