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.

Body

application/json

Create 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"

active
boolean
default:true

Specifies whether the connection can be used.

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

Available options:
Latency,
Chicago, IL,
Ashburn, VA,
San Jose, CA,
London, UK,
Chennai, IN,
Amsterdam, Netherlands,
Toronto, Canada,
Sydney, Australia
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

inbound
Call Control Application Inbound · object
outbound
Call Control Application 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

call_cost_in_webhooks
boolean
default:false

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

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
Call Control Application · object
Example: