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, 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 367

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

#detection_mode ⇒ Symbol, ...

Allows you to chose between Premium and Standard detections.

Returns:



114
115
116
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 114

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) 


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

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) 


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

optional :from, String, api_name: :From

#machine_detection ⇒ Symbol, ...

Enables Answering Machine Detection.

Returns:



136
137
138
139
140
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 136

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

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


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

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) 


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

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) 


163
164
165
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 163

optional :machine_detection_speech_threshold,
Integer,
api_name: :MachineDetectionSpeechThreshold

#machine_detection_timeout ⇒ Integer?

Maximum timeout threshold in milliseconds for overall detection.

Returns:

  • (Integer, nil) 


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

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:



180
181
182
183
184
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 180

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) 


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

optional :preferred_codecs, String, api_name: :PreferredCodecs

#record ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


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

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

#recording_channels ⇒ Symbol, ...

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

Returns:



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

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) 


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

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) 


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

optional :recording_status_callback_event, String, api_name: :RecordingStatusCallbackEvent

#recording_status_callback_method ⇒ Symbol, ...

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

Returns:



226
227
228
229
230
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 226

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) 


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

optional :recording_timeout, Integer, api_name: :RecordingTimeout

#recording_track ⇒ Symbol, ...

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

Returns:



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

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) 


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

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) 


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

optional :sip_auth_password, String, api_name: :SipAuthPassword

#sip_auth_username ⇒ String?

The username to use for SIP authentication.

Returns:

  • (String, nil) 


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

optional :sip_auth_username, String, api_name: :SipAuthUsername

#sip_region ⇒ Symbol, ...

Defines the SIP region to be used for the call.

Returns:



271
272
273
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 271

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) 


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

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:



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

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:



296
297
298
299
300
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 296

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) 


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

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:



316
317
318
319
320
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 316

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

#texml ⇒ String?

Returns:

  • (String, nil) 


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

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) 


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

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) 


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

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) 


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

optional :to, String, api_name: :To

#trim ⇒ Symbol, ...

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

Returns:



354
355
356
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 354

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:



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

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 464