WhatsApp · WhatsApp Calling
Returns call history for an account, one page at a time.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication
Query parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string | |
status | string | One of ringing, answered, ended, failed |
direction | string | One of inbound, outbound |
since | string (date-time) | |
until | string (date-time) | |
before | string (date-time) | |
limit | integer | 1 to 200 |
Example
curl -X GET "https://api.pozy.ai/v1/whatsapp/calls?accountId=696e0b682d0a31188e7a2ba9&limit=1" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/whatsapp/calls?accountId=696e0b682d0a31188e7a2ba9&limit=1", {
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/calls",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"accountId": "696e0b682d0a31188e7a2ba9",
"limit": 1,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
callsarray of object11 child fields
_idstringdirectionstringOne of
inbound,outbound.fromstringtostringstatusstringOne of
ringing,answered,ended,failed.startedAtstring (date-time)endedAtstring (date-time)durationSecondsintegerendReasonstringOne of
hangup,no_answer,rejected,error.recordingUrlstringbillingobject6 child fields
metaCostUSDnumbercarrierCostUSDnumberrecordingCostUSDnumberbillableCostUSDnumbertotalCostUSDnumbercurrencystring
nextCursorstring (date-time)Can be null.
200 response
{
"calls": [
{
"_id": "635d87e261ae344ef27fd1df",
"direction": "inbound",
"from": "+14155550123",
"to": "+14155550123",
"status": "ringing",
"startedAt": "2026-10-02T09:00:00.000Z",
"endedAt": "2026-10-02T09:00:00.000Z",
"durationSeconds": 1,
"endReason": "hangup",
"recordingUrl": "https://pozy.ai/media/example-1.jpg",
"billing": {
"metaCostUSD": 12.5,
"carrierCostUSD": 12.5,
"recordingCostUSD": 12.5,
"billableCostUSD": 12.5,
"totalCostUSD": 12.5,
"currency": "USD"
}
}
],
"nextCursor": "2026-10-02T09:00:00.000Z"
}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
GETGet calling config for an accountPOSTEnable calling on a numberPATCHUpdate calling configDELDisable calling on a numberGETCheck call permissionPOSTInitiate 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