Phone & voice · Voice

Hang up a live call

Hangs up a live call.

POSThttps://api.pozy.ai/v1/voice/calls/{id}/end
endVoiceCall

Guides: Voice calls, Browser calling, AI voice agents

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

Path parameters

NameTypeNotes
idrequiredstring

Example

curl -X POST "https://api.pozy.ai/v1/voice/calls/6bfebd43ddc270f6d2c56fc5/end" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • successboolean
  • callIdstring
  • statusstring
200 response
{
  "success": true,
  "callId": "6f502e3f20741dfe2abae39e",
  "status": "active"
}

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.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Voice