Skip to navigation

Abort a call

View as Markdown

Stops a call at any stage: queued, ringing, or live. Works for every conversation type (outbound, inbound, web calls and chat).

The response depends on where the call is:

  • Still queued - the call is removed from the queue and never dials. Returns 200 with status: "aborted".
  • Dialing or live - the abort is sent to the running call, which ends within 5 seconds. Returns 202 with status: "aborting". The call’s final status becomes aborted once it has ended; read it from GET /conversation/{id} or the post-conversation webhook.

An aborted call is billed like any other call: only for the time after it was answered, rounded up to your billing pulse. A call aborted while queued or ringing costs nothing. Post-call analytics still run for a call that was answered. Aborted campaign calls are not re-dialed when the campaign resumes.

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>=1 character

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

reasonstringOptional<=500 characters

Optional free-text reason. Stored on the call log for support and audit.

Response

The call was still queued and is now aborted. It never dials.
statusbooleanOptional
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error