Conversations

Cancel an in-flight call

View as Markdown
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).

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Request

This endpoint expects an object.
callIdstringRequired

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

reasonstringOptional

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

Response

Call cancelled.
statusboolean
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error