Call Commands

Reject a call

Changed on

Reject an incoming call.

Expected Webhooks:

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

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/calls/{call_control_id}/actions/reject
  • Auth: HTTP bearer

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

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.

cause'CALL_REJECTED' | 'NOT_FOUND' | 'TEMPORARILY_UNAVAILABLE' | 'USER_BUSY' required

Cause for call rejection. The cause sets the SIP response the caller receives: USER_BUSY sends 486 User Busy, CALL_REJECTED sends 603 Decline, NOT_FOUND sends 404 Not Found, and TEMPORARILY_UNAVAILABLE sends 480 Temporarily Unavailable.

Example request

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

Response

Successful response upon making a call control command.

Example response

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

Changes

  • 227c33b1ac9cRevision changes
    • info

      added the new NOT_FOUND enum value to the request property

    • info

      added the new TEMPORARILY_UNAVAILABLE enum value to the request property

  • 1571b0380bd7Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to integer for status