Phone & voice · Calls
Returns all calls (unified history), 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 |
|---|---|---|
channel | string | One of whatsapp, pstn |
status | string | One of ringing, answered, ended, failed |
direction | string | One of inbound, outbound |
number | string | |
search | string | |
before | string (date-time) | |
limit | integer | Default 501 to 200 |
Example
curl -X GET "https://api.pozy.ai/v1/calls?limit=50" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/calls?limit=50", {
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/calls",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"limit": 50,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
callsarray of object34 child fields
_idstringaccountIdstringconversationIdstringCan be null.
contactIdstringCan be null.
channelstringOne of
whatsapp,pstn.directionstringOne of
inbound,outbound.fromstringtostringforwardTostringCan be null.
greetingstringCan be null.
statusstringOne of
ringing,answered,ended,failed.isVoicemailbooleanamdbooleanansweredMachinebooleanCan be null.
forwardCallerIdstringOne of
business,caller.recordingEnabledbooleantranscriptionEnabledbooleantranscriptionLanguagestringOne of
auto,en,es.startedAtstring (date-time)answeredAtstring (date-time)Can be null.
endedAtstring (date-time)Can be null.
transferredAtstring (date-time)Can be null.
durationSecondsintegerendReasonstringOne of
hangup,no_answer,rejected,error.hangupCausestringCan be null.
sipHangupCausestringCan be null.
callErrorsarray of object2 child fields
codeintegermessagestring
recordingUrlstringCan be null.
lastTranscriptSnippetstringCan be null.
transcriptarray of object3 child fields
textstringconfidencenumberatstring (date-time)
billingobject10 child fields
metaMinutesnumbercarrierSecondsnumbertranscriptionSecondsnumbertranscriptionCostUSDnumbermetaCostUSDnumbercarrierCostUSDnumberrecordingCostUSDnumberbillableCostUSDnumbertotalCostUSDnumbercurrencystring
createdAtstring (date-time)updatedAtstring (date-time)contactNamestring
nextCursorstring (date-time)Can be null.
200 response
{
"calls": [
{
"_id": "635d87e261ae344ef27fd1df",
"accountId": "696e0b682d0a31188e7a2ba9",
"conversationId": "6e525f3820fc636aa96d2ee9",
"contactId": "642d31f43531ce7d44aa5013",
"channel": "whatsapp",
"direction": "inbound",
"from": "+14155550123",
"to": "+14155550123",
"forwardTo": "string",
"greeting": "string",
"status": "ringing",
"isVoicemail": true,
"amd": true,
"answeredMachine": true,
"forwardCallerId": "business",
"recordingEnabled": true,
"transcriptionEnabled": true,
"transcriptionLanguage": "auto",
"startedAt": "2026-10-02T09:00:00.000Z",
"answeredAt": "2026-10-02T09:00:00.000Z",
"endedAt": "2026-10-02T09:00:00.000Z",
"transferredAt": "2026-10-02T09:00:00.000Z",
"durationSeconds": 1,
"endReason": "hangup",
"hangupCause": "string",
"sipHangupCause": "string",
"callErrors": [
{
"code": 1,
"message": "Hello from Pozy"
}
],
"recordingUrl": "https://pozy.ai/media/example-1.jpg",
"lastTranscriptSnippet": "string",
"transcript": [
{
"text": "Hello from Pozy",
"confidence": 12.5,
"at": "2026-10-02T09:00:00.000Z"
}
],
"billing": {
"metaMinutes": 12.5,
"carrierSeconds": 12.5,
"transcriptionSeconds": 12.5,
"transcriptionCostUSD": 12.5,
"metaCostUSD": 12.5,
"carrierCostUSD": 12.5,
"recordingCostUSD": 12.5,
"billableCostUSD": 12.5,
"totalCostUSD": 12.5,
"currency": "USD"
},
"createdAt": "2026-10-02T09:00:00.000Z",
"updatedAt": "2026-10-02T09:00:00.000Z",
"contactName": "Acme"
}
],
"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.