Class: Telnyx::Models::CallDialParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/call_dial_params.rb

Overview

See Also:

Defined Under Namespace

Modules: AnsweringMachineDetection, MediaEncryption, Privacy, Record, RecordChannels, RecordFormat, RecordTrack, RecordTrim, SipRegion, SipTransportProtocol, StreamTrack, SupervisorRole, To, WebhookURLMethod, WebhookURLsMethod Classes: AnsweringMachineDetectionConfig, ConferenceConfig, ConversationRelayConfig, DeepfakeDetection, WebhookRetriesPolicy

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(retries_ms: nil) ⇒ Object

Some parameter documentations has been truncated, see WebhookRetriesPolicy for more details.

Parameters:

  • retries_ms (Array<Integer>) (defaults to: nil) —

    Array of delays in milliseconds between retry attempts. Total sum cannot exceed




# File 'lib/telnyx/models/call_dial_params.rb', line 489

Instance Attribute Details

#answering_machine_detection ⇒ Symbol, ...

Enables Answering Machine Detection. Telnyx offers Premium and Standard detections. With Premium detection, when a call is answered, Telnyx runs real-time detection and sends a ‘call.machine.premium.detection.ended` webhook with one of the following results: `human_residence`, `human_business`, `machine`, `silence` or `fax_detected`. If we detect a beep, we also send a `call.machine.premium.greeting.ended` webhook with the result of `beep_detected`. If we detect a beep before `call.machine.premium.detection.ended` we only send `call.machine.premium.greeting.ended`, and if we detect a beep after `call.machine.premium.detection.ended`, we send both webhooks. With Standard detection, when a call is answered, Telnyx runs real-time detection to determine if it was picked up by a human or a machine and sends an `call.machine.detection.ended` webhook with the analysis result. If `greeting_end` or `detect_words` is used and a `machine` is detected, you will receive another `call.machine.greeting.ended` webhook when the answering machine greeting ends with a beep or silence. If `detect_beep` is used, you will only receive `call.machine.greeting.ended` if a beep is detected.

Returns:



60
 
# File 'lib/telnyx/models/call_dial_params.rb', line 60

optional :answering_machine_detection, enum: -> { Telnyx::CallDialParams::AnsweringMachineDetection }

#answering_machine_detection_config ⇒ Telnyx::Models::CallDialParams::AnsweringMachineDetectionConfig?

Optional configuration parameters to modify ‘answering_machine_detection’ performance. Only ‘total_analysis_time_millis` and `greeting_duration_millis` parameters are applicable when `premium` is selected as answering_machine_detection.

Returns:



69
70
 
# File 'lib/telnyx/models/call_dial_params.rb', line 69

optional :answering_machine_detection_config,
-> { Telnyx::CallDialParams::AnsweringMachineDetectionConfig }

#assistant ⇒ Telnyx::Models::CallAssistantRequest?

AI Assistant configuration. All fields except ‘id` are optional — the assistant’s stored configuration will be used as fallback for any omitted fields.

Returns:



78
 
# File 'lib/telnyx/models/call_dial_params.rb', line 78

optional :assistant, -> { Telnyx::CallAssistantRequest }

#audio_url ⇒ String?

The URL of a file to be played back to the callee when the call is answered. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request.

Returns:

  • (String, nil) 


86
 
# File 'lib/telnyx/models/call_dial_params.rb', line 86

optional :audio_url, String

#billing_group_id ⇒ String?

Use this field to set the Billing Group ID for the call. Must be a valid and existing Billing Group ID.

Returns:

  • (String, nil) 


93
 
# File 'lib/telnyx/models/call_dial_params.rb', line 93

optional :billing_group_id, String

#bridge_intent ⇒ Boolean?

Indicates the intent to bridge this call with the call specified in link_to. When bridge_intent is true, link_to becomes required and the from number will be overwritten by the from number from the linked call.

Returns:

  • (Boolean, nil) 


101
 
# File 'lib/telnyx/models/call_dial_params.rb', line 101

optional :bridge_intent, Telnyx::Internal::Type::Boolean

#bridge_on_answer ⇒ Boolean?

Whether to automatically bridge answered call to the call specified in link_to. When bridge_on_answer is true, link_to becomes required.

Returns:

  • (Boolean, nil) 


108
 
# File 'lib/telnyx/models/call_dial_params.rb', line 108

optional :bridge_on_answer, Telnyx::Internal::Type::Boolean

#client_state ⇒ String?

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

Returns:

  • (String, nil) 


115
 
# File 'lib/telnyx/models/call_dial_params.rb', line 115

optional :client_state, String

#command_id ⇒ String?

Use this field to avoid duplicate commands. Telnyx will ignore others Dial commands with the same ‘command_id`.

Returns:

  • (String, nil) 


122
 
# File 'lib/telnyx/models/call_dial_params.rb', line 122

optional :command_id, String

#conference_config ⇒ Telnyx::Models::CallDialParams::ConferenceConfig?

Optional configuration parameters to dial new participant into a conference.

Returns:



128
 
# File 'lib/telnyx/models/call_dial_params.rb', line 128

optional :conference_config, -> { Telnyx::CallDialParams::ConferenceConfig }

#connection_id ⇒ String

The ID of the Call Control App (formerly ID of the connection) to be used when dialing the destination.

Returns:

  • (String) 


15
 
# File 'lib/telnyx/models/call_dial_params.rb', line 15

required :connection_id, String

#conversation_relay_config ⇒ Telnyx::Models::CallDialParams::ConversationRelayConfig?

Starts a Conversation Relay session automatically when the answered/dialed call is answered. This embedded shape is supported on ‘answer` and `dial`. It uses public field names (`url`, `dtmf_detection`, `greeting`, `voice`, `language`, etc.) and maps them to the underlying Conversation Relay action. `client_state`, `tts_language`, and `transcription_language` inside this object are ignored; use the parent command’s ‘client_state` and `command_id` fields instead.

Returns:



139
 
# File 'lib/telnyx/models/call_dial_params.rb', line 139

optional :conversation_relay_config, -> { Telnyx::CallDialParams::ConversationRelayConfig }

#custom_headers ⇒ Array<Telnyx::Models::CustomSipHeader>?

Custom headers to be added to the SIP INVITE.

Returns:



145
 
# File 'lib/telnyx/models/call_dial_params.rb', line 145

optional :custom_headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::CustomSipHeader] }

#deepfake_detection ⇒ Telnyx::Models::CallDialParams::DeepfakeDetection?

Enables deepfake detection on the call. When enabled, audio from the remote party is streamed to a detection service that analyzes whether the voice is AI-generated. Results are delivered via the ‘call.deepfake_detection.result` webhook.

Returns:



154
 
# File 'lib/telnyx/models/call_dial_params.rb', line 154

optional :deepfake_detection, -> { Telnyx::CallDialParams::DeepfakeDetection }

#dialogflow_config ⇒ Telnyx::Models::DialogflowConfig?

Returns:



159
 
# File 'lib/telnyx/models/call_dial_params.rb', line 159

optional :dialogflow_config, -> { Telnyx::DialogflowConfig }

#enable_dialogflow ⇒ Boolean?

Enables Dialogflow for the current call. The default value is false.

Returns:

  • (Boolean, nil) 


165
 
# File 'lib/telnyx/models/call_dial_params.rb', line 165

optional :enable_dialogflow, Telnyx::Internal::Type::Boolean

#from ⇒ String

The ‘from` number to be used as the caller id presented to the destination (`to` number). The number should be in +E164 format.

Returns:

  • (String) 


22
 
# File 'lib/telnyx/models/call_dial_params.rb', line 22

required :from, String

#from_display_name ⇒ String?

The ‘from_display_name` string 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.

Returns:

  • (String, nil) 


175
 
# File 'lib/telnyx/models/call_dial_params.rb', line 175

optional :from_display_name, String

#link_to ⇒ String?

Use another call’s control id for sharing the same call session id

Returns:

  • (String, nil) 


181
 
# File 'lib/telnyx/models/call_dial_params.rb', line 181

optional :link_to, String

#media_encryption ⇒ Symbol, ...

Defines whether media should be encrypted on the call. For SIP URI destinations, media encryption can also be requested per endpoint with the ‘secure` URI parameter: `;secure=true` or `;secure=srtp` enables SRTP, and `;secure=dtls` enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes precedence over the per-endpoint `secure` value.

Returns:



191
 
# File 'lib/telnyx/models/call_dial_params.rb', line 191

optional :media_encryption, enum: -> { Telnyx::CallDialParams::MediaEncryption }

#media_name ⇒ String?

The media_name of a file to be played back to the callee when the call is answered. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file.

Returns:

  • (String, nil) 


200
 
# File 'lib/telnyx/models/call_dial_params.rb', line 200

optional :media_name, String

#park_after_unbridge ⇒ String?

If supplied with the value ‘self`, the current leg will be parked after unbridge. If not set, the default behavior is to hang up the leg. When park_after_unbridge is set, link_to becomes required.

Returns:

  • (String, nil) 


208
 
# File 'lib/telnyx/models/call_dial_params.rb', line 208

optional :park_after_unbridge, String

#preferred_codecs ⇒ String?

The list of comma-separated codecs in a preferred order for the forked media to be received.

Returns:

  • (String, nil) 


215
 
# File 'lib/telnyx/models/call_dial_params.rb', line 215

optional :preferred_codecs, String

#prevent_double_bridge ⇒ Boolean?

Prevents bridging and hangs up the call if the target is already bridged. Disabled by default.

Returns:

  • (Boolean, nil) 


222
 
# File 'lib/telnyx/models/call_dial_params.rb', line 222

optional :prevent_double_bridge, Telnyx::Internal::Type::Boolean

#privacy ⇒ Symbol, ...

Indicates the privacy level to be used for the call. When set to ‘id`, caller ID information (name and number) will be hidden from the called party. When set to `none` or omitted, caller ID will be shown normally.

Returns:



230
 
# File 'lib/telnyx/models/call_dial_params.rb', line 230

optional :privacy, enum: -> { Telnyx::CallDialParams::Privacy }

#record ⇒ Symbol, ...

Start recording automatically after an event. Disabled by default.

Returns:



236
 
# File 'lib/telnyx/models/call_dial_params.rb', line 236

optional :record, enum: -> { Telnyx::CallDialParams::Record }

#record_channels ⇒ Symbol, ...

Defines which channel should be recorded (‘single’ or ‘dual’) when ‘record` is specified.

Returns:



243
 
# File 'lib/telnyx/models/call_dial_params.rb', line 243

optional :record_channels, enum: -> { Telnyx::CallDialParams::RecordChannels }

#record_custom_file_name ⇒ String?

The custom recording file name to be used instead of the default ‘call_leg_id`. Telnyx will still add a Unix timestamp suffix.

Returns:

  • (String, nil) 


250
 
# File 'lib/telnyx/models/call_dial_params.rb', line 250

optional :record_custom_file_name, String

#record_format ⇒ Symbol, ...

Defines the format of the recording (‘wav’ or ‘mp3’) when ‘record` is specified.

Returns:



256
 
# File 'lib/telnyx/models/call_dial_params.rb', line 256

optional :record_format, enum: -> { Telnyx::CallDialParams::RecordFormat }

#record_max_length ⇒ Integer?

Defines the maximum length for the recording in seconds when ‘record` is specified. The minimum value is 0. The maximum value is 43200. The default value is 0 (infinite).

Returns:

  • (Integer, nil) 


264
 
# File 'lib/telnyx/models/call_dial_params.rb', line 264

optional :record_max_length, Integer

#record_timeout_secs ⇒ Integer?

The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected when ‘record` is specified. The timer only starts when the speech is detected. Please note that call transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite).

Returns:

  • (Integer, nil) 


274
 
# File 'lib/telnyx/models/call_dial_params.rb', line 274

optional :record_timeout_secs, Integer

#record_track ⇒ Symbol, ...

The audio track to be recorded. Can be either ‘both`, `inbound` or `outbound`. If only single track is specified (`inbound`, `outbound`), `channels` configuration is ignored and it will be recorded as mono (single channel).

Returns:



282
 
# File 'lib/telnyx/models/call_dial_params.rb', line 282

optional :record_track, enum: -> { Telnyx::CallDialParams::RecordTrack }

#record_trim ⇒ Symbol, ...

When set to ‘trim-silence`, silence will be removed from the beginning and end of the recording.

Returns:



289
 
# File 'lib/telnyx/models/call_dial_params.rb', line 289

optional :record_trim, enum: -> { Telnyx::CallDialParams::RecordTrim }

#send_digits_on_answer ⇒ String?

DTMF digits to send automatically after the called party answers. Useful for reaching an extension behind an IVR (e.g. ‘“200”` to dial extension 200 once the called party picks up). Allowed characters: `0-9`, `A-D`, `w` (0.5s pause), `W` (1s pause), `*`, `#`. Maximum 64 characters. When omitted, no automatic DTMF is sent. May also be supplied inline by appending `,<digits>` to `to` (e.g. `to=+18004247767,200`); if both forms are present, this explicit field takes precedence.

Returns:

  • (String, nil) 


301
 
# File 'lib/telnyx/models/call_dial_params.rb', line 301

optional :send_digits_on_answer, String

#send_silence_when_idle ⇒ Boolean?

Generate silence RTP packets when no transmission available.

Returns:

  • (Boolean, nil) 


307
 
# File 'lib/telnyx/models/call_dial_params.rb', line 307

optional :send_silence_when_idle, Telnyx::Internal::Type::Boolean

#sip_auth_password ⇒ String?

SIP Authentication password used for SIP challenges.

Returns:

  • (String, nil) 


313
 
# File 'lib/telnyx/models/call_dial_params.rb', line 313

optional :sip_auth_password, String

#sip_auth_username ⇒ String?

SIP Authentication username used for SIP challenges.

Returns:

  • (String, nil) 


319
 
# File 'lib/telnyx/models/call_dial_params.rb', line 319

optional :sip_auth_username, String

#sip_headers ⇒ Array<Telnyx::Models::SipHeader>?

SIP headers to be added to the SIP INVITE request. Currently only User-to-User header is supported.

Returns:



326
 
# File 'lib/telnyx/models/call_dial_params.rb', line 326

optional :sip_headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::SipHeader] }

#sip_region ⇒ Symbol, ...

Defines the SIP region to be used for the call.

Returns:



332
 
# File 'lib/telnyx/models/call_dial_params.rb', line 332

optional :sip_region, enum: -> { Telnyx::CallDialParams::SipRegion }

#sip_transport_protocol ⇒ Symbol, ...

Defines SIP transport protocol to be used on the call.

Returns:



338
 
# File 'lib/telnyx/models/call_dial_params.rb', line 338

optional :sip_transport_protocol, enum: -> { Telnyx::CallDialParams::SipTransportProtocol }

#sound_modifications ⇒ Telnyx::Models::SoundModifications?

Use this field to modify sound effects, for example adjust the pitch.

Returns:



344
 
# File 'lib/telnyx/models/call_dial_params.rb', line 344

optional :sound_modifications, -> { Telnyx::SoundModifications }

#stream_auth_token ⇒ String?

An authentication token to be sent as part of the WebSocket connection when using streaming. Maximum length is 4000 characters.

Returns:

  • (String, nil) 


351
 
# File 'lib/telnyx/models/call_dial_params.rb', line 351

optional :stream_auth_token, String

#stream_bidirectional_codec ⇒ Symbol, ...

Indicates codec for bidirectional streaming RTP payloads. Used only with stream_bidirectional_mode=rtp. Case sensitive.

Returns:



358
 
# File 'lib/telnyx/models/call_dial_params.rb', line 358

optional :stream_bidirectional_codec, enum: -> { Telnyx::StreamBidirectionalCodec }

#stream_bidirectional_mode ⇒ Symbol, ...

Configures method of bidirectional streaming (mp3, rtp).

Returns:



364
 
# File 'lib/telnyx/models/call_dial_params.rb', line 364

optional :stream_bidirectional_mode, enum: -> { Telnyx::StreamBidirectionalMode }

#stream_bidirectional_sampling_rate ⇒ Integer, ...

Audio sampling rate.

Returns:



370
 
# File 'lib/telnyx/models/call_dial_params.rb', line 370

optional :stream_bidirectional_sampling_rate, enum: -> { Telnyx::StreamBidirectionalSamplingRate }

#stream_bidirectional_target_legs ⇒ Symbol, ...

Specifies which call legs should receive the bidirectional stream audio.

Returns:



376
 
# File 'lib/telnyx/models/call_dial_params.rb', line 376

optional :stream_bidirectional_target_legs, enum: -> { Telnyx::StreamBidirectionalTargetLegs }

#stream_codec ⇒ Symbol, ...

Specifies the codec to be used for the streamed audio. When set to ‘default’ or when transcoding is not possible, the codec from the call will be used.

Returns:



383
 
# File 'lib/telnyx/models/call_dial_params.rb', line 383

optional :stream_codec, enum: -> { Telnyx::StreamCodec }

#stream_establish_before_call_originate ⇒ Boolean?

Establish websocket connection before dialing the destination. This is useful for cases where the websocket connection takes a long time to establish.

Returns:

  • (Boolean, nil) 


390
 
# File 'lib/telnyx/models/call_dial_params.rb', line 390

optional :stream_establish_before_call_originate, Telnyx::Internal::Type::Boolean

#stream_track ⇒ Symbol, ...

Specifies which track should be streamed.

Returns:



396
 
# File 'lib/telnyx/models/call_dial_params.rb', line 396

optional :stream_track, enum: -> { Telnyx::CallDialParams::StreamTrack }

#stream_url ⇒ String?

The destination WebSocket address where the stream is going to be delivered.

Returns:

  • (String, nil) 


402
 
# File 'lib/telnyx/models/call_dial_params.rb', line 402

optional :stream_url, String

#supervise_call_control_id ⇒ String?

The call leg which will be supervised by the new call.

Returns:

  • (String, nil) 


408
 
# File 'lib/telnyx/models/call_dial_params.rb', line 408

optional :supervise_call_control_id, String

#supervisor_role ⇒ Symbol, ...

The role of the supervisor call. ‘barge’ means that supervisor call hears and is being heard by both ends of the call (caller & callee). ‘whisper’ means that only supervised_call_control_id hears supervisor but supervisor can hear everything. ‘monitor’ means that nobody can hear supervisor call, but supervisor can hear everything on the call.

Returns:



418
 
# File 'lib/telnyx/models/call_dial_params.rb', line 418

optional :supervisor_role, enum: -> { Telnyx::CallDialParams::SupervisorRole }

#time_limit_secs ⇒ Integer?

Sets the maximum duration of a Call Control Leg in seconds. If the time limit is reached, the call will hangup and a ‘call.hangup` webhook with a `hangup_cause` of `time_limit` will be sent. For example, by setting a time limit of 120 seconds, a Call Leg will be automatically terminated two minutes after being answered. The default time limit is 14400 seconds or 4 hours and this is also the maximum allowed call length.

Returns:

  • (Integer, nil) 


429
 
# File 'lib/telnyx/models/call_dial_params.rb', line 429

optional :time_limit_secs, Integer

#timeout_secs ⇒ Integer?

The number of seconds that Telnyx will wait for the call to be answered by the destination to which it is being called. If the timeout is reached before an answer is received, the call will hangup and a ‘call.hangup` webhook with a `hangup_cause` of `timeout` will be sent. Minimum value is 5 seconds. Maximum value is 600 seconds.

Returns:

  • (Integer, nil) 


439
 
# File 'lib/telnyx/models/call_dial_params.rb', line 439

optional :timeout_secs, Integer

#to ⇒ String+

The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided using an array of strings. For SIP URI destinations, append ‘;secure=true` or `;secure=srtp` to enable SRTP media encryption for that endpoint, or `;secure=dtls` to enable DTLS media encryption for that endpoint. If `media_encryption` is set to `SRTP` or `DTLS`, it takes precedence over any per-endpoint `secure` URI parameter. For a single string destination, you may append a comma followed by DTMF digits (e.g. `+18004247767,200`) to play those digits as DTMF once the called party answers — equivalent to setting `send_digits_on_answer` separately. If both are present, the explicit `send_digits_on_answer` parameter takes precedence. This shorthand is not supported when `to` is an array.

Returns:

  • (String, Array<String>) 


38
 
# File 'lib/telnyx/models/call_dial_params.rb', line 38

required :to, union: -> { Telnyx::CallDialParams::To }

#transcription ⇒ Boolean?

Enable transcription upon call answer. The default value is false.

Returns:

  • (Boolean, nil) 


445
 
# File 'lib/telnyx/models/call_dial_params.rb', line 445

optional :transcription, Telnyx::Internal::Type::Boolean

#transcription_config ⇒ Telnyx::Models::Calls::TranscriptionStartRequest?

Returns:



450
 
# File 'lib/telnyx/models/call_dial_params.rb', line 450

optional :transcription_config, -> { Telnyx::Calls::TranscriptionStartRequest }

#webhook_retries_policies ⇒ Hash{Symbol=>Telnyx::Models::CallDialParams::WebhookRetriesPolicy}?

A map of event types to retry policies. Each retry policy contains an array of ‘retries_ms` specifying the delays between retry attempts in milliseconds. Maximum 5 retries, total delay cannot exceed 60 seconds.

Returns:



458
459
 
# File 'lib/telnyx/models/call_dial_params.rb', line 458

optional :webhook_retries_policies,
-> { Telnyx::Internal::Type::HashOf[Telnyx::CallDialParams::WebhookRetriesPolicy] }

#webhook_url ⇒ String?

Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call.

Returns:

  • (String, nil) 


466
 
# File 'lib/telnyx/models/call_dial_params.rb', line 466

optional :webhook_url, String

#webhook_url_method ⇒ Symbol, ...

HTTP request type used for ‘webhook_url`.

Returns:



472
 
# File 'lib/telnyx/models/call_dial_params.rb', line 472

optional :webhook_url_method, enum: -> { Telnyx::CallDialParams::WebhookURLMethod }

#webhook_urls ⇒ Hash{Symbol=>String}?

A map of event types to webhook URLs. When an event of the specified type occurs, the webhook URL associated with that event type will be called instead of the default webhook URL. Events not mapped here will use the default webhook URL.

Returns:

  • (Hash{Symbol=>String}, nil) 


481
 
# File 'lib/telnyx/models/call_dial_params.rb', line 481

optional :webhook_urls, Telnyx::Internal::Type::HashOf[String]

#webhook_urls_method ⇒ Symbol, ...

HTTP request method to invoke ‘webhook_urls`.

Returns:



487
 
# File 'lib/telnyx/models/call_dial_params.rb', line 487

optional :webhook_urls_method, enum: -> { Telnyx::CallDialParams::WebhookURLsMethod }