Class: Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/texml/accounts/call_calls_params.rb

Defined Under Namespace

Modules: AsyncAmdStatusCallbackMethod, DeepfakeDetection, DeepfakeDetectionCallbackMethod, DetectionMode, MachineDetection, MediaEncryption, RecordingChannels, RecordingStatusCallbackMethod, RecordingTrack, SipRegion, StatusCallbackEvent, StatusCallbackMethod, SupervisingRole, Trim, URLMethod Classes: CustomHeader

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(name:, value:) ⇒ Object

Parameters:

  • name (String) —

    The name of the custom header

  • value (String) —

    The value of the custom header




# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 407

Instance Attribute Details

#application_sid ⇒ String?

The ID of the TeXML Application.

Returns:

  • (String, nil) 


47
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 47

optional :application_sid, String, api_name: :ApplicationSid

#async_amd ⇒ Boolean?

Select whether to perform answering machine detection in the background. By default execution is blocked until Answering Machine Detection is completed.

Returns:

  • (Boolean, nil) 


54
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 54

optional :async_amd, Telnyx::Internal::Type::Boolean, api_name: :AsyncAmd

#async_amd_status_callback ⇒ String?

URL destination for Telnyx to send AMD callback events to for the call.

Returns:

  • (String, nil) 


60
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 60

optional :async_amd_status_callback, String, api_name: :AsyncAmdStatusCallback

#async_amd_status_callback_method ⇒ Symbol, ...

HTTP request type used for ‘AsyncAmdStatusCallback`. The default value is inherited from TeXML Application setting.

Returns:



67
68
69
70
71
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 67

optional :async_amd_status_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::AsyncAmdStatusCallbackMethod
},
api_name: :AsyncAmdStatusCallbackMethod

#caller_id ⇒ 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) 


80
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 80

optional :caller_id, String, api_name: :CallerId

#cancel_playback_on_detect_message_end ⇒ Boolean?

Whether to cancel ongoing playback on ‘greeting ended` detection. Defaults to `true`.

Returns:

  • (Boolean, nil) 


87
88
89
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 87

optional :cancel_playback_on_detect_message_end,
Telnyx::Internal::Type::Boolean,
api_name: :CancelPlaybackOnDetectMessageEnd

#cancel_playback_on_machine_detection ⇒ Boolean?

Whether to cancel ongoing playback on ‘machine` detection. Defaults to `true`.

Returns:

  • (Boolean, nil) 


95
96
97
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 95

optional :cancel_playback_on_machine_detection,
Telnyx::Internal::Type::Boolean,
api_name: :CancelPlaybackOnMachineDetection

#custom_headers ⇒ Array<Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::CustomHeader>?

Custom HTTP headers to be sent with the call. Each header should be an object with ‘name’ and ‘value’ properties.

Returns:



104
105
106
107
108
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 104

optional :custom_headers,
-> {
  Telnyx::Internal::Type::ArrayOf[Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::CustomHeader]
},
api_name: :CustomHeaders

#deepfake_detection ⇒ Symbol, ...

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.

Returns:



116
117
118
119
120
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 116

optional :deepfake_detection,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetection
},
api_name: :DeepfakeDetection

#deepfake_detection_callback_method ⇒ Symbol, ...

HTTP request type used for ‘DeepfakeDetectionCallbackUrl`.

Returns:



126
127
128
129
130
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 126

optional :deepfake_detection_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetectionCallbackMethod
},
api_name: :DeepfakeDetectionCallbackMethod

#deepfake_detection_callback_url ⇒ String?

URL destination for Telnyx to send deepfake detection callback events to for the call.

Returns:

  • (String, nil) 


137
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 137

optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl

#detection_mode ⇒ Symbol, ...

Allows you to choose between Regular, Premium, and PremiumCallScreening detections. See developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection

Returns:



145
146
147
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 145

optional :detection_mode,
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode },
api_name: :DetectionMode

#fallback_url ⇒ String?

A failover URL for which Telnyx will retrieve the TeXML call instructions if the ‘Url` is not responding.

Returns:

  • (String, nil) 


154
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 154

optional :fallback_url, String, api_name: :FallbackUrl

#from ⇒ String?

The phone number of the party that initiated the call. Phone numbers are formatted with a ‘+` and country code.

Returns:

  • (String, nil) 


161
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 161

optional :from, String, api_name: :From

#machine_detection ⇒ Symbol, ...

Enables Answering Machine Detection.

Returns:



167
168
169
170
171
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 167

optional :machine_detection,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::MachineDetection
},
api_name: :MachineDetection

#machine_detection_prompt_end_timeout ⇒ Integer?

Silence duration threshold after a call screening prompt before ending prompt detection, in milliseconds. Used when ‘DetectionMode` is `PremiumCallScreening`.

Returns:

  • (Integer, nil) 


178
179
180
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 178

optional :machine_detection_prompt_end_timeout,
Integer,
api_name: :MachineDetectionPromptEndTimeout

#machine_detection_silence_timeout ⇒ Integer?

If initial silence duration is greater than this value, consider it a machine. Ignored when ‘premium` detection is used.

Returns:

  • (Integer, nil) 


187
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 187

optional :machine_detection_silence_timeout, Integer, api_name: :MachineDetectionSilenceTimeout

#machine_detection_speech_end_threshold ⇒ Integer?

Silence duration threshold after a greeting message or voice for it be considered human. Ignored when ‘premium` detection is used.

Returns:

  • (Integer, nil) 


194
195
196
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 194

optional :machine_detection_speech_end_threshold,
Integer,
api_name: :MachineDetectionSpeechEndThreshold

#machine_detection_speech_threshold ⇒ Integer?

Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when ‘premium` detection is used.

Returns:

  • (Integer, nil) 


203
204
205
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 203

optional :machine_detection_speech_threshold,
Integer,
api_name: :MachineDetectionSpeechThreshold

#machine_detection_timeout ⇒ Integer?

Maximum timeout threshold in milliseconds for overall detection.

Returns:

  • (Integer, nil) 


211
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 211

optional :machine_detection_timeout, Integer, api_name: :MachineDetectionTimeout

#media_encryption ⇒ Symbol, ...

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.

Returns:



220
221
222
223
224
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 220

optional :media_encryption,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::MediaEncryption
},
api_name: :MediaEncryption

#preferred_codecs ⇒ String?

The list of comma-separated codecs to be offered on a call.

Returns:

  • (String, nil) 


230
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 230

optional :preferred_codecs, String, api_name: :PreferredCodecs

#record ⇒ Boolean?

Whether to record the entire participant’s call leg. Defaults to ‘false`.

Returns:

  • (Boolean, nil) 


236
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 236

optional :record, Telnyx::Internal::Type::Boolean, api_name: :Record

#recording_channels ⇒ Symbol, ...

The number of channels in the final recording. Defaults to ‘mono`.

Returns:



242
243
244
245
246
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 242

optional :recording_channels,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingChannels
},
api_name: :RecordingChannels

#recording_status_callback ⇒ String?

The URL the recording callbacks will be sent to.

Returns:

  • (String, nil) 


252
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 252

optional :recording_status_callback, String, api_name: :RecordingStatusCallback

#recording_status_callback_event ⇒ String?

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

Returns:

  • (String, nil) 


260
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 260

optional :recording_status_callback_event, String, api_name: :RecordingStatusCallbackEvent

#recording_status_callback_method ⇒ Symbol, ...

HTTP request type used for ‘RecordingStatusCallback`. Defaults to `POST`.

Returns:



266
267
268
269
270
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 266

optional :recording_status_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingStatusCallbackMethod
},
api_name: :RecordingStatusCallbackMethod

#recording_timeout ⇒ Integer?

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)

Returns:

  • (Integer, nil) 


279
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 279

optional :recording_timeout, Integer, api_name: :RecordingTimeout

#recording_track ⇒ Symbol, ...

The audio track to record for the call. The default is ‘both`.

Returns:



285
286
287
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 285

optional :recording_track,
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingTrack },
api_name: :RecordingTrack

#send_recording_url ⇒ Boolean?

Whether to send RecordingUrl in webhooks.

Returns:

  • (Boolean, nil) 


293
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 293

optional :send_recording_url, Telnyx::Internal::Type::Boolean, api_name: :SendRecordingUrl

#sip_auth_password ⇒ String?

The password to use for SIP authentication.

Returns:

  • (String, nil) 


299
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 299

optional :sip_auth_password, String, api_name: :SipAuthPassword

#sip_auth_username ⇒ String?

The username to use for SIP authentication.

Returns:

  • (String, nil) 


305
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 305

optional :sip_auth_username, String, api_name: :SipAuthUsername

#sip_region ⇒ Symbol, ...

Defines the SIP region to be used for the call.

Returns:



311
312
313
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 311

optional :sip_region,
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::SipRegion },
api_name: :SipRegion

#status_callback ⇒ String?

URL destination for Telnyx to send status callback events to for the call.

Returns:

  • (String, nil) 


319
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 319

optional :status_callback, String, api_name: :StatusCallback

#status_callback_event ⇒ Symbol, ...

The call events for which Telnyx should send a webhook. Multiple events can be defined when separated by a space.

Returns:



326
327
328
329
330
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 326

optional :status_callback_event,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::StatusCallbackEvent
},
api_name: :StatusCallbackEvent

#status_callback_method ⇒ Symbol, ...

HTTP request type used for ‘StatusCallback`.

Returns:



336
337
338
339
340
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 336

optional :status_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::StatusCallbackMethod
},
api_name: :StatusCallbackMethod

#supervise_call_sid ⇒ String?

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.

Returns:

  • (String, nil) 


348
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 348

optional :supervise_call_sid, String, api_name: :SuperviseCallSid

#supervising_role ⇒ Symbol, ...

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

Returns:



356
357
358
359
360
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 356

optional :supervising_role,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::SupervisingRole
},
api_name: :SupervisingRole

#texml ⇒ String?

Returns:

  • (String, nil) 


365
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 365

optional :texml, String, api_name: :Texml, nil?: true

#time_limit ⇒ Integer?

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.

Returns:

  • (Integer, nil) 


372
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 372

optional :time_limit, Integer, api_name: :TimeLimit

#timeout ⇒ Integer?

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.

Returns:

  • (Integer, nil) 


380
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 380

optional :timeout, Integer, api_name: :Timeout

#to ⇒ String?

The phone number of the called party. Phone numbers are formatted with a ‘+` and country code.

Returns:

  • (String, nil) 


387
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 387

optional :to, String, api_name: :To

#trim ⇒ Symbol, ...

Whether to trim any leading and trailing silence from the recording. Defaults to ‘trim-silence`.

Returns:



394
395
396
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 394

optional :trim,
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::Trim },
api_name: :Trim

#url ⇒ String

The URL from which Telnyx will retrieve the TeXML call instructions.

Returns:

  • (String) 


41
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 41

required :url, String, api_name: :Url

#url_method ⇒ Symbol, ...

HTTP request type used for ‘Url`. The default value is inherited from TeXML Application setting.

Returns:



403
404
405
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 403

optional :url_method,
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::URLMethod },
api_name: :UrlMethod

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 512