Skip to main content
POST
/
texml_applications
JavaScript
import Telnyx from 'telnyx';

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

const texmlApplication = await client.texmlApplications.create({
  friendly_name: 'call-router',
  voice_url: 'https://example.com',
});

console.log(texmlApplication.data);
{
  "data": {
    "id": "1293384261075731499",
    "record_type": "texml_application",
    "active": false,
    "friendly_name": "call-router",
    "anchorsite_override": "Amsterdam, Netherlands",
    "dtmf_type": "Inband",
    "first_command_timeout": true,
    "first_command_timeout_secs": 10,
    "voice_url": "https://example.com",
    "voice_fallback_url": "https://fallback.example.com",
    "call_cost_in_webhooks": false,
    "voice_method": "get",
    "status_callback": "https://example.com",
    "status_callback_method": "get",
    "tags": [
      "tag1",
      "tag2"
    ],
    "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"
    },
    "created_at": "2020-02-02T22:25:27.521Z",
    "updated_at": "2020-02-03T22:25:27.521Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Parameters that can be set when creating a TeXML Application

​
friendly_name
string
required

A user-assigned name to help manage the application.

Example:

"call-router"

​
voice_url
string<uri>
required

URL to which Telnyx will deliver your XML Translator webhooks.

Example:

"https://example.com"

​
active
boolean
default:true

Specifies whether the connection can be used.

Example:

false

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

​
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 associated with the Texml Application.

Example:
["tag1", "tag2"]
​
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"

​
call_cost_in_webhooks
boolean
default:false

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

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

​
status_callback
string<uri>

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

Example:

"https://example.com"

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

​
inbound
object
​
outbound
object

Response

Successful response

​
data
object
Example:
{
  "id": "1293384261075731499",
  "record_type": "texml_application",
  "active": false,
  "friendly_name": "call-router",
  "anchorsite_override": "Amsterdam, Netherlands",
  "dtmf_type": "Inband",
  "first_command_timeout": true,
  "first_command_timeout_secs": 10,
  "voice_url": "https://example.com",
  "voice_fallback_url": "https://fallback.example.com",
  "call_cost_in_webhooks": false,
  "voice_method": "get",
  "status_callback": "https://example.com",
  "status_callback_method": "get",
  "tags": ["tag1", "tag2"],
  "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"
  },
  "created_at": "2020-02-02T22:25:27.521Z",
  "updated_at": "2020-02-03T22:25:27.521Z"
}