Cancel a queued call (path-param form)

View as Markdown
REST-conventional path-param variant of [`POST /conversation/cancel`](#operation/cancelCallByBody). **Behavior differs from the body form.** This path-param endpoint only cancels calls that are still in the `IN_QUEUE` state — calls that have already started dialing or are in progress return `400 Bad Request` with `errors: ["Conversation with ID ... is not in queue and cannot be cancelled"]`. Use the body form (`POST /conversation/cancel`) if you need to cancel an in-progress call. The path param is the `callId` string (e.g. `CALL-1778226705739-7e4c17`), **not** the Mongo `_id`. Passing `_id` returns `404 No conversation found`.

Authentication

AuthorizationBearer

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

Path parameters

callIdstringRequired

The callId string for the conversation to cancel.

Response

Call cancelled.
statusboolean
dataobject

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error