v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0114775543.6 KB
Conversations

Cancel an in-flight call

Cancels an outbound call that has been queued or is in progress. Use the body form to look the call up by callId; the path-param form (POST /conversation/{callId}/cancel) is the equivalent for REST conventions, but only handles IN_QUEUE calls.

Returns 404 if no call with that ID exists in your organization. Returns 400 if the call is already in a terminal state (completed / failed / cancelled).

post/conversation/cancel

Request body

callIdstring required

The callId returned by POST /conversation/outbound or visible in GET /conversation.

reasonstring

Optional free-text reason for cancellation. Logged for support / audit.

Example request

{
  "callId": "CALL-1778226705739-7e4c17"
}

Response

Call cancelled.

statusboolean

Example response

{
  "status": true,
  "data": {
    "status": "cancelled"
  }
}