Call Management
Hang Up a Call
Terminate an active Vobiz call by UUID - hang up the A-leg, B-leg, or full bridged session instantly with a DELETE request that triggers CDR generation.
DELETE
/
api
/
v1
/
Account
/
{auth_id}
/
Call
/
{call_uuid}
/
Hang Up a Call
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/ \
--header 'X-Auth-ID: <x-auth-id>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/"
headers = {
"X-Auth-ID": "<x-auth-id>",
"X-Auth-Token": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/
Authentication required:
X-Auth-ID- Your account Auth IDX-Auth-Token- Your account Auth TokenContent-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.string
required
Your Vobiz account ID, for example
MA_XXXXXXXX.Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
auth_id | string | Yes | Your Vobiz account ID (e.g., {auth_id}). |
call_uuid | string | Yes | Unique identifier of the call to hang up. |
string
required
Your Vobiz account ID. Use the same value in
X-Auth-ID.string
required
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 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.
Was this page helpful?
⌘I
Hang Up a Call
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/ \
--header 'X-Auth-ID: <x-auth-id>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/"
headers = {
"X-Auth-ID": "<x-auth-id>",
"X-Auth-Token": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));