Call Control API Reference: TeXML Applications

List all TeXML Applications

get https://api.telnyx.com/v2/texml_applications

Returns a list of your TeXML Applications.

cURL
Python
Ruby
Node
PHP
Java
.NET
curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/texml_applications?page[number]=1&page[size]=20"

Parameters

In query

page[number]

integer (1)

optional

The page number to load

Default: 1

page[size]

integer (1 - 250)

optional

The size of the page

Default: 20

filter[friendly_name][contains]

string

optional

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

Default: "null"

filter[outbound_voice_profile_id]

string (int64)

optional

Identifies the associated outbound voice profile.

Example: "1293384261075731499"

sort

string

optional

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:

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

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

Default: "created_at"

Example: "connection_name"

Options: [ "created_at", "connection_name", "active" ]

Responses

200

Successful response

400

Bad request

401

Unauthorized

404

Resource not found

Success Response

JSON
Schema

{
  "data": [
    {
      "active": false,
      "anchorsite_override": "Amsterdam, Netherlands",
      "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,
        "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",
      "updated_at": "2020-02-03T22:25:27.521Z",
      "voice_fallback_url": "https://fallback.example.com",
      "voice_method": "get",
      "voice_url": "https://example.com"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Creates a TeXML Application

post https://api.telnyx.com/v2/texml_applications

Creates a TeXML Application.

cURL
Python
Ruby
Node
PHP
Java
.NET
curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"friendly_name":"call-router","voice_url":"https://example.com"}' \
  https://api.telnyx.com/v2/texml_applications

Parameters

In body

friendly_name

string

required

A user-assigned name to help manage the application.

Example: "call-router"

voice_url

string (url)

required

URL to which Telnyx will deliver your XML Translator webhooks.

Example: "https://example.com"

active

boolean

optional

Specifies whether the connection can be used.

Default: true

anchorsite_override

string

optional

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

Default: "Latency"

Example: "Amsterdam, Netherlands"

Options: [ "Latency", "Chicago, IL", "Ashburn, VA", "San Jose, CA", "Sydney, Australia", "Amsterdam, Netherlands", "London, UK", "Toronto, Canada", "Vancouver, Canada", "Frankfurt, Germany" ]

dtmf_type

string

optional

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.

Default: "RFC 2833"

Example: "Inband"

Options: [ "RFC 2833", "Inband", "SIP INFO" ]

first_command_timeout

boolean

optional

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

Default: false

Example: true

first_command_timeout_secs

integer

optional

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

Default: 30

Example: 10

inbound

object

optional

outbound

object

optional

status_callback

string (url)

optional

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

Default: null

Example: "https://example.com"

status_callback_method

string

optional

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

Default: "post"

Example: "get"

Options: [ "get", "post" ]

voice_fallback_url

string (url)

optional

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

Default: null

Example: "https://fallback.example.com"

voice_method

string

optional

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

Default: "post"

Example: "get"

Options: [ "get", "post" ]

Responses

201

Successful response

422

Bad request

Success Response

JSON
Schema

{
  "data": {
    "active": false,
    "anchorsite_override": "Amsterdam, Netherlands",
    "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,
      "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",
    "updated_at": "2020-02-03T22:25:27.521Z",
    "voice_fallback_url": "https://fallback.example.com",
    "voice_method": "get",
    "voice_url": "https://example.com"
  }
}

Retrieve a TeXML Application

get https://api.telnyx.com/v2/texml_applications/{id}

Retrieves the details of an existing TeXML Application.

cURL
Python
Ruby
Node
PHP
Java
.NET
curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/texml_applications/1293384261075731499"

Parameters

In path

string (int64)

required

Identifies the resource.

Example: "1293384261075731499"

Responses

200

Successful response

401

Unauthorized

404

Resource not found

422

Bad request

Success Response

JSON
Schema

{
  "data": {
    "active": false,
    "anchorsite_override": "Amsterdam, Netherlands",
    "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,
      "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",
    "updated_at": "2020-02-03T22:25:27.521Z",
    "voice_fallback_url": "https://fallback.example.com",
    "voice_method": "get",
    "voice_url": "https://example.com"
  }
}

Update a TeXML Application

patch https://api.telnyx.com/v2/texml_applications/{id}

Updates settings of an existing TeXML Application.

cURL
Python
Ruby
Node
PHP
Java
.NET
curl -X PATCH \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"friendly_name":"call-router","voice_url":"https://example.com"}' \
  https://api.telnyx.com/v2/texml_applications/1293384261075731499

Parameters

In path

string (int64)

required

Identifies the resource.

Example: "1293384261075731499"

In body

friendly_name

string

required

A user-assigned name to help manage the application.

Example: "call-router"

voice_url

string (url)

required

URL to which Telnyx will deliver your XML Translator webhooks.

Example: "https://example.com"

active

boolean

optional

Specifies whether the connection can be used.

Default: true

anchorsite_override

string

optional

Default: "Latency"

Example: "Amsterdam, Netherlands"

Options: [ "Latency", "Chicago, IL", "Ashburn, VA", "San Jose, CA", "Sydney, Australia", "Amsterdam, Netherlands", "London, UK", "Toronto, Canada", "Vancouver, Canada", "Frankfurt, Germany" ]

dtmf_type

string

optional

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.

Default: "RFC 2833"

Example: "Inband"

Options: [ "RFC 2833", "Inband", "SIP INFO" ]

first_command_timeout

boolean

optional

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

Default: false

Example: true

first_command_timeout_secs

integer

optional

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

Default: 30

Example: 10

inbound

object

optional

outbound

object

optional

status_callback

string (url)

optional

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

Default: null

Example: "https://example.com"

status_callback_method

string

optional

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

Default: "post"

Example: "get"

Options: [ "get", "post" ]

voice_fallback_url

string (url)

optional

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

Default: null

Example: "https://fallback.example.com"

voice_method

string

optional

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

Default: "post"

Example: "get"

Options: [ "get", "post" ]

Responses

200

Successful response

401

Unauthorized

404

Resource not found

422

Bad request

Success Response

JSON
Schema

{
  "data": {
    "active": false,
    "anchorsite_override": "Amsterdam, Netherlands",
    "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,
      "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",
    "updated_at": "2020-02-03T22:25:27.521Z",
    "voice_fallback_url": "https://fallback.example.com",
    "voice_method": "get",
    "voice_url": "https://example.com"
  }
}

Deletes a TeXML Application

delete https://api.telnyx.com/v2/texml_applications/{id}

Deletes a TeXML Application.

cURL
Python
Ruby
Node
PHP
Java
.NET
curl -X DELETE \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  "https://api.telnyx.com/v2/texml_applications/1293384261075731499"

Parameters

In path

string (int64)

required

Identifies the resource.

Example: "1293384261075731499"

Responses

200

Successful response

401

Unauthorized

404

Resource not found

422

Bad request

Success Response

JSON
Schema

{
  "data": {
    "active": false,
    "anchorsite_override": "Amsterdam, Netherlands",
    "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,
      "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",
    "updated_at": "2020-02-03T22:25:27.521Z",
    "voice_fallback_url": "https://fallback.example.com",
    "voice_method": "get",
    "voice_url": "https://example.com"
  }
}

Previous: Conference Commands

Next: TeXML Translator

In query

In body

In path

In path

In body

In path

Was this section helpful?