Call Control
End a call
Immediately ends a call, disconnecting all participants and releasing system resources. This endpoint is used to programmatically hang up active, ringing, held, or conference calls. For example, to enforce policies, automate workflows, or handle emergency scenarios.
Behavior
Upon invocation, the call is forcefully disconnected. The system stops any ongoing recordings or monitoring, finalizes
billing (if applicable), and marks the call as ended
or terminated
. Resources tied to the call are released.
Requirements and Errors
Requires a valid call_id and appropriate permissions for the target provider and application.
Errors may occur if:
- The call doesn't exist or is already terminated
- The caller lacks permission to manage the call
- The system is unable to reach the provider to complete the termination
After Termination
The system finalizes call logs, completes billing calculations (if enabled), and may emit call-ended events based on your application's configuration.
curl --request PUT \
--url http://api.voistrix.com/v1/accounts/:accountID/applications/:applicationID/providers/:providerID/calls/:callID/end \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Path Parameters
- :accountID - REQUIRED[String]
The referenced account ID.
- :applicationID - REQUIRED[String]
The referenced application ID.
- :providerID - REQUIRED[String]
The referenced provider ID.
- :callID - REQUIRED[String]
The referenced call ID.
Response
Indicates the request was successful. Returns a status code of204
with no content returned in the response body.Errors
A common set of Error Responses can be found here.