Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

call_control_id
string
required

Unique identifier and token for controlling the call

Body

application/json

Reject request

cause
enum<string>
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.

Available options:
CALL_REJECTED,
NOT_FOUND,
TEMPORARILY_UNAVAILABLE,
USER_BUSY
Example:

"USER_BUSY"

client_state
string

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

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

command_id
string

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

Example:

"891510ac-f3e4-11e8-af5b-de00688a4901"

Response

Successful response upon making a call control command.

data
Call Control Command Result · object
Example: