Sign in
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

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

Changed in 3 of the 99 revisions of this API.72

  • 227c33b1ac9c2See the full diff
    • ○

      added the new NOT_FOUND enum value to the request property

      request-property-enum-value-added

    • ○

      added the new TEMPORARILY_UNAVAILABLE enum value to the request property

      request-property-enum-value-added

  • 1571b0380bd73See the full diff
    • ▲

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

      response-body-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379944See the full diff
    • ▲

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

      response-body-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 99 revisions, 1 has no diff computed.