Phone & voice · Voice
Mints a browser softphone session.
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
Example
curl -X POST "https://api.pozy.ai/v1/voice/calls/web" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/voice/calls/web", {
method: "POST",
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.post(
"https://api.pozy.ai/v1/voice/calls/web",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleantokenstringcredentialIdstringexpiresAtstring (date-time)sdkstring
200 response
{
"success": true,
"token": "string",
"credentialId": "6cb91090be451e58cee32670",
"expiresAt": "2026-10-02T09:00:00.000Z",
"sdk": "string"
}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 costPOSTDial from the browser softphonePOSTEnable 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