WhatsApp · WhatsApp Calling
Fetches calling config for an account.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the accounts 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/calling?accountId=696e0b682d0a31188e7a2ba9" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/whatsapp/calling?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/calling",
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
phoneNumberDocIdstringphoneNumberstringcallingEnabledbooleancallDeepLinkstringCan be null.
forwardTostringCan be null.
recordingEnabledbooleansipAuthUsernamestringCan be null.
sipAuthPasswordConfiguredbooleancallIconCountriesarray of stringCan be null.
callerIdModestringOne of
business,platform.callerIdVerifiedbooleanmaxCallDurationSecondsintegerCan be null.
forwardCallerIdstringOne of
business,caller.
200 response
{
"phoneNumberDocId": "6b05d8648c0c920a11842dae",
"phoneNumber": "+14155550123",
"callingEnabled": true,
"callDeepLink": "string",
"forwardTo": "string",
"recordingEnabled": true,
"sipAuthUsername": "acme",
"sipAuthPasswordConfigured": true,
"callIconCountries": [
"string"
],
"callerIdMode": "business",
"callerIdVerified": true,
"maxCallDurationSeconds": 1,
"forwardCallerId": "business"
}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 Calling
POSTEnable calling on a numberPATCHUpdate calling configDELDisable calling on a numberGETCheck call permissionGETList call history for an accountPOSTInitiate outbound callGETGet a single callGETGet a call recordingGETEstimate per-minute costGETGet calling config for a numberPOSTEnable calling on a numberPATCHUpdate calling configDELDisable calling on a numberPOSTStart caller-ID verification for a customer-brought numberPOSTConfirm the caller-ID verification code