Hangup Call

Terminate an active or ringing call immediately.

Endpoint

DELETE https://api.tryvox.io/v1/voice/accounts/{auth_id}/calls/{call_uuid}

Path Parameters

• auth_id - Your account authentication ID
• call_uuid - The unique identifier of the call to terminate

Example Request

curl -X DELETE https://api.tryvox.io/v1/voice/accounts/your_auth_id/calls/650e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer tvx_sk_live_..."

Response

A successful hangup request returns a 204 No Content response with no body.

HTTP/1.1 204 No Content

Behavior

When you hangup a call:

1. The call is immediately terminated for all parties
2. Any in-progress actions (recording, playing audio, etc.) are stopped
3. Your hangup_url webhook is called with final call details
4. The call status is updated to completed with end reason api-hangup

Use Cases

End a Call Programmatically

Terminate a call based on business logic, such as:

• Maximum duration reached
• Fraud detection triggered
• User requested cancellation
• Emergency shutdown

Cancel a Ringing Call

Cancel an outbound call before it's answered:

curl -X DELETE https://api.tryvox.io/v1/voice/accounts/your_auth_id/calls/650e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer tvx_sk_live_..."

End Conference Participant

Remove a specific participant from a conference by hanging up their call.

Error Responses

Call Not Found

{
  "error": "call_not_found",
  "message": "Call with UUID 650e8400-e29b-41d4-a716-446655440000 not found"
}

Call Already Ended

{
  "error": "call_already_ended",
  "message": "Call has already ended"
}

Notes

• You can only hangup calls that are in ringing or in-progress status
• Hanging up a call that has already ended returns a 404 error
• The hangup_url webhook will receive end_reason: "api-hangup"
• There is no way to undo a hangup operation
• Hangup is immediate and may interrupt ongoing audio playback or recording