TeXML Applications API

TeXML Applications operations API

List all TeXML Applications

Returns a list of your TeXML Applications.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[friendly_name][contains]
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.

filter[outbound_voice_profile_id]
string <int64>

Identifies the associated outbound voice profile.

Example: filter[outbound_voice_profile_id]=1293384261075731499
sort
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:

  • 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.
Enum: "created_at" "connection_name" "active"
Example: sort=connection_name
Responses
200

Successful response

Response Schema: application/json
Array of objects (Texml Application)
object (PaginationMeta)
400

Bad request

401

Unauthorized

404

Resource not found

get/texml_applications
Request samples 
Response samples 
application/json
{
  • "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
Creates a TeXML Application.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
Parameters that can be set when creating a TeXML Application


active
boolean (ConnectionActive) 
Specifies whether the connection can be used.


 
anchorsite_override
string (AnchorsiteOverride) 
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.


 Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"  
dtmf_type
string (DtmfType) 
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.


 Enum: "RFC 2833" "Inband" "SIP INFO"  
first_command_timeout
boolean (FirstCommandTimeout) 
Specifies whether calls to phone numbers associated with this connection should hangup after timing out.


 
first_command_timeout_secs
integer (FirstCommandTimeoutSecs) 
Specifies how many seconds to wait before timing out a dial command.


 
friendly_name
required
string (ApplicationName) 
A user-assigned name to help manage the application.


 
object
 
object
 
status_callback
string <url> 
 Default:  null
URL for Telnyx to send requests to containing information about call progress events.


 
status_callback_method
string
 Default:  "post"
HTTP request method Telnyx should use when requesting the status_callback URL.


 Enum: "get" "post"  
voice_fallback_url
string <url> 
 Default:  null
URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.


 
voice_method
string
 Default:  "post"
HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.


 Enum: "get" "post"  
voice_url
required
string <url> 
URL to which Telnyx will deliver your XML Translator webhooks.


 
Responses 
201
Successful response


Response Schema: application/json
object (TexmlApplication) 
 
active
boolean (ConnectionActive) 
Specifies whether the connection can be used.


 
anchorsite_override
string (AnchorsiteOverride) 
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.


 Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"  
created_at
string (CreatedAt) 
ISO 8601 formatted date indicating when the resource was created.


 
dtmf_type
string (DtmfType) 
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.


 Enum: "RFC 2833" "Inband" "SIP INFO"  
first_command_timeout
boolean (FirstCommandTimeout) 
Specifies whether calls to phone numbers associated with this connection should hangup after timing out.


 
first_command_timeout_secs
integer (FirstCommandTimeoutSecs) 
Specifies how many seconds to wait before timing out a dial command.


 
friendly_name
string (ApplicationName) 
A user-assigned name to help manage the application.


 
id
string <int64>  (IntId) 
Uniquely identifies the resource.


 
object
 
object
 
record_type
string
Identifies the type of the resource.


 
status_callback
string <url> 
 Default:  null
URL for Telnyx to send requests to containing information about call progress events.


 
status_callback_method
string
 Default:  "post"
HTTP request method Telnyx should use when requesting the status_callback URL.


 Enum: "get" "post"  
updated_at
string (UpdatedAt) 
ISO 8601 formatted date indicating when the resource was updated.


 
voice_fallback_url
string <url> 
 Default:  null
URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.


 
voice_method
string
 Default:  "post"
HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.


 Enum: "get" "post"  
voice_url
string <url> 
URL to which Telnyx will deliver your XML Translator webhooks.


 
422
Bad request


post/texml_applications
Request samples 
application/json
{
  • "active": false,
  • "anchorsite_override": "Amsterdam, Netherlands",
  • "dtmf_type": "Inband",
  • "first_command_timeout": true,
  • "first_command_timeout_secs": 10,
  • "friendly_name": "call-router",
  • "inbound": {
    • "channel_limit": 10,
    • "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",
  • "voice_fallback_url": "https://fallback.example.com",
  • "voice_method": "get",
  • "voice_url": "https://example.com"
}
Response samples 
application/json
{
  • "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
Deletes a TeXML Application.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Successful response


Response Schema: application/json
object (TexmlApplication) 
 
active
boolean (ConnectionActive) 
Specifies whether the connection can be used.


 
anchorsite_override
string (AnchorsiteOverride) 
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.


 Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"  
created_at
string (CreatedAt) 
ISO 8601 formatted date indicating when the resource was created.


 
dtmf_type
string (DtmfType) 
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.


 Enum: "RFC 2833" "Inband" "SIP INFO"  
first_command_timeout
boolean (FirstCommandTimeout) 
Specifies whether calls to phone numbers associated with this connection should hangup after timing out.


 
first_command_timeout_secs
integer (FirstCommandTimeoutSecs) 
Specifies how many seconds to wait before timing out a dial command.


 
friendly_name
string (ApplicationName) 
A user-assigned name to help manage the application.


 
id
string <int64>  (IntId) 
Uniquely identifies the resource.


 
object
 
object
 
record_type
string
Identifies the type of the resource.


 
status_callback
string <url> 
 Default:  null
URL for Telnyx to send requests to containing information about call progress events.


 
status_callback_method
string
 Default:  "post"
HTTP request method Telnyx should use when requesting the status_callback URL.


 Enum: "get" "post"  
updated_at
string (UpdatedAt) 
ISO 8601 formatted date indicating when the resource was updated.


 
voice_fallback_url
string <url> 
 Default:  null
URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.


 
voice_method
string
 Default:  "post"
HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.


 Enum: "get" "post"  
voice_url
string <url> 
URL to which Telnyx will deliver your XML Translator webhooks.


 
401
Unauthorized


404
Resource not found


422
Bad request


delete/texml_applications/{id}
Request samples 
Response samples 
application/json
{
  • "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
Retrieves the details of an existing TeXML Application.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Successful response


Response Schema: application/json
object (TexmlApplication) 
 
active
boolean (ConnectionActive) 
Specifies whether the connection can be used.


 
anchorsite_override
string (AnchorsiteOverride) 
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.


 Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"  
created_at
string (CreatedAt) 
ISO 8601 formatted date indicating when the resource was created.


 
dtmf_type
string (DtmfType) 
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.


 Enum: "RFC 2833" "Inband" "SIP INFO"  
first_command_timeout
boolean (FirstCommandTimeout) 
Specifies whether calls to phone numbers associated with this connection should hangup after timing out.


 
first_command_timeout_secs
integer (FirstCommandTimeoutSecs) 
Specifies how many seconds to wait before timing out a dial command.


 
friendly_name
string (ApplicationName) 
A user-assigned name to help manage the application.


 
id
string <int64>  (IntId) 
Uniquely identifies the resource.


 
object
 
object
 
record_type
string
Identifies the type of the resource.


 
status_callback
string <url> 
 Default:  null
URL for Telnyx to send requests to containing information about call progress events.


 
status_callback_method
string
 Default:  "post"
HTTP request method Telnyx should use when requesting the status_callback URL.


 Enum: "get" "post"  
updated_at
string (UpdatedAt) 
ISO 8601 formatted date indicating when the resource was updated.


 
voice_fallback_url
string <url> 
 Default:  null
URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.


 
voice_method
string
 Default:  "post"
HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.


 Enum: "get" "post"  
voice_url
string <url> 
URL to which Telnyx will deliver your XML Translator webhooks.


 
401
Unauthorized


404
Resource not found


422
Bad request


get/texml_applications/{id}
Request samples 
Response samples 
application/json
{
  • "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
Updates settings of an existing TeXML Application.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Request Body schema: application/json
required
Parameters that can be updated in a TeXML Application


active
boolean (ConnectionActive) 
Specifies whether the connection can be used.


 
anchorsite_override
string (AnchorsiteOverride) 
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.


 Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"  
dtmf_type
string (DtmfType) 
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.


 Enum: "RFC 2833" "Inband" "SIP INFO"  
first_command_timeout
boolean (FirstCommandTimeout) 
Specifies whether calls to phone numbers associated with this connection should hangup after timing out.


 
first_command_timeout_secs
integer (FirstCommandTimeoutSecs) 
Specifies how many seconds to wait before timing out a dial command.


 
friendly_name
required
string (ApplicationName) 
A user-assigned name to help manage the application.


 
object
 
object
 
status_callback
string <url> 
 Default:  null
URL for Telnyx to send requests to containing information about call progress events.


 
status_callback_method
string
 Default:  "post"
HTTP request method Telnyx should use when requesting the status_callback URL.


 Enum: "get" "post"  
voice_fallback_url
string <url> 
 Default:  null
URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.


 
voice_method
string
 Default:  "post"
HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.


 Enum: "get" "post"  
voice_url
required
string <url> 
URL to which Telnyx will deliver your XML Translator webhooks.


 
Responses 
200
Successful response


Response Schema: application/json
object (TexmlApplication) 
 
active
boolean (ConnectionActive) 
Specifies whether the connection can be used.


 
anchorsite_override
string (AnchorsiteOverride) 
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.


 Enum: "Latency" "Chicago, IL" "Ashburn, VA" "San Jose, CA" "Sydney, Australia" "Amsterdam, Netherlands" "London, UK" "Toronto, Canada" "Vancouver, Canada" "Frankfurt, Germany"  
created_at
string (CreatedAt) 
ISO 8601 formatted date indicating when the resource was created.


 
dtmf_type
string (DtmfType) 
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.


 Enum: "RFC 2833" "Inband" "SIP INFO"  
first_command_timeout
boolean (FirstCommandTimeout) 
Specifies whether calls to phone numbers associated with this connection should hangup after timing out.


 
first_command_timeout_secs
integer (FirstCommandTimeoutSecs) 
Specifies how many seconds to wait before timing out a dial command.


 
friendly_name
string (ApplicationName) 
A user-assigned name to help manage the application.


 
id
string <int64>  (IntId) 
Uniquely identifies the resource.


 
object
 
object
 
record_type
string
Identifies the type of the resource.


 
status_callback
string <url> 
 Default:  null
URL for Telnyx to send requests to containing information about call progress events.


 
status_callback_method
string
 Default:  "post"
HTTP request method Telnyx should use when requesting the status_callback URL.


 Enum: "get" "post"  
updated_at
string (UpdatedAt) 
ISO 8601 formatted date indicating when the resource was updated.


 
voice_fallback_url
string <url> 
 Default:  null
URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.


 
voice_method
string
 Default:  "post"
HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.


 Enum: "get" "post"  
voice_url
string <url> 
URL to which Telnyx will deliver your XML Translator webhooks.


 
401
Unauthorized


404
Resource not found


422
Bad request


patch/texml_applications/{id}
Request samples 
application/json
{
  • "active": false,
  • "anchorsite_override": "Amsterdam, Netherlands",
  • "dtmf_type": "Inband",
  • "first_command_timeout": true,
  • "first_command_timeout_secs": 10,
  • "friendly_name": "call-router",
  • "inbound": {
    • "channel_limit": 10,
    • "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",
  • "voice_fallback_url": "https://fallback.example.com",
  • "voice_method": "get",
  • "voice_url": "https://example.com"
}
Response samples 
application/json
{
  • "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"
    }
}