A Call Control command is sent with a
call_control_id allows a user to communicate to Telnyx the
call_leg the user wants to control. It also helps Telnyx route the call to the location where the call is being managed, resulting in the lowest possible latency for Call Control interactions.
Authenticating your Call Control Command Request
Like all other Telnyx API V2 requests, you must authenticate your Call Control command requests by sending the Authorization header with a value of an API Key. You can read more about API Keys here.
|Credential Type||HTTP Header Format|
|API Key||Authorization: Bearer YOUR_API_KEY|
Example: Sending Commands With a Key + Secret
To answer the call, send a POST request to the
/actions/answer endpoint as shown in the example below.
curl -X POST \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ https://api.telnyx.com/v2/calls/428c31b6-7af4-4bcb-b7f5-5013ef9657c1/actions/answer
Available Commands and their Expected Webhooks
Telnyx offers a broad range of commands to enable granular control of your call flows. Below are a list of those commands, and the webhooks the Telnyx Call Control platform will always send in response. When multiple webhooks are listed, you can expect to often, though not always, receive webhooks in the order provided.
|Gather using audio||
|Gather using speak||
|Play audio url||
|Playback stop command||
|Recording start||no webhooks|
|Send DTMF||no webhooks|
Response when Sending Call Control Commands
When you send a Call Control Command, you will immediately receive an http response. Responses include, but are not limited to:
|HTTP Status Code||Message||Description|
|200||OK||The request succeeded.|
|403||Forbidden||The request was valid, however the user is not authorized to perform this action.|
|404||Not Found||The requested resource could not be found.|
|422||Invalid Parameters||The request has invalid parameters or the call is no longer active.|