Skip to main content

Reject call

POST 
/calls/:call_control_id/actions/reject

Reject an incoming call

Expected Webhooks:

  • Call hangup

Request ​

Path Parameters

    call_control_id stringrequired

    Unique identifier and token for controlling the call

Body

required

    client_state string

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

    command_id string

    Use this field to avoid duplicate commands. Telnyx will ignore commands with the same "command_id".

    cause string

    Possible values: [CALL_REJECTED, USER_BUSY]

    Cause for call rejection.

Responses ​

200: Successful response

Schema

    result stringrequired

Request samples

curl -L 'https://api.telnyx.com/calls/:call_control_id/actions/reject' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "cause": "USER_BUSY"
}'

Response samples

{
  "result": "ok"
}