Phone & voice · Voice

Place an outbound phone call

Places an outbound phone call.

POSThttps://api.pozy.ai/v1/voice/calls
createVoiceCall

Guides: Voice calls, AI voice agents, Idempotency and safe retries

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

NameTypeNotes
Idempotency-KeystringUp to 255 charactersRetries with the same key return the original result. See Idempotency

Request body

application/json, required

  • tostringrequired

    Matches ^\+\d{6,15}$.

  • fromNumberstring

    Matches ^\+\d{6,15}$.

  • forwardTostring
  • greetingstring

    Up to 1000 characters.

  • recordOverrideboolean
  • transcribeOverrideboolean
  • transcriptionLanguagestring

    One of auto, en, es.

  • amdboolean
  • voicemailDropMessagestring

    Up to 1000 characters.

  • ringTimeoutSecondsinteger

    Default 30. 5 to 120.

Example

curl -X POST "https://api.pozy.ai/v1/voice/calls" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "+14155550123"
}'

Response

200 on success

  • successboolean
  • callIdstring
  • carrierCallControlIdstring
  • statusstring

    One of dialing.

  • directionstring

    One of outbound.

  • fromstring
  • tostring
  • forwardTostring
  • greetingstring

    Can be null.

  • recordingEnabledboolean
  • transcriptionEnabledboolean
  • transcriptionLanguagestring

    One of auto, en, es.

200 response
{
  "success": true,
  "callId": "6f502e3f20741dfe2abae39e",
  "carrierCallControlId": "6c367f42f99a6851724a1342",
  "status": "dialing",
  "direction": "outbound",
  "from": "+14155550123",
  "to": "+14155550123",
  "forwardTo": "string",
  "greeting": "string",
  "recordingEnabled": true,
  "transcriptionEnabled": true,
  "transcriptionLanguage": "auto"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Voice