WhatsApp · WhatsApp Calling
Initiates an outbound call.
POST
https://api.pozy.ai/v1/whatsapp/callsinitiateWhatsAppCall
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication
Headers
| Name | Type | Notes |
|---|---|---|
Idempotency-Key | string | Up to 255 charactersRetries with the same key return the original result. See Idempotency |
Request body
application/json, required
accountIdstringrequiredtostringrequiredactionstringOne of
send_call_permission_request.bodyTextstringUp to 1024 characters.
forwardTostringrecordOverridebooleanbiz_opaque_callback_datastringUp to 512 characters.
Example
curl -X POST "https://api.pozy.ai/v1/whatsapp/calls" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"accountId": "696e0b682d0a31188e7a2ba9",
"to": "+14155550123"
}'import { randomUUID } from "node:crypto";
const res = await fetch("https://api.pozy.ai/v1/whatsapp/calls", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Idempotency-Key": randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
accountId: "696e0b682d0a31188e7a2ba9",
to: "+14155550123"
}),
});
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.post(
"https://api.pozy.ai/v1/whatsapp/calls",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"accountId": "696e0b682d0a31188e7a2ba9",
"to": "+14155550123",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleancallIdstringcarrierCallControlIdstringstatusstringOne of
dialing.directionstringOne of
outbound.tostringforwardTostringCan be null.
recordingEnabledboolean
200 response
{
"success": true,
"callId": "6f502e3f20741dfe2abae39e",
"carrierCallControlId": "6c367f42f99a6851724a1342",
"status": "dialing",
"direction": "outbound",
"to": "+14155550123",
"forwardTo": "string",
"recordingEnabled": true
}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 read-only, 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 permissionGETList call history for an accountGETGet 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