Sign in

v53

OpenAPI 3.1.0raw.githubusercontent.com2026-08-041,1941,9384.1 MB
Call Commands

Reject a call

Reject an incoming call.

Expected Webhooks:

  • call.hangup
post/calls/{call_control_id}/actions/reject

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

cause'CALL_REJECTED' | 'USER_BUSY' required

Cause for call rejection.

client_statestring

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

command_idstring

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

Example request

{
  "cause": "USER_BUSY",
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901"
}

Response

Successful response upon making a call control command.

Example response

{
  "data": {
    "result": "ok"
  }
}