Hang Up a Call

Terminate an active call by hanging up one or both call legs.

This endpoint allows you to programmatically terminate an in-progress call. You can hang up the caller (A leg), the callee (B leg), or both legs simultaneously. The call will be terminated immediately and final CDR will be generated.

Authentication Required:

• X-Auth-ID: Your account ID (e.g., {Auth_ID})
• X-Auth-Token: Your account Auth Token
• Content-Type: application/json

Warning: This permanently terminates the call. This action cannot be undone.

Important: Hanging up a call will trigger the hangup_url callback if configured when the call was initiated. This allows you to perform cleanup operations or logging.

HTTP Request

DELETEDELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/

Path Parameters

auth_idstringRequired

Your Vobiz account ID (e.g., {Auth_ID})

call_uuidstringRequired

Unique 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 success message confirming the call hangup request has been 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 Example

Request

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

Tip: 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.

Transfer a Call

Retrieve All Calls