Skip to navigation
Voice Agents APIConversations

Cancel a queued call (deprecated)

Deprecated
View as Markdown

Deprecated. Use POST /conversation/abort, which stops a call whether it is queued, ringing or live. This endpoint keeps working for existing integrations.

Cancels an outbound call that is still queued (pending or in_queue), looked up by callId. To stop a call that is dialing or live, use POST /conversation/abort.

Returns 404 if no call with that ID exists in your organization. Returns 400 if the call is dialing, live, or already ended.

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.
statusbooleanOptional
dataobjectOptional

Errors

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