Terminate (hang up) an in-flight outbound call
curl --request POST \
--url https://example.com/api/v1/project/{projectSlug}/{env}/outbound-calls/{outboundCallId}/terminate \
--header 'x-api-key: <api-key>'{
"success": true,
"data": {
"outboundCallId": "oc_01a0a4af5a417f5186af",
"phase": "terminal",
"outcome": "canceled"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}Terminate outbound calls
Hang up an outbound call that has not ended.
POST
/
api
/
v1
/
project
/
{projectSlug}
/
{env}
/
outbound-calls
/
{outboundCallId}
/
terminate
Terminate (hang up) an in-flight outbound call
curl --request POST \
--url https://example.com/api/v1/project/{projectSlug}/{env}/outbound-calls/{outboundCallId}/terminate \
--header 'x-api-key: <api-key>'{
"success": true,
"data": {
"outboundCallId": "oc_01a0a4af5a417f5186af",
"phase": "terminal",
"outcome": "canceled"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}phase=terminal. Drives the call to phase=terminal, outcome=canceled. Don’t use this API on a call that’s already terminal. It returns the call’s existing terminal state, not an error.
The request needs the outbound_calls.initiate scope, the same scope as placing a call. The outbound_calls.read scope is not enough. The response returns the outboundCallId, phase, and outcome. A call ID that does not exist, or that belongs to a different project, returns 404.Authorizations
Path Parameters
Was this page helpful?