Initiate an outbound call
Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the TeXML Application in the Mission Control Portal.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.texml.accounts.calls.calls('account_sid', {
params: { Url: 'https://www.example.com/texml.xml' },
});
console.log(response.from);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.texml.accounts.calls.calls(
account_sid="account_sid",
params={
"url": "https://www.example.com/texml.xml"
},
)
print(response.from_)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Texml.Accounts.Calls.Calls(
context.TODO(),
"account_sid",
telnyx.TexmlAccountCallCallsParams{
OfWithURL: &telnyx.TexmlAccountCallCallsParamsParamsWithURL{
URL: "https://www.example.com/texml.xml",
},
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.From)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.texml.accounts.calls.CallCallsParams;
import com.telnyx.sdk.models.texml.accounts.calls.CallCallsResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
CallCallsParams params = CallCallsParams.builder()
.accountSid("account_sid")
.params(CallCallsParams.Params.WithUrl.builder()
.url("https://www.example.com/texml.xml")
.build())
.build();
CallCallsResponse response = client.texml().accounts().calls().calls(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.texml.accounts.calls.calls("account_sid", params: {Url: "https://www.example.com/texml.xml"})
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->texml->accounts->calls->calls(
'account_sid',
params: [
'url' => 'https://www.example.com/texml.xml',
'applicationSid' => 'example-app-sid',
'asyncAmd' => true,
'asyncAmdStatusCallback' => 'https://www.example.com/callback',
'asyncAmdStatusCallbackMethod' => 'GET',
'callerID' => 'Info',
'cancelPlaybackOnDetectMessageEnd' => false,
'cancelPlaybackOnMachineDetection' => false,
'customHeaders' => [
['name' => 'X-Custom-Header', 'value' => 'custom-value']
],
'deepfakeDetection' => 'Enable',
'deepfakeDetectionCallbackMethod' => 'GET',
'deepfakeDetectionCallbackURL' => 'https://www.example.com/deepfake-callback',
'detectionMode' => 'Premium',
'fallbackURL' => 'https://www.example.com/instructions-fallback.xml',
'from' => '+13120001234',
'machineDetection' => 'Enable',
'machineDetectionPromptEndTimeout' => 5000,
'machineDetectionSilenceTimeout' => 2000,
'machineDetectionSpeechEndThreshold' => 2000,
'machineDetectionSpeechThreshold' => 2000,
'machineDetectionTimeout' => 5000,
'mediaEncryption' => 'disabled',
'preferredCodecs' => 'PCMA,PCMU',
'record' => false,
'recordingChannels' => 'dual',
'recordingStatusCallback' => 'https://example.com/recording_status_callback',
'recordingStatusCallbackEvent' => 'in-progress completed absent',
'recordingStatusCallbackMethod' => 'GET',
'recordingTimeout' => 5,
'recordingTrack' => 'inbound',
'sendRecordingURL' => false,
'sipAuthPassword' => '1234',
'sipAuthUsername' => 'user',
'sipRegion' => 'Canada',
'statusCallback' => 'https://www.example.com/statuscallback-listener',
'statusCallbackEvent' => 'initiated',
'statusCallbackMethod' => 'GET',
'superviseCallSid' => 'v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg',
'supervisingRole' => 'monitor',
'texml' => 'Texml',
'timeLimit' => 3600,
'timeout' => 60,
'to' => '+13121230000',
'trim' => 'trim-silence',
'urlMethod' => 'GET',
],
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx texml:accounts:calls calls \
--api-key 'My API Key' \
--account-sid account_sid \
--params '{Url: https://www.example.com/texml.xml}'curl --request POST \
--url https://api.telnyx.com/v2/texml/Accounts/{account_sid}/Calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"To": "+13121230000",
"From": "+13120001234",
"Url": "https://www.example.com/texml.xml",
"StatusCallback": "https://www.example.com/statuscallback-listener",
"ApplicationSid": "1293384261075731499"
}
'Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The UUID of the Telnyx account that owns the resource, for example f5586561-8ff0-4291-a51b-c7dfe4139ff9. The account_sid path segment is kept for Twilio API compatibility, but the value is a Telnyx account UUID, not a Twilio AC... SID. It must match the account that owns the API key used to authenticate the request, otherwise the endpoint returns 404. The same value is sent as AccountSid in TeXML webhooks.
"f5586561-8ff0-4291-a51b-c7dfe4139ff9"
Body
Initiate Call request object
- Initiate Call Request
- Initiate Call Request
- Initiate Call Request
The ID of the TeXML Application that will handle the call, for example 1293384261075731499. The ApplicationSid name is kept for Twilio API compatibility, but the value is the numeric ID of one of your TeXML Applications (see the TeXML Applications API or the Mission Control Portal), not a Twilio AP... SID. If Url and Texml are omitted, Telnyx fetches instructions from the XML Request URL configured on this application.
"1293384261075731499"
The phone number of the called party. Phone numbers are formatted with a + and country code.
"+16175551212"
The phone number of the party that initiated the call. Phone numbers are formatted with a + and country code.
"+16175551212"
The URL from which Telnyx will retrieve the TeXML call instructions.
"https://www.example.com/instructions.xml"
TeXML to be used as instructions for the call. If provided, the call will execute these instructions instead of fetching from the Url.
"<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Say>Hello</Say></Response>"
To be used as the caller id name (SIP From Display Name) presented to the destination (To number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the From field.
"Info"
HTTP request type used for Url. The default value is inherited from TeXML Application setting.
GET, POST "GET"
A failover URL for which Telnyx will retrieve the TeXML call instructions if the Url is not responding.
"https://www.example.com/instructions-fallback.xml"
URL destination for Telnyx to send status callback events to for the call.
"https://www.example.com/callback"
HTTP request type used for StatusCallback.
GET, POST "GET"
The call events for which Telnyx should send a webhook. Multiple events can be defined when separated by a space.
"initiated answered"
Enables Answering Machine Detection.
Enable, Disable, DetectMessageEnd "Enable"
Allows you to choose between Regular, Premium, and PremiumCallScreening detections. See https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
Premium, Regular, PremiumCallScreening "Premium"
Select whether to perform answering machine detection in the background. By default execution is blocked until Answering Machine Detection is completed.
true
URL destination for Telnyx to send AMD callback events to for the call.
"https://www.example.com/callback"
HTTP request type used for AsyncAmdStatusCallback. The default value is inherited from TeXML Application setting.
GET, POST "GET"
Maximum timeout threshold in milliseconds for overall detection.
500 <= x <= 600005000
Silence duration threshold after a call screening prompt before ending prompt detection, in milliseconds. Used when DetectionMode is PremiumCallScreening.
1000 <= x <= 1200005000
Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when premium detection is used.
2000
Silence duration threshold after a greeting message or voice for it be considered human. Ignored when premium detection is used.
2000
If initial silence duration is greater than this value, consider it a machine. Ignored when premium detection is used.
2000
Selects which detectors must validate a beep. both requires the amplitude and frequency detectors to agree. freq_only uses the frequency detector alone, for beeps whose volume is too unsteady for the default profile. Only used when MachineDetection is enabled.
both, freq_only "freq_only"
Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising it above 480 excludes North American ringback (440 + 480 Hz), which can otherwise be reported as a beep when the freq_only profile is in use. Only used when MachineDetection is enabled.
200 <= x <= 4000550
Highest frequency, in Hz, that a tone can reach and still be treated as a beep. Only used when MachineDetection is enabled.
200 <= x <= 40002000
Shortest tone, in milliseconds, that can be treated as a beep. Raising it rejects brief tones such as call-progress blips. Only used when MachineDetection is enabled.
50 <= x <= 5000300
When enabled, a candidate beep must pass an additional spectral check before it is reported. Only used when MachineDetection is enabled.
true
Length of the spectral confirmation window, in milliseconds. Only used when MachineDetection is enabled.
20 <= x <= 1000100
Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep. Raising it rejects mixed tones such as ringback, which combines two frequencies. Only used when MachineDetection is enabled.
0 <= x <= 10.8
When enabled, the fax CNG tone is rejected rather than reported as a beep. Only used when MachineDetection is enabled.
true
Whether to cancel ongoing playback on machine detection. Defaults to true.
false
Whether to cancel ongoing playback on greeting ended detection. Defaults to true.
false
Enables Deepfake Detection on the dialed call. When enabled, audio from the remote party is analyzed to determine whether the voice is AI-generated. Results are delivered asynchronously via a callback.
Enable "Enable"
URL destination for Telnyx to send deepfake detection callback events to for the call.
"https://www.example.com/deepfake-callback"
HTTP request type used for DeepfakeDetectionCallbackUrl.
GET, POST "GET"
The list of comma-separated codecs to be offered on a call.
"PCMA,PCMU"
Whether to record the entire participant's call leg. Defaults to false.
false
The number of channels in the final recording. Defaults to mono.
mono, dual "dual"
The URL the recording callbacks will be sent to.
"https://example.com/recording_status_callback"
HTTP request type used for RecordingStatusCallback. Defaults to POST.
GET, POST "GET"
The changes to the recording's state that should generate a call to RecoridngStatusCallback. Can be: in-progress, completed and absent. Separate multiple values with a space. Defaults to completed.
"in-progress completed absent"
The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite)
5
The audio track to record for the call. The default is both.
inbound, outbound, both "inbound"
Whether to send RecordingUrl in webhooks.
false
The password to use for SIP authentication.
"1234"
The username to use for SIP authentication.
"user"
Whether to trim any leading and trailing silence from the recording. Defaults to trim-silence.
trim-silence, do-not-trim "trim-silence"
Custom HTTP headers to be sent with the call. Each header should be an object with 'name' and 'value' properties.
Show child attributes
Show child attributes
[ { "name": "X-Custom-Header", "value": "custom-value" } ]
Defines the SIP region to be used for the call.
US, Europe, Canada, Australia, Middle East "Canada"
Defines whether media should be encrypted on the call. When set to SRTP, the call will use Secure Real-time Transport Protocol for media encryption. When set to DTLS, the call will use DTLS for media encryption. Only supported for SIP destinations.
disabled, SRTP, DTLS "disabled"
The call control ID of the existing call to supervise. When provided, the created leg will be added to the specified call in supervising mode. Status callbacks and action callbacks will NOT be sent for the supervising leg.
"v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"
The supervising role for the new leg. Determines the audio behavior: barge (hear both sides), whisper (only hear supervisor), monitor (hear both sides but supervisor muted). Default: barge
barge, whisper, monitor "monitor"
The number of seconds to wait for the called party to answer the call before the call is canceled. The minimum value is 5 and the maximum value is 120. Default is 30 seconds.
5 <= x <= 12060
The maximum duration of the call in seconds. The minimum value is 30 and the maximum value is 14400 (4 hours). Default is 14400 seconds.
30 <= x <= 144003600
Was this page helpful?
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.texml.accounts.calls.calls('account_sid', {
params: { Url: 'https://www.example.com/texml.xml' },
});
console.log(response.from);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.texml.accounts.calls.calls(
account_sid="account_sid",
params={
"url": "https://www.example.com/texml.xml"
},
)
print(response.from_)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Texml.Accounts.Calls.Calls(
context.TODO(),
"account_sid",
telnyx.TexmlAccountCallCallsParams{
OfWithURL: &telnyx.TexmlAccountCallCallsParamsParamsWithURL{
URL: "https://www.example.com/texml.xml",
},
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.From)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.texml.accounts.calls.CallCallsParams;
import com.telnyx.sdk.models.texml.accounts.calls.CallCallsResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
CallCallsParams params = CallCallsParams.builder()
.accountSid("account_sid")
.params(CallCallsParams.Params.WithUrl.builder()
.url("https://www.example.com/texml.xml")
.build())
.build();
CallCallsResponse response = client.texml().accounts().calls().calls(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.texml.accounts.calls.calls("account_sid", params: {Url: "https://www.example.com/texml.xml"})
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->texml->accounts->calls->calls(
'account_sid',
params: [
'url' => 'https://www.example.com/texml.xml',
'applicationSid' => 'example-app-sid',
'asyncAmd' => true,
'asyncAmdStatusCallback' => 'https://www.example.com/callback',
'asyncAmdStatusCallbackMethod' => 'GET',
'callerID' => 'Info',
'cancelPlaybackOnDetectMessageEnd' => false,
'cancelPlaybackOnMachineDetection' => false,
'customHeaders' => [
['name' => 'X-Custom-Header', 'value' => 'custom-value']
],
'deepfakeDetection' => 'Enable',
'deepfakeDetectionCallbackMethod' => 'GET',
'deepfakeDetectionCallbackURL' => 'https://www.example.com/deepfake-callback',
'detectionMode' => 'Premium',
'fallbackURL' => 'https://www.example.com/instructions-fallback.xml',
'from' => '+13120001234',
'machineDetection' => 'Enable',
'machineDetectionPromptEndTimeout' => 5000,
'machineDetectionSilenceTimeout' => 2000,
'machineDetectionSpeechEndThreshold' => 2000,
'machineDetectionSpeechThreshold' => 2000,
'machineDetectionTimeout' => 5000,
'mediaEncryption' => 'disabled',
'preferredCodecs' => 'PCMA,PCMU',
'record' => false,
'recordingChannels' => 'dual',
'recordingStatusCallback' => 'https://example.com/recording_status_callback',
'recordingStatusCallbackEvent' => 'in-progress completed absent',
'recordingStatusCallbackMethod' => 'GET',
'recordingTimeout' => 5,
'recordingTrack' => 'inbound',
'sendRecordingURL' => false,
'sipAuthPassword' => '1234',
'sipAuthUsername' => 'user',
'sipRegion' => 'Canada',
'statusCallback' => 'https://www.example.com/statuscallback-listener',
'statusCallbackEvent' => 'initiated',
'statusCallbackMethod' => 'GET',
'superviseCallSid' => 'v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg',
'supervisingRole' => 'monitor',
'texml' => 'Texml',
'timeLimit' => 3600,
'timeout' => 60,
'to' => '+13121230000',
'trim' => 'trim-silence',
'urlMethod' => 'GET',
],
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx texml:accounts:calls calls \
--api-key 'My API Key' \
--account-sid account_sid \
--params '{Url: https://www.example.com/texml.xml}'curl --request POST \
--url https://api.telnyx.com/v2/texml/Accounts/{account_sid}/Calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"To": "+13121230000",
"From": "+13120001234",
"Url": "https://www.example.com/texml.xml",
"StatusCallback": "https://www.example.com/statuscallback-listener",
"ApplicationSid": "1293384261075731499"
}
'