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"
In query
The page number to load
The size of the page
If present, applications with friendly_name
containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
Identifies the associated outbound voice profile.
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 theconnection_name
field in ascending order. -
-connection_name
: sorts the result by theconnection_name
field in descending order.
If not given, results are sorted by
created_at
in descending order.Successful response
Bad request
Unauthorized
Resource not found
- 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
}
}
- 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
In body
A user-assigned name to help manage the application.
URL to which Telnyx will deliver your XML Translator webhooks.
Specifies whether the connection can be used.
`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.
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.
Specifies whether calls to phone numbers associated with this connection should hangup after timing out.
Specifies how many seconds to wait before timing out a dial command.
When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
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.
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).
When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
Identifies the associated outbound voice profile.
URL for Telnyx to send requests to containing information about call progress events.
HTTP request method Telnyx should use when requesting the status_callback URL.
URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.
HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.
Successful response
Bad request
- 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"
}
}
- 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"
In path
Identifies the resource.
Successful response
Unauthorized
Resource not found
Bad request
- 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"
}
}
- 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
In path
Identifies the resource.
In body
A user-assigned name to help manage the application.
URL to which Telnyx will deliver your XML Translator webhooks.
Specifies whether the connection can be used.
`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.
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.
Specifies whether calls to phone numbers associated with this connection should hangup after timing out.
Specifies how many seconds to wait before timing out a dial command.
When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
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.
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).
When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
Identifies the associated outbound voice profile.
URL for Telnyx to send requests to containing information about call progress events.
HTTP request method Telnyx should use when requesting the status_callback URL.
URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.
HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.
Successful response
Unauthorized
Resource not found
Bad request
- 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"
}
}
- 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"
In path
Identifies the resource.
Successful response
Unauthorized
Resource not found
Bad request
- 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"
}
}