Dial

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.calls.dial({
  connection_id: '7267xxxxxxxxxxxxxx',
  from: '+18005550101',
  to: '+18005550100 or sip:[email protected];secure=srtp',
});

console.log(response.data);

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.calls.dial(
    connection_id="7267xxxxxxxxxxxxxx",
    from_="+18005550101",
    to="+18005550100 or sip:[email protected];secure=srtp",
)
print(response.data)

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.Calls.Dial(context.TODO(), telnyx.CallDialParams{
		ConnectionID: "7267xxxxxxxxxxxxxx",
		From:         "+18005550101",
		To: telnyx.CallDialParamsToUnion{
			OfString: telnyx.String("+18005550100 or sip:[email protected];secure=srtp"),
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.calls.CallDialParams;
import com.telnyx.sdk.models.calls.CallDialResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        CallDialParams params = CallDialParams.builder()
            .connectionId("7267xxxxxxxxxxxxxx")
            .from("+18005550101")
            .to("+18005550100 or sip:[email protected];secure=srtp")
            .build();
        CallDialResponse response = client.calls().dial(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.calls.dial(
  connection_id: "7267xxxxxxxxxxxxxx",
  from: "+18005550101",
  to: "+18005550100 or sip:[email protected];secure=srtp"
)

puts(response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Calls\StreamBidirectionalCodec;
use Telnyx\Calls\StreamBidirectionalMode;
use Telnyx\Calls\StreamBidirectionalSamplingRate;
use Telnyx\Calls\StreamBidirectionalTargetLegs;
use Telnyx\Calls\StreamCodec;
use Telnyx\Calls\Actions\GoogleTranscriptionLanguage;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->calls->dial(
    connectionID: '7267xxxxxxxxxxxxxx',
    from: '+18005550101',
    to: '+18005550100 or sip:[email protected];secure=srtp',
    answeringMachineDetection: 'detect',
    answeringMachineDetectionConfig: [
      'afterGreetingSilenceMillis' => 1000,
      'betweenWordsSilenceMillis' => 1000,
      'greetingDurationMillis' => 1000,
      'greetingSilenceDurationMillis' => 2000,
      'greetingTotalAnalysisTimeMillis' => 50000,
      'initialSilenceMillis' => 1000,
      'maximumNumberOfWords' => 1000,
      'maximumWordLengthMillis' => 2000,
      'silenceThreshold' => 512,
      'totalAnalysisTimeMillis' => 5000,
    ],
    assistant: [
      'id' => 'id',
      'dynamicVariables' => [
        'customer_name' => 'John', 'account_id' => 'ACC-12345'
      ],
      'externalLlm' => [
        'authenticationMethod' => 'token',
        'baseURL' => 'base_url',
        'certificateRef' => 'certificate_ref',
        'forwardMetadata' => true,
        'llmAPIKeyRef' => 'llm_api_key_ref',
        'model' => 'model',
        'tokenRetrievalURL' => 'token_retrieval_url',
      ],
      'fallbackConfig' => [
        'externalLlm' => [
          'authenticationMethod' => 'token',
          'baseURL' => 'base_url',
          'certificateRef' => 'certificate_ref',
          'forwardMetadata' => true,
          'llmAPIKeyRef' => 'llm_api_key_ref',
          'model' => 'model',
          'tokenRetrievalURL' => 'token_retrieval_url',
        ],
        'llmAPIKeyRef' => 'llm_api_key_ref',
        'model' => 'model',
      ],
      'greeting' => 'greeting',
      'instructions' => 'You are a friendly voice assistant.',
      'llmAPIKeyRef' => 'my_llm_api_key',
      'mcpServers' => [['foo' => 'bar']],
      'model' => 'gpt-4o',
      'name' => 'name',
      'observabilitySettings' => ['foo' => 'bar'],
      'openaiAPIKeyRef' => 'my_openai_api_key',
      'tools' => [
        [
          'bookAppointment' => [
            'apiKeyRef' => 'my_calcom_api_key',
            'eventTypeID' => 0,
            'attendeeName' => 'attendee_name',
            'attendeeTimezone' => 'attendee_timezone',
          ],
          'type' => 'book_appointment',
        ],
      ],
    ],
    audioURL: 'http://www.example.com/sounds/greeting.wav',
    billingGroupID: 'f5586561-8ff0-4291-a0ac-84fe544797bd',
    bridgeIntent: true,
    bridgeOnAnswer: true,
    clientState: 'aGF2ZSBhIG5pY2UgZGF5ID1d',
    commandID: '891510ac-f3e4-11e8-af5b-de00688a4901',
    conferenceConfig: [
      'id' => '0ccc7b54-4df3-4bca-a65a-3da1ecc777f0',
      'beepEnabled' => 'on_exit',
      'conferenceName' => 'telnyx-conference',
      'earlyMedia' => false,
      'endConferenceOnExit' => true,
      'hold' => true,
      'holdAudioURL' => 'http://example.com/message.wav',
      'holdMediaName' => 'my_media_uploaded_to_media_storage_api',
      'mute' => true,
      'softEndConferenceOnExit' => true,
      'startConferenceOnCreate' => false,
      'startConferenceOnEnter' => true,
      'supervisorRole' => 'whisper',
      'whisperCallControlIDs' => [
        'v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ',
        'v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw',
      ],
    ],
    conversationRelayConfig: [
      'url' => 'wss://example.com/conversation-relay',
      'customParameters' => ['customer_id' => 'bar'],
      'dtmfDetection' => true,
      'greeting' => 'Hi! Ask me anything!',
      'interruptible' => 'speech',
      'interruptibleGreeting' => 'dtmf',
      'interruptionSettings' => [
        'enable' => true,
        'interruptible' => 'speech',
        'interruptibleGreeting' => 'speech',
        'welcomeGreetingInterruptible' => 'speech',
      ],
      'language' => 'en-US',
      'languages' => [
        [
          'language' => 'en-US',
          'speechModel' => 'nova-3',
          'transcriptionEngine' => 'Deepgram',
          'transcriptionEngineConfig' => ['transcription_model' => 'bar'],
          'transcriptionProvider' => 'Deepgram',
          'ttsProvider' => 'telnyx',
          'voice' => 'Telnyx.Ultra.alloy',
          'voiceSettings' => [
            'type' => 'elevenlabs', 'apiKeyRef' => 'my_elevenlabs_api_key'
          ],
        ],
      ],
      'provider' => 'elevenlabs',
      'structuredProvider' => ['voice_id' => 'bar', 'model_id' => 'bar'],
      'transcriptionEngine' => 'Google',
      'transcriptionEngineConfig' => [
        'transcription_model' => 'bar',
        'interim_results' => 'bar',
        'keywords_boosting' => 'bar',
      ],
      'ttsProvider' => 'telnyx',
      'voice' => 'Telnyx.KokoroTTS.af',
      'voiceSettings' => ['type' => 'telnyx', 'voiceSpeed' => 1],
    ],
    customHeaders: [
      ['name' => 'head_1', 'value' => 'val_1'],
      ['name' => 'head_2', 'value' => 'val_2'],
    ],
    deepfakeDetection: ['enabled' => true, 'rtpTimeout' => 30, 'timeout' => 15],
    dialogflowConfig: [
      'analyzeSentiment' => false, 'partialAutomatedAgentReply' => false
    ],
    enableDialogflow: false,
    fromDisplayName: 'Company Name',
    linkTo: 'ilditnZK_eVysupV21KzmzN_sM29ygfauQojpm4BgFtfX5hXAcjotg==',
    mediaEncryption: 'SRTP',
    mediaName: 'my_media_uploaded_to_media_storage_api',
    parkAfterUnbridge: 'self',
    preferredCodecs: 'G722,PCMU,PCMA,G729,OPUS,VP8,H264',
    preventDoubleBridge: true,
    privacy: 'id',
    record: 'record-from-answer',
    recordChannels: 'single',
    recordCustomFileName: 'my_recording_file_name',
    recordFormat: 'wav',
    recordMaxLength: 1000,
    recordTimeoutSecs: 100,
    recordTrack: 'outbound',
    recordTrim: 'trim-silence',
    sendDigitsOnAnswer: 'wwww200',
    sendSilenceWhenIdle: true,
    sipAuthPassword: 'password',
    sipAuthUsername: 'username',
    sipHeaders: [['name' => 'User-to-User', 'value' => '12345']],
    sipRegion: 'Canada',
    sipTransportProtocol: 'TLS',
    soundModifications: [
      'octaves' => 0.1, 'pitch' => 0.8, 'semitone' => -2, 'track' => 'both'
    ],
    streamAuthToken: 'your-auth-token',
    streamBidirectionalCodec: StreamBidirectionalCodec::G722,
    streamBidirectionalMode: StreamBidirectionalMode::RTP,
    streamBidirectionalSamplingRate: StreamBidirectionalSamplingRate::RATE_16000,
    streamBidirectionalTargetLegs: StreamBidirectionalTargetLegs::BOTH,
    streamCodec: StreamCodec::PCMA,
    streamEstablishBeforeCallOriginate: true,
    streamTrack: 'both_tracks',
    streamURL: 'wss://www.example.com/websocket',
    superviseCallControlID: 'v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg',
    supervisorRole: 'barge',
    timeLimitSecs: 60,
    timeoutSecs: 60,
    transcription: true,
    transcriptionConfig: [
      'clientState' => 'aGF2ZSBhIG5pY2UgZGF5ID1d',
      'commandID' => '891510ac-f3e4-11e8-af5b-de00688a4901',
      'transcriptionEngine' => 'Google',
      'transcriptionEngineConfig' => [
        'enableSpeakerDiarization' => true,
        'hints' => ['string'],
        'interimResults' => true,
        'language' => GoogleTranscriptionLanguage::EN,
        'maxSpeakerCount' => 4,
        'minSpeakerCount' => 4,
        'model' => 'latest_long',
        'profanityFilter' => true,
        'speechContext' => [['boost' => 1, 'phrases' => ['string']]],
        'transcriptionEngine' => 'Google',
        'useEnhanced' => true,
      ],
      'transcriptionTracks' => 'both',
    ],
    webhookRetriesPolicies: [
      'call.hangup' => ['retriesMs' => [1000, 2000, 5000]]
    ],
    webhookURL: 'https://www.example.com/server-b/',
    webhookURLMethod: 'POST',
    webhookURLs: [
      'call.hangup' => 'https://www.example.com/webhooks/hangup',
      'call.bridge' => 'https://www.example.com/webhooks/bridge',
    ],
    webhookURLsMethod: 'POST',
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx calls dial \
  --api-key 'My API Key' \
  --connection-id 7267xxxxxxxxxxxxxx \
  --from +18005550101 \
  --to '+18005550100 or sip:[email protected];secure=srtp'

curl --request POST \
  --url https://api.telnyx.com/v2/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "+18005550100 or sip:[email protected];secure=srtp",
  "from": "+18005550101",
  "from_display_name": "Company Name",
  "connection_id": "7267xxxxxxxxxxxxxx",
  "conference_config": {
    "conference_name": "telnyx-conference",
    "start_conference_on_enter": true
  },
  "audio_url": "http://www.example.com/sounds/greeting.wav",
  "send_digits_on_answer": "wwww200",
  "timeout_secs": 60,
  "time_limit_secs": 60,
  "webhook_url": "https://www.example.com/server-b/",
  "webhook_url_method": "POST",
  "webhook_urls": {
    "call.hangup": [
      "https://www.example.com/webhooks/hangup"
    ],
    "call.bridge": [
      "https://www.example.com/webhooks/bridge"
    ]
  },
  "webhook_urls_method": "POST",
  "webhook_retries_policies": {
    "call.hangup": {
      "retries_ms": [
        1000,
        2000,
        5000
      ]
    }
  },
  "answering_machine_detection": "detect",
  "answering_machine_detection_config": {
    "total_analysis_time_millis": 5000,
    "after_greeting_silence_millis": 1000,
    "between_words_silence_millis": 1000,
    "greeting_duration_millis": 1000,
    "initial_silence_millis": 1000,
    "maximum_number_of_words": 1000,
    "maximum_word_length_millis": 2000,
    "silence_threshold": 512,
    "greeting_total_analysis_time_millis": 50000,
    "greeting_silence_duration_millis": 2000
  },
  "deepfake_detection": {
    "enabled": true,
    "timeout": 15,
    "rtp_timeout": 30
  },
  "custom_headers": [
    {
      "name": "head_1",
      "value": "val_1"
    },
    {
      "name": "head_2",
      "value": "val_2"
    }
  ],
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "link_to": "ilditnZK_eVysupV21KzmzN_sM29ygfauQojpm4BgFtfX5hXAcjotg==",
  "bridge_intent": true,
  "bridge_on_answer": true,
  "media_encryption": "SRTP",
  "sip_auth_username": "username",
  "sip_auth_password": "password",
  "sip_headers": [
    {
      "name": "User-to-User",
      "value": "12345"
    }
  ],
  "sip_transport_protocol": "TLS",
  "stream_url": "wss://www.example.com/websocket",
  "stream_track": "both_tracks",
  "send_silence_when_idle": true,
  "enable_dialogflow": false,
  "dialogflow_config": {
    "analyze_sentiment": false,
    "partial_automated_agent_reply": false
  },
  "conversation_relay_config": {
    "url": "wss://example.com/conversation-relay",
    "dtmf_detection": true,
    "greeting": "Hi! Ask me anything!",
    "voice": "Telnyx.KokoroTTS.af",
    "tts_provider": "telnyx",
    "language": "en-US",
    "interruptible": "speech",
    "interruptible_greeting": "dtmf",
    "custom_parameters": {
      "customer_id": "12345"
    }
  }
}
'