All Collections
Voice API Essentials
Call Control / TeXML
Configuring Call Control/TeXML Applications - Voice API
Configuring Call Control/TeXML Applications - Voice API

This article describes the in-depth setup of Call Control / TeXML Applications on our Mission Control Portal.

Ruchita Jain avatar
Written by Ruchita Jain
Updated this week

Configuration of Call Control/TeXML Voice Apps

The Call Control / TeXML applications section is located on the left hand side of the portal under Voice > Programmable Voice.

Click on this button below and it will directly get you to the Voice Applications page.


Voice Applications (Call Control Voice API Application)

Voice App Name

Click on " Create your first application" and assign a name to this application to better manage the application.

Call Control Application Creation tab.

Send a webhook to the URL

You will need to input a URL where all the webhook events will be sent. Also, you can setup a fail-over URL. If two consecutive delivery attempts to the primary URL fail, Telnyx will attempt delivery to this URL. NOTE: Must include a scheme such as 'https'.

A Webhook URL insertion box.

Use Webhook API version

Determines which webhook format will be used based on the API version V1 or V2.


We recommend using API V2, as it contains a richer feature set versus the initial version which will be deprecated in the future.

Hang-up timeout section.

Enable "hang-up" on timeout

When enabled, you will specify the number of seconds Telnyx will wait for commands from your application before hanging up.

Hang-out timeout section.

Custom webhook retry delay (seconds)

In this field, you will need to specify a delay in seconds for Telnyx to wait before retrying an unsuccessful webhook delivery attempt. If not set, Telnyx will retry immediately.

Custom webhook retry delay box.

AnchorSite® Selection

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

AnchorSite selection Menu dropdown box.

DTMF Type

There are three types in this field: RFC 2833, Inband and SIP INFO.

  1. RFC 2833: Default and preferred setting for most use cases, not audible on the call audio.

  2. Inband: Digits are passed along just like the rest of your voice as normal audio tones.

  3. SIP INFO: Mainly used for SIP to SIP calls. DTMF type is negotiated between parties on the call.

DTMF Type selection Type.

RTCP Capture

Enable capture of RTCP reports to build QoS Reports (found under Debugging > SIP Call Flow Tool). By default it's not enabled, clicked the "yes" radio button to enable it.

Call Cost Webhook Event

Specify if the call cost webhook should be sent. By default it's not enabled, clicked the "yes" radio button to enable it.


Inbound Settings

You can configure your global application settings for inbound calls over here.

Inbound setting screenshot

Subdomain

Specify a subdomain that can be used to receive 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.

  • You only need to specify the subdomain in this field, there is no need to specify a Telnyx domain after it.

  • SIP subdomain receive settings: In this field, either you setup your receive SIP subdomain connection from anyone or only connections.

Inbound Channel Limit

You can limit the total number of inbound calls to phone numbers associated with this connection.

Enable Shaken Stir headers

By default, the radio button for no is checked. Select yes and save your settings if you want receive attestation information in the webhooks for incoming calls.

Codecs

Select the codes using the check mark boxes that you would like Telnyx to offer on your calls. You can force specific codecs by only checking one of the boxes.


Outbound settings

You can configure your global application settings for outbound calls over here.

Outbound Settings page.

Outbound Voice Profile

Assign your application to an outbound voice profile in order to make outbound calls.

Outbound Channel Limit

You can limit the total number of outbound calls to phone numbers associated with this connection.


Where can I find my Call Control application or app id?

Once you've successfully created your Call Control application, it is given an application id that can be seen within the application settings as seen in the below picture.

Why do I need an Call Control application or app id?

The application id is used to reference or trigger your API calls programmatically. Don't forget to reference our developer documentation to see how you can control your calls with the different API commands available.


TeXML Applications

Programmable Voice/TeXML Application Dashboard.

TeXML App Name

Click on " Create your first application" and assign a name to this application to better manage the application.

Voice Method

In this field, HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either "GET" or "POST".

Voice Method button.

Send a TeXML webhook to the URL

You will need to mention a URL where all the XML translator webhook events will be sent. Also, you can setup a fail-over URL. This URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your "Voice URL"

TeXML Webhook URL.

Status Callback Method

You will need to mention the HTTP request method Telnyx should use when requesting the "Status Callback" URL.

Status Callback Method button.

Send information about call progress events to the URL

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

Call progress events information URL box.

Enable "hang-up" on timeout

When enabled, you will specify the numbers of seconds to wait for actual application before hanging up.

Hang up on timeout selection box.

AnchorSite® Selection

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

AnchorSite Selection menu dropdown box.

DTMF Type

There are three types in this field: RFC 2833, Inband and SIP INFO.

  1. RFC 2833: Default and preferred setting for most use cases, not audible on the call audio.

  2. Inband: Digits are passed along just like the rest of your voice as normal audio tones.

  3. SIP INFO: Mainly used for SIP to SIP calls. DTMF type is negotiated between parties on the call.

DTMF Type selection boxes.

RTCP Capture

Enable capture of RTCP reports to build QoS Reports (found under Debugging > SIP Call Flow Tool). By default it's not enabled, clicked the "yes" radio button to enable it.

Call Cost Webhook Event

Specify if the call cost webhook should be sent. By default it's not enabled, clicked the "yes" radio button to enable it.


Inbound Settings

You can configure your global application settings for inbound calls over here.

Inbound Setting Screenshot

Subdomain

Specify a subdomain that can be used to receive 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.

  • You only need to specify the subdomain in this field, there is no need to specify a Telnyx domain after it.

  • SIP subdomain receive settings: In this field, either you setup your receive SIP subdomain connection from anyone or only connections.

Inbound Channel Limit

You can limit the total number of inbound calls to phone numbers associated with this connection.

Enable Shaken Stir headers

By default, the radio button for no is checked. Select yes and save your settings if you want receive attestation information in the webhooks for incoming calls.

Codecs

Select the codes using the check mark boxes that you would like Telnyx to offer on your calls. You can force specific codecs by only checking one of the boxes.


Outbound settings

You can configure your global application settings for outbound calls over here.

Outbound settings page.

Outbound Voice Profile

Assign your application to an outbound voice profile in order to make outbound calls.

Outbound Channel Limit

You can limit the total number of outbound calls to phone numbers associated with this connection.

Outbound settings options page.

Where can I find my TeXML application or app id?

Once you've successfully created your TeXML application, it is given an application id that can be seen within the application settings as seen in the below picture.

TeXML applications and App settings dashboard.

Why do I need an TeXML application or app id?

The application id is used to reference or trigger your API calls programmatically. Don't forget to reference our developer documentation to see how you can setup your XML instructions.

Breaking Line

Did this answer your question?