Skip to navigation

Reject an incoming call

View as Markdown

Reject an inbound phone session before it is answered. The session must currently be ringing or in early media; otherwise the request returns 409 Conflict.

Use the reason field to select the caller-facing outcome, such as busy, rejected, number not found.

A 202 Accepted response means the rejection request was accepted for processing; it does not mean the session has ended. Wait for the deferred session.ended webhook to confirm termination.

Tip: Use this endpoint only for an unanswered inbound call. After the call is answered, this endpoint returns 409 Conflict; use Delete session to disconnect a Session whether or not its call has been answered.

Triggered webhooks: session.ended (deferred)

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.

Path parameters

uuidstringRequired

Session identifier.

Headers

Idempotency-KeystringOptionalformat: "^[a-zA-Z0-9._-]*$"<=128 characters

Optional key for safely retrying mutating requests. An explicitly empty header is treated like omission and does not enable replay protection. See Idempotency for details.

Operation-IdstringOptionalformat: "uuid"

optional client-supplied lowercase RFC-4122 v4 UUID returned as operation_uuid; platform generates one when omitted; correlation metadata distinct from Idempotency-Key.

Request

This endpoint expects an object.
reasonenumRequired

Public hangup cause for the resulting session.ended event: number_not_found, invalid_number, timeout, busy, or rejected.

Allowed values:

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.

Response

Command accepted for async execution
operation_uuidstring
statusenum
Allowed values:
already_endedtrueOptional

Optional. Set to true on idempotent terminal commands when the session was already in a terminal state at the time the request was received. Absent otherwise.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
413
Content Too Large Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
500
Internal Server Error
503
Service Unavailable Error