Update a call control application
PATCH/call_control_applications/:id
Updates settings of an existing call control application.
Request
Path Parameters
Identifies the resource.
- application/json
Body
required
Update call control application request.
A user-assigned name to help manage the application.
The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
Default value: true
Specifies whether the connection can be used.
Possible values: ["Latency", "Chicago, IL", "Ashburn, VA", "San Jose, CA"]
Default value: "Latency"
Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.
Possible values: [RFC 2833, Inband, SIP INFO]
Default value: RFC 2833
Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.
Specifies whether calls to phone numbers associated with this connection should hangup after timing out.
Default value: 30
Specifies how many seconds to wait before timing out a dial command.
inbound
object
When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls.
Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.
Possible values: [only_my_connections, from_anyone]
Default value: from_anyone
This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).
outbound
object
When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
Identifies the associated outbound voice profile.
Possible values: [1, 2]
Default value: 1
Determines which webhook format will be used, Telnyx API v1 or v2.
The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
Possible values: <= 30
Specifies how many seconds to wait before timing out a webhook.
Responses
200: Successful response with details about a call control application.
- application/json
401: Unauthorized
404: Resource not found
422: Bad request
Request samples
curl -L -X PATCH 'https://api.telnyx.com/v2/call_control_applications/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"application_name": "call-router",
"webhook_event_url": "https://example.com",
"active": false,
"anchorsite_override": "\"Latency\"",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"inbound": {
"channel_limit": 10,
"shaken_stir_enabled": true,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_timeout_secs": 25
}'
Response samples
{
"data": {
"active": false,
"anchorsite_override": "\"Latency\"",
"application_name": "call-router",
"created_at": "2018-02-02T22:25:27.521Z",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"shaken_stir_enabled": true,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "call_control_application",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}