Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const callControlApplications = await client.callControlApplications.list(); console.log(callControlApplications.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 } ], "meta": { "page_number": 2, "page_size": 25, "total_pages": 3, "total_results": 55 } }

Authorizations

Authorization

string

header

required

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

Query Parameters

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound.outbound_voice_profile_id], filter[leg_id], filter[application_session_id], filter[connection_id], filter[product], filter[failed], filter[from], filter[to], filter[name], filter[type], filter[occurred_at][eq/gt/gte/lt/lte], filter[status]

Show child attributes

filter[application_name]

object

Application name filters

Show child attributes

filter[application_name][contains]

string

default:null

If present, applications with <code>application_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

filter[outbound.outbound_voice_profile_id]

string<int64>

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

filter[leg_id]

string<uuid>

The unique identifier of an individual call leg.

filter[application_session_id]

string<uuid>

The unique identifier of the call session. A session may include multiple call leg events.

filter[connection_id]

string

The unique identifier of the conection.

filter[product]

enum<string>

Filter by product.

Available options:

call_control,

fax,

texml

Example:

"texml"

filter[failed]

boolean

Delivery failed or not.

Example:

false

filter[from]

string

Filter by From number.

Example:

"+12025550142"

filter[to]

string

Filter by To number.

Example:

"+12025550142"

filter[name]

string

If present, conferences will be filtered to those with a matching name attribute. Matching is case-sensitive

filter[type]

enum<string>

Event type

Available options:

command,

webhook

Example:

"webhook"

filter[occurred_at]

object

Event occurred_at filters

Show child attributes

filter[occurred_at][eq]

string

Event occurred_at: equal

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][gt]

string

Event occurred_at: greater than

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][gte]

string

Event occurred_at: greater than or equal

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][lt]

string

Event occurred_at: lower than

Example:

"2019-03-29T11:10:00Z"

filter[occurred_at][lte]

string

Event occurred_at: lower than or equal

Example:

"2019-03-29T11:10:00Z"

filter[status]

enum<string>

If present, conferences will be filtered by status.

Available options:

init,

in_progress,

completed

page

object

Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]

Show child attributes

page[after]

string

default:null

Opaque identifier of next page

page[before]

string

default:null

Opaque identifier of previous page

page[limit]

integer

default:20

Limit of records per single page

Required range: 1 <= x <= 250

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load

Required range: x >= 1

sort

enum<string>

default:created_at

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul>

<li> <code>connection_name</code>: sorts the result by the <code>connection_name</code> field in ascending order. </li> <li> <code>-connection_name</code>: sorts the result by the <code>connection_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.

Available options:

created_at,

connection_name,

active

Example:

"connection_name"

Response

Successful response with a list of call control applications.

data

Call Control Application · object[]

Show child attributes

data.active

boolean

default:true

Specifies whether the connection can be used.

data.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"

Example:

"\"Amsterdam, Netherlands\""

data.application_name

string

A user-assigned name to help manage the application.

Example:

"call-router"

data.created_at

string

ISO 8601 formatted date of when the resource was created

Example:

"2018-02-02T22:25:27.521Z"

data.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"

data.first_command_timeout

boolean

default:false

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

Example:

true

data.first_command_timeout_secs

integer

default:30

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

Example:

10

data.tags

string[]

Tags assigned to the Call Control Application.

data.id

string<int64>

Example:

"1293384261075731499"

data.inbound

Call Control Application Inbound · object

Show child attributes

data.inbound.channel_limit

integer

When set, this will limit the total number of inbound calls to phone numbers associated with this connection.

Example:

10

data.inbound.shaken_stir_enabled

boolean

default:false

When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls.

Example:

false

data.inbound.sip_subdomain

string

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.

Example:

"example"

data.inbound.sip_subdomain_receive_settings

enum<string>

default: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).

Available options:

only_my_connections,

from_anyone

Example:

"only_my_connections"

data.outbound

Call Control Application Outbound · object

Show child attributes

data.outbound.channel_limit

integer

When set, this will limit the total number of outbound calls to phone numbers associated with this connection.

Example:

10

data.outbound.outbound_voice_profile_id

string<int64>

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

data.record_type

enum<string>

default:call_control_application

Available options:

call_control_application

data.updated_at

string

ISO 8601 formatted date of when the resource was last updated

Example:

"2018-02-02T22:25:27.521Z"

data.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"

data.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"

data.webhook_event_url

string<url>

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

Example:

"https://example.com"

data.webhook_timeout_secs

integer | null

Required range: 0 <= x <= 30

Example:

25

data.call_cost_in_webhooks

boolean

default:false

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

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

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup