Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
TeXML Applications

Creates a TeXML Application

Creates a TeXML Application.

post/texml_applications

Request body

activeboolean

Specifies whether the connection can be used.

anchorsite_override'Latency' | 'Chicago, IL' | 'Ashburn, VA' | 'San Jose, CA' | 'Sydney, Australia' | 'Amsterdam, Netherlands' | 'London, UK' | 'Toronto, Canada' | 'Vancouver, Canada' | 'Frankfurt, Germany'

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.

call_cost_in_webhooksboolean

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

dtmf_type'RFC 2833' | 'Inband' | 'SIP INFO'

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.

first_command_timeoutboolean

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

first_command_timeout_secsinteger

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

friendly_namestring required

A user-assigned name to help manage the application.

status_callbackstring uri

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

status_callback_method'get' | 'post'

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

tagsstring[]

Tags associated with the Texml Application.

voice_fallback_urlstring uri

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

voice_method'get' | 'post'

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

voice_urlstring uri required

URL to which Telnyx will deliver your XML Translator webhooks.

Example request

{
  "active": false,
  "anchorsite_override": "Amsterdam, Netherlands",
  "call_cost_in_webhooks": false,
  "dtmf_type": "Inband",
  "first_command_timeout": true,
  "first_command_timeout_secs": 10,
  "friendly_name": "call-router",
  "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"
  },
  "status_callback": "https://example.com",
  "status_callback_method": "get",
  "tags": [
    "tag1",
    "tag2"
  ],
  "voice_fallback_url": "https://fallback.example.com",
  "voice_method": "get",
  "voice_url": "https://example.com"
}

Response

Successful response

Example response

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