Telnyx

Authorizations

Authorization

string

header

required

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

Query Parameters

page

object

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

Show child attributes

page[size]

integer

default:250

The size of the page

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load

Required range: x >= 1

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[outbound_voice_profile_id], filter[friendly_name]

Show child attributes

filter[outbound_voice_profile_id]

string

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

filter[friendly_name]

string

default:null

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

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

That is:

friendly_name: sorts the result by the friendly_name field in ascending order.
-friendly_name: sorts the result by the friendly_name field in descending order.

If not given, results are sorted by created_at in descending order.

Available options:

created_at,

friendly_name,

active

Example:

"friendly_name"

Response

Successful response

data

Texml Application · object[]

Show child attributes

data.id

string

Uniquely identifies the resource.

Example:

"1293384261075731499"

data.record_type

string

Identifies the type of the resource.

Example:

"texml_application"

data.friendly_name

string

A user-assigned name to help manage the application.

Example:

"call-router"

data.active

boolean

default:true

Specifies whether the connection can be used.

Example:

false

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,

Sydney, Australia,

Amsterdam, Netherlands,

London, UK,

Toronto, Canada,

Vancouver, Canada,

Frankfurt, Germany

Example:

"Amsterdam, Netherlands"

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

string<uri>

URL to which Telnyx will deliver your XML Translator webhooks.

Example:

"https://example.com"

data.voice_fallback_url

string<uri>

URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.

Example:

"https://fallback.example.com"

data.call_cost_in_webhooks

boolean

default:false

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

data.voice_method

enum<string>

default:post

HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.

Available options:

get,

post

Example:

"get"

data.status_callback

string<uri>

URL for Telnyx to send requests to containing information about call progress events.

Example:

"https://example.com"

data.status_callback_method

enum<string>

default:post

HTTP request method Telnyx should use when requesting the status_callback URL.

Available options:

get,

post

Example:

"get"

data.tags

string[]

Tags associated with the Texml Application.

Example:

["tag1", "tag2"]

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

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

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

data.created_at

string

ISO 8601 formatted date indicating when the resource was created.

Example:

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

data.updated_at

string

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2020-02-03T22:25:27.521Z"

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List all TeXML Applications

Authorizations

Query Parameters

Response