Phone & voice · Voice
Dials from the browser softphone.
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
Request body
application/json, required
tostringrequiredMatches
^\+\d{6,15}$.credentialIdstringrequiredfromNumberstringMatches
^\+\d{6,15}$.recordOverridebooleanringTimeoutSecondsintegerDefault
30. 5 to 120.
Example
curl -X POST "https://api.pozy.ai/v1/voice/calls/web/dial" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+14155550123",
"credentialId": "6cb91090be451e58cee32670"
}'const res = await fetch("https://api.pozy.ai/v1/voice/calls/web/dial", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
to: "+14155550123",
credentialId: "6cb91090be451e58cee32670"
}),
});
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/voice/calls/web/dial",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"to": "+14155550123",
"credentialId": "6cb91090be451e58cee32670",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleancallIdstringcarrierCallControlIdstringstatusstringOne of
dialing.directionstringOne of
outbound.fromstringtostringrecordingEnabledboolean
200 response
{
"success": true,
"callId": "6f502e3f20741dfe2abae39e",
"carrierCallControlId": "6c367f42f99a6851724a1342",
"status": "dialing",
"direction": "outbound",
"from": "+14155550123",
"to": "+14155550123",
"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 Voice
GETList phone callsPOSTPlace an outbound phone callGETGet a phone callPOSTHang up a live callGETGet a call recordingPOSTBlind-transfer a live callGETEstimate call costPOSTMint a browser softphone sessionPOSTEnable phone calling on a numberDELDisable phone calling on a numberGETList SIP trunksPOSTCreate a SIP trunkGETGet a SIP trunkDELDelete a SIP trunkPOSTRotate a SIP trunk's passwordPOSTAttach a number to a SIP trunkDELDetach a number from its SIP trunk