Skip to main content
PATCH
/
call_control_applications
/
{id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const callControlApplication = await client.callControlApplications.update('id', {
  application_name: 'call-router',
  webhook_event_url: 'https://example.com',
});

console.log(callControlApplication.data);
{
  "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,
    "call_cost_in_webhooks": false,
    "redact_dtmf_debug_logging": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<int64>
required

Identifies the resource.

Example:

"1293384261075731499"

Body

application/json

Update call control application request.

​
application_name
string
required

A user-assigned name to help manage the application.

Example:

"call-router"

​
webhook_event_url
string<url>
required

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

Example:

"https://example.com"

​
call_cost_in_webhooks
boolean
default:false

Specifies if call cost webhooks should be sent for this Call Control Application.

​
active
boolean
default:true

Specifies whether the connection can be used.

​
anchorsite_override
enum<string>
default:"Latency"

<code>Latency</code> 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.

Available options:
"Latency",
"Chicago, IL",
"Ashburn, VA",
"San Jose, CA"
Example:

"\"Amsterdam, Netherlands\""

​
dtmf_type
enum<string>
default: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.

Available options:
RFC 2833,
Inband,
SIP INFO
Example:

"Inband"

​
first_command_timeout
boolean
default:false

Specifies whether calls to phone numbers associated with this connection should hangup after timing out.

Example:

true

​
first_command_timeout_secs
integer
default:30

Specifies how many seconds to wait before timing out a dial command.

Example:

10

​
tags
string[]

Tags assigned to the Call Control Application.

Example:
["tag1", "tag2"]
​
inbound
object
​
outbound
object
​
webhook_api_version
enum<string>
default:1

Determines which webhook format will be used, Telnyx API v1 or v2.

Available options:
1,
2
Example:

"1"

​
webhook_event_failover_url
string<url> | null
default:""

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'.

Example:

"https://failover.example.com"

​
webhook_timeout_secs
integer | null

Specifies how many seconds to wait before timing out a webhook.

Required range: 0 <= x <= 30
Example:

25

​
redact_dtmf_debug_logging
boolean
default:false

When enabled, DTMF digits entered by users will be redacted in debug logs to protect PII data entered through IVR interactions.

Example:

true

Response

Successful response with details about a call control application.

​
data
object
Example:
{
  "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,
  "call_cost_in_webhooks": false,
  "redact_dtmf_debug_logging": true
}