Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/
Terminate an active call by hanging up one or both call legs. You can hang up the caller (A leg), the callee (B leg), or both legs simultaneously. The call is terminated immediately and a final CDR is generated.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
This permanently terminates the call. This action cannot be undone.
Hanging up a call triggers the hangup_url callback if one was configured when the call was initiated, allowing you to perform cleanup or logging.

​
Path parameters

FieldTypeRequiredDescription
auth_idstringYesYour Vobiz account ID (e.g., {auth_id}).
call_uuidstringYesUnique identifier of the call to hang up.

​
Request Parameters

No Request Body Required: This endpoint does not require any request body parameters. Simply send a DELETE request to the endpoint URL.

​
Response

Returns a confirmation that the hangup request was processed.
Response - 204 No Content
No Content
After Hangup: The call’s final CDR will show hangup_source as “API” and the hangup_cause_code will indicate a programmatic termination (typically code 16: NORMAL_CLEARING).

​
Example Request

cURL
curl -X DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

​
Use Cases

  • Terminate abandoned or idle calls to prevent billing
  • Implement time-based call limits for compliance
  • End calls based on external triggers (e.g., fraud detection)
  • Implement emergency call termination features
  • Clean up stale call sessions during maintenance
To retrieve the final call details after hanging up, use the Retrieve a Call endpoint with the call UUID. The CDR will include final duration and billing information.