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
Terminate or hang up an in-flight outbound call.
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>"
}
}Hangs up a call that has not yet reached
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.Authorizations
Project-bound Platform API key (abl_...). The key must carry outbound_calls.initiate
for write operations (initiate, terminate) or outbound_calls.read for read operations
(lookup, list, summary, search, event stream).
Path Parameters
The project's slug.
Minimum string length:
1Deployment environment segment the call runs under, e.g. production, staging, dev.
Minimum string length:
1Identifier returned when the call was initiated.
Minimum string length:
1Was this page helpful?