telnyx 5.70.0 → 5.71.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/assistant.rb +6 -149
- data/lib/telnyx/models/book_appointment_tool.rb +31 -0
- data/lib/telnyx/models/book_appointment_tool_params.rb +51 -0
- data/lib/telnyx/models/call_assistant_request.rb +176 -0
- data/lib/telnyx/models/call_control_bucket_ids.rb +23 -0
- data/lib/telnyx/models/call_control_retrieval_tool.rb +31 -0
- data/lib/telnyx/models/call_dial_params.rb +11 -1
- data/lib/telnyx/models/calls/action_answer_params.rb +11 -1
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +6 -39
- data/lib/telnyx/models/check_availability_tool.rb +31 -0
- data/lib/telnyx/models/check_availability_tool_params.rb +31 -0
- data/lib/telnyx/models/pronunciation_dict_alias_item.rb +51 -0
- data/lib/telnyx/models/pronunciation_dict_create_params.rb +5 -93
- data/lib/telnyx/models/pronunciation_dict_create_response.rb +3 -191
- data/lib/telnyx/models/pronunciation_dict_data.rb +101 -0
- data/lib/telnyx/models/pronunciation_dict_phoneme_item.rb +71 -0
- data/lib/telnyx/models/pronunciation_dict_retrieve_response.rb +3 -191
- data/lib/telnyx/models/pronunciation_dict_update_params.rb +5 -93
- data/lib/telnyx/models/pronunciation_dict_update_response.rb +3 -191
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +203 -191
- data/lib/telnyx/models/voice_clone_create_from_design_params.rb +3 -3
- data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +61 -54
- data/lib/telnyx/models/voice_clone_create_params.rb +28 -28
- data/lib/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_params.rb +26 -0
- data/lib/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_response.rb +54 -0
- data/lib/telnyx/models.rb +20 -0
- data/lib/telnyx/resources/calls/actions.rb +4 -2
- data/lib/telnyx/resources/calls.rb +3 -1
- data/lib/telnyx/resources/pronunciation_dicts.rb +4 -4
- data/lib/telnyx/resources/texml/accounts/calls.rb +3 -3
- data/lib/telnyx/resources/voice_clones.rb +6 -6
- data/lib/telnyx/resources/whatsapp/phone_numbers/profile/photo.rb +20 -0
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +12 -1
- data/rbi/telnyx/models/ai/assistant.rbi +15 -329
- data/rbi/telnyx/models/book_appointment_tool.rbi +65 -0
- data/rbi/telnyx/models/book_appointment_tool_params.rbi +83 -0
- data/rbi/telnyx/models/call_assistant_request.rbi +322 -0
- data/rbi/telnyx/models/call_control_bucket_ids.rbi +42 -0
- data/rbi/telnyx/models/call_control_retrieval_tool.rbi +63 -0
- data/rbi/telnyx/models/call_dial_params.rbi +15 -0
- data/rbi/telnyx/models/calls/action_answer_params.rbi +15 -0
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +10 -77
- data/rbi/telnyx/models/check_availability_tool.rbi +67 -0
- data/rbi/telnyx/models/check_availability_tool_params.rbi +45 -0
- data/rbi/telnyx/models/pronunciation_dict_alias_item.rbi +79 -0
- data/rbi/telnyx/models/pronunciation_dict_create_params.rbi +8 -154
- data/rbi/telnyx/models/pronunciation_dict_create_response.rbi +6 -366
- data/rbi/telnyx/models/pronunciation_dict_data.rbi +186 -0
- data/rbi/telnyx/models/pronunciation_dict_phoneme_item.rbi +117 -0
- data/rbi/telnyx/models/pronunciation_dict_retrieve_response.rbi +6 -366
- data/rbi/telnyx/models/pronunciation_dict_update_params.rbi +10 -156
- data/rbi/telnyx/models/pronunciation_dict_update_response.rbi +6 -366
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +391 -403
- data/rbi/telnyx/models/voice_clone_create_from_design_params.rbi +10 -10
- data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +94 -92
- data/rbi/telnyx/models/voice_clone_create_params.rbi +53 -53
- data/rbi/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_params.rbi +47 -0
- data/rbi/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_response.rbi +118 -0
- data/rbi/telnyx/models.rbi +20 -0
- data/rbi/telnyx/resources/calls/actions.rbi +9 -3
- data/rbi/telnyx/resources/calls.rbi +5 -0
- data/rbi/telnyx/resources/pronunciation_dicts.rbi +5 -7
- data/rbi/telnyx/resources/texml/accounts/calls.rbi +5 -5
- data/rbi/telnyx/resources/voice_clones.rbi +9 -9
- data/rbi/telnyx/resources/whatsapp/phone_numbers/profile/photo.rbi +16 -0
- data/sig/telnyx/models/ai/assistant.rbs +3 -142
- data/sig/telnyx/models/book_appointment_tool.rbs +35 -0
- data/sig/telnyx/models/book_appointment_tool_params.rbs +39 -0
- data/sig/telnyx/models/call_assistant_request.rbs +132 -0
- data/sig/telnyx/models/call_control_bucket_ids.rbs +21 -0
- data/sig/telnyx/models/call_control_retrieval_tool.rbs +35 -0
- data/sig/telnyx/models/call_dial_params.rbs +9 -0
- data/sig/telnyx/models/calls/action_answer_params.rbs +9 -0
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +6 -35
- data/sig/telnyx/models/check_availability_tool.rbs +35 -0
- data/sig/telnyx/models/check_availability_tool_params.rbs +16 -0
- data/sig/telnyx/models/pronunciation_dict_alias_item.rbs +40 -0
- data/sig/telnyx/models/pronunciation_dict_create_params.rbs +2 -58
- data/sig/telnyx/models/pronunciation_dict_create_response.rbs +6 -155
- data/sig/telnyx/models/pronunciation_dict_data.rbs +88 -0
- data/sig/telnyx/models/pronunciation_dict_phoneme_item.rbs +55 -0
- data/sig/telnyx/models/pronunciation_dict_retrieve_response.rbs +6 -155
- data/sig/telnyx/models/pronunciation_dict_update_params.rbs +2 -58
- data/sig/telnyx/models/pronunciation_dict_update_response.rbs +6 -155
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +317 -325
- data/sig/telnyx/models/voice_clone_create_from_design_params.rbs +7 -7
- data/sig/telnyx/models/voice_clone_create_from_upload_params.rbs +63 -61
- data/sig/telnyx/models/voice_clone_create_params.rbs +35 -35
- data/sig/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_params.rbs +30 -0
- data/sig/telnyx/models/whatsapp/phone_numbers/profile/photo_retrieve_response.rbs +63 -0
- data/sig/telnyx/models.rbs +20 -0
- data/sig/telnyx/resources/calls/actions.rbs +2 -1
- data/sig/telnyx/resources/calls.rbs +1 -0
- data/sig/telnyx/resources/pronunciation_dicts.rbs +1 -1
- data/sig/telnyx/resources/texml/accounts/calls.rbs +1 -1
- data/sig/telnyx/resources/voice_clones.rbs +2 -2
- data/sig/telnyx/resources/whatsapp/phone_numbers/profile/photo.rbs +5 -0
- metadata +38 -5
- data/lib/telnyx/models/pronunciation_dict_list_response.rb +0 -190
- data/rbi/telnyx/models/pronunciation_dict_list_response.rbi +0 -353
- data/sig/telnyx/models/pronunciation_dict_list_response.rbs +0 -144
|
@@ -14,24 +14,24 @@ module Telnyx
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :account_sid, String
|
|
16
16
|
|
|
17
|
-
# @!attribute
|
|
17
|
+
# @!attribute params
|
|
18
18
|
#
|
|
19
|
-
# @return [Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
20
|
-
required :
|
|
19
|
+
# @return [Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault]
|
|
20
|
+
required :params, union: -> { Telnyx::Texml::Accounts::CallCallsParams::Params }
|
|
21
21
|
|
|
22
|
-
# @!method initialize(account_sid:,
|
|
22
|
+
# @!method initialize(account_sid:, params:, request_options: {})
|
|
23
23
|
# @param account_sid [String]
|
|
24
|
-
# @param
|
|
24
|
+
# @param params [Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault]
|
|
25
25
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
26
26
|
|
|
27
|
-
module
|
|
27
|
+
module Params
|
|
28
28
|
extend Telnyx::Internal::Type::Union
|
|
29
29
|
|
|
30
|
-
variant -> { Telnyx::Texml::Accounts::CallCallsParams::
|
|
30
|
+
variant -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL }
|
|
31
31
|
|
|
32
|
-
variant -> { Telnyx::Texml::Accounts::CallCallsParams::
|
|
32
|
+
variant -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml }
|
|
33
33
|
|
|
34
|
-
variant -> { Telnyx::Texml::Accounts::CallCallsParams::
|
|
34
|
+
variant -> { Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault }
|
|
35
35
|
|
|
36
36
|
class WithURL < Telnyx::Internal::Type::BaseModel
|
|
37
37
|
# @!attribute url
|
|
@@ -63,10 +63,10 @@ module Telnyx
|
|
|
63
63
|
# HTTP request type used for `AsyncAmdStatusCallback`. The default value is
|
|
64
64
|
# inherited from TeXML Application setting.
|
|
65
65
|
#
|
|
66
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
66
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::AsyncAmdStatusCallbackMethod, nil]
|
|
67
67
|
optional :async_amd_status_callback_method,
|
|
68
68
|
enum: -> {
|
|
69
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
69
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::AsyncAmdStatusCallbackMethod
|
|
70
70
|
},
|
|
71
71
|
api_name: :AsyncAmdStatusCallbackMethod
|
|
72
72
|
|
|
@@ -100,19 +100,19 @@ module Telnyx
|
|
|
100
100
|
# Custom HTTP headers to be sent with the call. Each header should be an object
|
|
101
101
|
# with 'name' and 'value' properties.
|
|
102
102
|
#
|
|
103
|
-
# @return [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
103
|
+
# @return [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::CustomHeader>, nil]
|
|
104
104
|
optional :custom_headers,
|
|
105
105
|
-> {
|
|
106
|
-
Telnyx::Internal::Type::ArrayOf[Telnyx::Texml::Accounts::CallCallsParams::
|
|
106
|
+
Telnyx::Internal::Type::ArrayOf[Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::CustomHeader]
|
|
107
107
|
},
|
|
108
108
|
api_name: :CustomHeaders
|
|
109
109
|
|
|
110
110
|
# @!attribute detection_mode
|
|
111
111
|
# Allows you to chose between Premium and Standard detections.
|
|
112
112
|
#
|
|
113
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
113
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode, nil]
|
|
114
114
|
optional :detection_mode,
|
|
115
|
-
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::
|
|
115
|
+
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode },
|
|
116
116
|
api_name: :DetectionMode
|
|
117
117
|
|
|
118
118
|
# @!attribute fallback_url
|
|
@@ -132,9 +132,11 @@ module Telnyx
|
|
|
132
132
|
# @!attribute machine_detection
|
|
133
133
|
# Enables Answering Machine Detection.
|
|
134
134
|
#
|
|
135
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
135
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::MachineDetection, nil]
|
|
136
136
|
optional :machine_detection,
|
|
137
|
-
enum: -> {
|
|
137
|
+
enum: -> {
|
|
138
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::MachineDetection
|
|
139
|
+
},
|
|
138
140
|
api_name: :MachineDetection
|
|
139
141
|
|
|
140
142
|
# @!attribute machine_detection_silence_timeout
|
|
@@ -174,9 +176,11 @@ module Telnyx
|
|
|
174
176
|
# to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
|
|
175
177
|
# destinations.
|
|
176
178
|
#
|
|
177
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
179
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::MediaEncryption, nil]
|
|
178
180
|
optional :media_encryption,
|
|
179
|
-
enum: -> {
|
|
181
|
+
enum: -> {
|
|
182
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::MediaEncryption
|
|
183
|
+
},
|
|
180
184
|
api_name: :MediaEncryption
|
|
181
185
|
|
|
182
186
|
# @!attribute preferred_codecs
|
|
@@ -194,10 +198,10 @@ module Telnyx
|
|
|
194
198
|
# @!attribute recording_channels
|
|
195
199
|
# The number of channels in the final recording. Defaults to `mono`.
|
|
196
200
|
#
|
|
197
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
201
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingChannels, nil]
|
|
198
202
|
optional :recording_channels,
|
|
199
203
|
enum: -> {
|
|
200
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
204
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingChannels
|
|
201
205
|
},
|
|
202
206
|
api_name: :RecordingChannels
|
|
203
207
|
|
|
@@ -218,10 +222,10 @@ module Telnyx
|
|
|
218
222
|
# @!attribute recording_status_callback_method
|
|
219
223
|
# HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
|
|
220
224
|
#
|
|
221
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
225
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingStatusCallbackMethod, nil]
|
|
222
226
|
optional :recording_status_callback_method,
|
|
223
227
|
enum: -> {
|
|
224
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
228
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingStatusCallbackMethod
|
|
225
229
|
},
|
|
226
230
|
api_name: :RecordingStatusCallbackMethod
|
|
227
231
|
|
|
@@ -237,9 +241,9 @@ module Telnyx
|
|
|
237
241
|
# @!attribute recording_track
|
|
238
242
|
# The audio track to record for the call. The default is `both`.
|
|
239
243
|
#
|
|
240
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
244
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingTrack, nil]
|
|
241
245
|
optional :recording_track,
|
|
242
|
-
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::
|
|
246
|
+
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingTrack },
|
|
243
247
|
api_name: :RecordingTrack
|
|
244
248
|
|
|
245
249
|
# @!attribute send_recording_url
|
|
@@ -263,9 +267,9 @@ module Telnyx
|
|
|
263
267
|
# @!attribute sip_region
|
|
264
268
|
# Defines the SIP region to be used for the call.
|
|
265
269
|
#
|
|
266
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
270
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::SipRegion, nil]
|
|
267
271
|
optional :sip_region,
|
|
268
|
-
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::
|
|
272
|
+
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::SipRegion },
|
|
269
273
|
api_name: :SipRegion
|
|
270
274
|
|
|
271
275
|
# @!attribute status_callback
|
|
@@ -278,20 +282,20 @@ module Telnyx
|
|
|
278
282
|
# The call events for which Telnyx should send a webhook. Multiple events can be
|
|
279
283
|
# defined when separated by a space.
|
|
280
284
|
#
|
|
281
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
285
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::StatusCallbackEvent, nil]
|
|
282
286
|
optional :status_callback_event,
|
|
283
287
|
enum: -> {
|
|
284
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
288
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::StatusCallbackEvent
|
|
285
289
|
},
|
|
286
290
|
api_name: :StatusCallbackEvent
|
|
287
291
|
|
|
288
292
|
# @!attribute status_callback_method
|
|
289
293
|
# HTTP request type used for `StatusCallback`.
|
|
290
294
|
#
|
|
291
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
295
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::StatusCallbackMethod, nil]
|
|
292
296
|
optional :status_callback_method,
|
|
293
297
|
enum: -> {
|
|
294
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
298
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::StatusCallbackMethod
|
|
295
299
|
},
|
|
296
300
|
api_name: :StatusCallbackMethod
|
|
297
301
|
|
|
@@ -308,15 +312,17 @@ module Telnyx
|
|
|
308
312
|
# both sides), whisper (only hear supervisor), monitor (hear both sides but
|
|
309
313
|
# supervisor muted). Default: barge
|
|
310
314
|
#
|
|
311
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
315
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::SupervisingRole, nil]
|
|
312
316
|
optional :supervising_role,
|
|
313
|
-
enum: -> {
|
|
317
|
+
enum: -> {
|
|
318
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::SupervisingRole
|
|
319
|
+
},
|
|
314
320
|
api_name: :SupervisingRole
|
|
315
321
|
|
|
316
322
|
# @!attribute texml
|
|
317
323
|
#
|
|
318
|
-
# @return [
|
|
319
|
-
optional :texml,
|
|
324
|
+
# @return [String, nil]
|
|
325
|
+
optional :texml, String, api_name: :Texml, nil?: true
|
|
320
326
|
|
|
321
327
|
# @!attribute time_limit
|
|
322
328
|
# The maximum duration of the call in seconds. The minimum value is 30 and the
|
|
@@ -344,23 +350,23 @@ module Telnyx
|
|
|
344
350
|
# Whether to trim any leading and trailing silence from the recording. Defaults to
|
|
345
351
|
# `trim-silence`.
|
|
346
352
|
#
|
|
347
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
353
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::Trim, nil]
|
|
348
354
|
optional :trim,
|
|
349
|
-
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::
|
|
355
|
+
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::Trim },
|
|
350
356
|
api_name: :Trim
|
|
351
357
|
|
|
352
358
|
# @!attribute url_method
|
|
353
359
|
# HTTP request type used for `Url`. The default value is inherited from TeXML
|
|
354
360
|
# Application setting.
|
|
355
361
|
#
|
|
356
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
362
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::URLMethod, nil]
|
|
357
363
|
optional :url_method,
|
|
358
|
-
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::
|
|
364
|
+
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::URLMethod },
|
|
359
365
|
api_name: :UrlMethod
|
|
360
366
|
|
|
361
367
|
# @!method initialize(url:, application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, texml: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url_method: nil)
|
|
362
368
|
# Some parameter documentations has been truncated, see
|
|
363
|
-
# {Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
369
|
+
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL} for more
|
|
364
370
|
# details.
|
|
365
371
|
#
|
|
366
372
|
# @param url [String] The URL from which Telnyx will retrieve the TeXML call instructions.
|
|
@@ -371,7 +377,7 @@ module Telnyx
|
|
|
371
377
|
#
|
|
372
378
|
# @param async_amd_status_callback [String] URL destination for Telnyx to send AMD callback events to for the call.
|
|
373
379
|
#
|
|
374
|
-
# @param async_amd_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
380
|
+
# @param async_amd_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::AsyncAmdStatusCallbackMethod] HTTP request type used for `AsyncAmdStatusCallback`. The default value is inheri
|
|
375
381
|
#
|
|
376
382
|
# @param caller_id [String] To be used as the caller id name (SIP From Display Name) presented to the destin
|
|
377
383
|
#
|
|
@@ -379,15 +385,15 @@ module Telnyx
|
|
|
379
385
|
#
|
|
380
386
|
# @param cancel_playback_on_machine_detection [Boolean] Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
|
|
381
387
|
#
|
|
382
|
-
# @param custom_headers [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
388
|
+
# @param 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 wi
|
|
383
389
|
#
|
|
384
|
-
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
390
|
+
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode] Allows you to chose between Premium and Standard detections.
|
|
385
391
|
#
|
|
386
392
|
# @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
|
|
387
393
|
#
|
|
388
394
|
# @param from [String] The phone number of the party that initiated the call. Phone numbers are formatt
|
|
389
395
|
#
|
|
390
|
-
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
396
|
+
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::MachineDetection] Enables Answering Machine Detection.
|
|
391
397
|
#
|
|
392
398
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
393
399
|
#
|
|
@@ -397,23 +403,23 @@ module Telnyx
|
|
|
397
403
|
#
|
|
398
404
|
# @param machine_detection_timeout [Integer] Maximum timeout threshold in milliseconds for overall detection.
|
|
399
405
|
#
|
|
400
|
-
# @param media_encryption [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
406
|
+
# @param media_encryption [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::MediaEncryption] Defines whether media should be encrypted on the call. When set to `SRTP`, the c
|
|
401
407
|
#
|
|
402
408
|
# @param preferred_codecs [String] The list of comma-separated codecs to be offered on a call.
|
|
403
409
|
#
|
|
404
410
|
# @param record [Boolean] Whether to record the entire participant's call leg. Defaults to `false`.
|
|
405
411
|
#
|
|
406
|
-
# @param recording_channels [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
412
|
+
# @param recording_channels [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingChannels] The number of channels in the final recording. Defaults to `mono`.
|
|
407
413
|
#
|
|
408
414
|
# @param recording_status_callback [String] The URL the recording callbacks will be sent to.
|
|
409
415
|
#
|
|
410
416
|
# @param recording_status_callback_event [String] The changes to the recording's state that should generate a call to `RecoridngSt
|
|
411
417
|
#
|
|
412
|
-
# @param recording_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
418
|
+
# @param recording_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingStatusCallbackMethod] HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
|
|
413
419
|
#
|
|
414
420
|
# @param recording_timeout [Integer] The number of seconds that Telnyx will wait for the recording to be stopped if s
|
|
415
421
|
#
|
|
416
|
-
# @param recording_track [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
422
|
+
# @param recording_track [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::RecordingTrack] The audio track to record for the call. The default is `both`.
|
|
417
423
|
#
|
|
418
424
|
# @param send_recording_url [Boolean] Whether to send RecordingUrl in webhooks.
|
|
419
425
|
#
|
|
@@ -421,19 +427,19 @@ module Telnyx
|
|
|
421
427
|
#
|
|
422
428
|
# @param sip_auth_username [String] The username to use for SIP authentication.
|
|
423
429
|
#
|
|
424
|
-
# @param sip_region [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
430
|
+
# @param sip_region [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::SipRegion] Defines the SIP region to be used for the call.
|
|
425
431
|
#
|
|
426
432
|
# @param status_callback [String] URL destination for Telnyx to send status callback events to for the call.
|
|
427
433
|
#
|
|
428
|
-
# @param status_callback_event [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
434
|
+
# @param status_callback_event [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::StatusCallbackEvent] The call events for which Telnyx should send a webhook. Multiple events can be d
|
|
429
435
|
#
|
|
430
|
-
# @param status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
436
|
+
# @param status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::StatusCallbackMethod] HTTP request type used for `StatusCallback`.
|
|
431
437
|
#
|
|
432
438
|
# @param supervise_call_sid [String] The call control ID of the existing call to supervise. When provided, the create
|
|
433
439
|
#
|
|
434
|
-
# @param supervising_role [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
440
|
+
# @param supervising_role [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::SupervisingRole] The supervising role for the new leg. Determines the audio behavior: barge (hear
|
|
435
441
|
#
|
|
436
|
-
# @param texml [
|
|
442
|
+
# @param texml [String, nil]
|
|
437
443
|
#
|
|
438
444
|
# @param time_limit [Integer] The maximum duration of the call in seconds. The minimum value is 30 and the max
|
|
439
445
|
#
|
|
@@ -441,14 +447,14 @@ module Telnyx
|
|
|
441
447
|
#
|
|
442
448
|
# @param to [String] The phone number of the called party. Phone numbers are formatted with a `+` and
|
|
443
449
|
#
|
|
444
|
-
# @param trim [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
450
|
+
# @param trim [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::Trim] Whether to trim any leading and trailing silence from the recording. Defaults to
|
|
445
451
|
#
|
|
446
|
-
# @param url_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
452
|
+
# @param url_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::URLMethod] HTTP request type used for `Url`. The default value is inherited from TeXML Appl
|
|
447
453
|
|
|
448
454
|
# HTTP request type used for `AsyncAmdStatusCallback`. The default value is
|
|
449
455
|
# inherited from TeXML Application setting.
|
|
450
456
|
#
|
|
451
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
457
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#async_amd_status_callback_method
|
|
452
458
|
module AsyncAmdStatusCallbackMethod
|
|
453
459
|
extend Telnyx::Internal::Type::Enum
|
|
454
460
|
|
|
@@ -480,7 +486,7 @@ module Telnyx
|
|
|
480
486
|
|
|
481
487
|
# Allows you to chose between Premium and Standard detections.
|
|
482
488
|
#
|
|
483
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
489
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#detection_mode
|
|
484
490
|
module DetectionMode
|
|
485
491
|
extend Telnyx::Internal::Type::Enum
|
|
486
492
|
|
|
@@ -493,7 +499,7 @@ module Telnyx
|
|
|
493
499
|
|
|
494
500
|
# Enables Answering Machine Detection.
|
|
495
501
|
#
|
|
496
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
502
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#machine_detection
|
|
497
503
|
module MachineDetection
|
|
498
504
|
extend Telnyx::Internal::Type::Enum
|
|
499
505
|
|
|
@@ -510,7 +516,7 @@ module Telnyx
|
|
|
510
516
|
# to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
|
|
511
517
|
# destinations.
|
|
512
518
|
#
|
|
513
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
519
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#media_encryption
|
|
514
520
|
module MediaEncryption
|
|
515
521
|
extend Telnyx::Internal::Type::Enum
|
|
516
522
|
|
|
@@ -524,7 +530,7 @@ module Telnyx
|
|
|
524
530
|
|
|
525
531
|
# The number of channels in the final recording. Defaults to `mono`.
|
|
526
532
|
#
|
|
527
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
533
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#recording_channels
|
|
528
534
|
module RecordingChannels
|
|
529
535
|
extend Telnyx::Internal::Type::Enum
|
|
530
536
|
|
|
@@ -537,7 +543,7 @@ module Telnyx
|
|
|
537
543
|
|
|
538
544
|
# HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
|
|
539
545
|
#
|
|
540
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
546
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#recording_status_callback_method
|
|
541
547
|
module RecordingStatusCallbackMethod
|
|
542
548
|
extend Telnyx::Internal::Type::Enum
|
|
543
549
|
|
|
@@ -550,7 +556,7 @@ module Telnyx
|
|
|
550
556
|
|
|
551
557
|
# The audio track to record for the call. The default is `both`.
|
|
552
558
|
#
|
|
553
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
559
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#recording_track
|
|
554
560
|
module RecordingTrack
|
|
555
561
|
extend Telnyx::Internal::Type::Enum
|
|
556
562
|
|
|
@@ -564,7 +570,7 @@ module Telnyx
|
|
|
564
570
|
|
|
565
571
|
# Defines the SIP region to be used for the call.
|
|
566
572
|
#
|
|
567
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
573
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#sip_region
|
|
568
574
|
module SipRegion
|
|
569
575
|
extend Telnyx::Internal::Type::Enum
|
|
570
576
|
|
|
@@ -581,7 +587,7 @@ module Telnyx
|
|
|
581
587
|
# The call events for which Telnyx should send a webhook. Multiple events can be
|
|
582
588
|
# defined when separated by a space.
|
|
583
589
|
#
|
|
584
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
590
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#status_callback_event
|
|
585
591
|
module StatusCallbackEvent
|
|
586
592
|
extend Telnyx::Internal::Type::Enum
|
|
587
593
|
|
|
@@ -596,7 +602,7 @@ module Telnyx
|
|
|
596
602
|
|
|
597
603
|
# HTTP request type used for `StatusCallback`.
|
|
598
604
|
#
|
|
599
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
605
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#status_callback_method
|
|
600
606
|
module StatusCallbackMethod
|
|
601
607
|
extend Telnyx::Internal::Type::Enum
|
|
602
608
|
|
|
@@ -611,7 +617,7 @@ module Telnyx
|
|
|
611
617
|
# both sides), whisper (only hear supervisor), monitor (hear both sides but
|
|
612
618
|
# supervisor muted). Default: barge
|
|
613
619
|
#
|
|
614
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
620
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#supervising_role
|
|
615
621
|
module SupervisingRole
|
|
616
622
|
extend Telnyx::Internal::Type::Enum
|
|
617
623
|
|
|
@@ -626,7 +632,7 @@ module Telnyx
|
|
|
626
632
|
# Whether to trim any leading and trailing silence from the recording. Defaults to
|
|
627
633
|
# `trim-silence`.
|
|
628
634
|
#
|
|
629
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
635
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#trim
|
|
630
636
|
module Trim
|
|
631
637
|
extend Telnyx::Internal::Type::Enum
|
|
632
638
|
|
|
@@ -640,7 +646,7 @@ module Telnyx
|
|
|
640
646
|
# HTTP request type used for `Url`. The default value is inherited from TeXML
|
|
641
647
|
# Application setting.
|
|
642
648
|
#
|
|
643
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
649
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#url_method
|
|
644
650
|
module URLMethod
|
|
645
651
|
extend Telnyx::Internal::Type::Enum
|
|
646
652
|
|
|
@@ -683,10 +689,10 @@ module Telnyx
|
|
|
683
689
|
# HTTP request type used for `AsyncAmdStatusCallback`. The default value is
|
|
684
690
|
# inherited from TeXML Application setting.
|
|
685
691
|
#
|
|
686
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
692
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::AsyncAmdStatusCallbackMethod, nil]
|
|
687
693
|
optional :async_amd_status_callback_method,
|
|
688
694
|
enum: -> {
|
|
689
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
695
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::AsyncAmdStatusCallbackMethod
|
|
690
696
|
},
|
|
691
697
|
api_name: :AsyncAmdStatusCallbackMethod
|
|
692
698
|
|
|
@@ -720,19 +726,21 @@ module Telnyx
|
|
|
720
726
|
# Custom HTTP headers to be sent with the call. Each header should be an object
|
|
721
727
|
# with 'name' and 'value' properties.
|
|
722
728
|
#
|
|
723
|
-
# @return [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
729
|
+
# @return [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::CustomHeader>, nil]
|
|
724
730
|
optional :custom_headers,
|
|
725
731
|
-> {
|
|
726
|
-
Telnyx::Internal::Type::ArrayOf[Telnyx::Texml::Accounts::CallCallsParams::
|
|
732
|
+
Telnyx::Internal::Type::ArrayOf[Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::CustomHeader]
|
|
727
733
|
},
|
|
728
734
|
api_name: :CustomHeaders
|
|
729
735
|
|
|
730
736
|
# @!attribute detection_mode
|
|
731
737
|
# Allows you to chose between Premium and Standard detections.
|
|
732
738
|
#
|
|
733
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
739
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DetectionMode, nil]
|
|
734
740
|
optional :detection_mode,
|
|
735
|
-
enum: -> {
|
|
741
|
+
enum: -> {
|
|
742
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::DetectionMode
|
|
743
|
+
},
|
|
736
744
|
api_name: :DetectionMode
|
|
737
745
|
|
|
738
746
|
# @!attribute fallback_url
|
|
@@ -752,10 +760,10 @@ module Telnyx
|
|
|
752
760
|
# @!attribute machine_detection
|
|
753
761
|
# Enables Answering Machine Detection.
|
|
754
762
|
#
|
|
755
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
763
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::MachineDetection, nil]
|
|
756
764
|
optional :machine_detection,
|
|
757
765
|
enum: -> {
|
|
758
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
766
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::MachineDetection
|
|
759
767
|
},
|
|
760
768
|
api_name: :MachineDetection
|
|
761
769
|
|
|
@@ -796,10 +804,10 @@ module Telnyx
|
|
|
796
804
|
# to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
|
|
797
805
|
# destinations.
|
|
798
806
|
#
|
|
799
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
807
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::MediaEncryption, nil]
|
|
800
808
|
optional :media_encryption,
|
|
801
809
|
enum: -> {
|
|
802
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
810
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::MediaEncryption
|
|
803
811
|
},
|
|
804
812
|
api_name: :MediaEncryption
|
|
805
813
|
|
|
@@ -818,10 +826,10 @@ module Telnyx
|
|
|
818
826
|
# @!attribute recording_channels
|
|
819
827
|
# The number of channels in the final recording. Defaults to `mono`.
|
|
820
828
|
#
|
|
821
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
829
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::RecordingChannels, nil]
|
|
822
830
|
optional :recording_channels,
|
|
823
831
|
enum: -> {
|
|
824
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
832
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::RecordingChannels
|
|
825
833
|
},
|
|
826
834
|
api_name: :RecordingChannels
|
|
827
835
|
|
|
@@ -842,10 +850,10 @@ module Telnyx
|
|
|
842
850
|
# @!attribute recording_status_callback_method
|
|
843
851
|
# HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
|
|
844
852
|
#
|
|
845
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
853
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::RecordingStatusCallbackMethod, nil]
|
|
846
854
|
optional :recording_status_callback_method,
|
|
847
855
|
enum: -> {
|
|
848
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
856
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::RecordingStatusCallbackMethod
|
|
849
857
|
},
|
|
850
858
|
api_name: :RecordingStatusCallbackMethod
|
|
851
859
|
|
|
@@ -861,9 +869,11 @@ module Telnyx
|
|
|
861
869
|
# @!attribute recording_track
|
|
862
870
|
# The audio track to record for the call. The default is `both`.
|
|
863
871
|
#
|
|
864
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
872
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::RecordingTrack, nil]
|
|
865
873
|
optional :recording_track,
|
|
866
|
-
enum: -> {
|
|
874
|
+
enum: -> {
|
|
875
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::RecordingTrack
|
|
876
|
+
},
|
|
867
877
|
api_name: :RecordingTrack
|
|
868
878
|
|
|
869
879
|
# @!attribute send_recording_url
|
|
@@ -887,9 +897,9 @@ module Telnyx
|
|
|
887
897
|
# @!attribute sip_region
|
|
888
898
|
# Defines the SIP region to be used for the call.
|
|
889
899
|
#
|
|
890
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
900
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::SipRegion, nil]
|
|
891
901
|
optional :sip_region,
|
|
892
|
-
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::
|
|
902
|
+
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::SipRegion },
|
|
893
903
|
api_name: :SipRegion
|
|
894
904
|
|
|
895
905
|
# @!attribute status_callback
|
|
@@ -902,20 +912,20 @@ module Telnyx
|
|
|
902
912
|
# The call events for which Telnyx should send a webhook. Multiple events can be
|
|
903
913
|
# defined when separated by a space.
|
|
904
914
|
#
|
|
905
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
915
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::StatusCallbackEvent, nil]
|
|
906
916
|
optional :status_callback_event,
|
|
907
917
|
enum: -> {
|
|
908
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
918
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::StatusCallbackEvent
|
|
909
919
|
},
|
|
910
920
|
api_name: :StatusCallbackEvent
|
|
911
921
|
|
|
912
922
|
# @!attribute status_callback_method
|
|
913
923
|
# HTTP request type used for `StatusCallback`.
|
|
914
924
|
#
|
|
915
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
925
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::StatusCallbackMethod, nil]
|
|
916
926
|
optional :status_callback_method,
|
|
917
927
|
enum: -> {
|
|
918
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
928
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::StatusCallbackMethod
|
|
919
929
|
},
|
|
920
930
|
api_name: :StatusCallbackMethod
|
|
921
931
|
|
|
@@ -932,10 +942,10 @@ module Telnyx
|
|
|
932
942
|
# both sides), whisper (only hear supervisor), monitor (hear both sides but
|
|
933
943
|
# supervisor muted). Default: barge
|
|
934
944
|
#
|
|
935
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
945
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::SupervisingRole, nil]
|
|
936
946
|
optional :supervising_role,
|
|
937
947
|
enum: -> {
|
|
938
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
948
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::SupervisingRole
|
|
939
949
|
},
|
|
940
950
|
api_name: :SupervisingRole
|
|
941
951
|
|
|
@@ -965,28 +975,28 @@ module Telnyx
|
|
|
965
975
|
# Whether to trim any leading and trailing silence from the recording. Defaults to
|
|
966
976
|
# `trim-silence`.
|
|
967
977
|
#
|
|
968
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
978
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::Trim, nil]
|
|
969
979
|
optional :trim,
|
|
970
|
-
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::
|
|
980
|
+
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::Trim },
|
|
971
981
|
api_name: :Trim
|
|
972
982
|
|
|
973
983
|
# @!attribute url
|
|
974
984
|
#
|
|
975
|
-
# @return [
|
|
976
|
-
optional :url,
|
|
985
|
+
# @return [String, nil]
|
|
986
|
+
optional :url, String, api_name: :Url, nil?: true
|
|
977
987
|
|
|
978
988
|
# @!attribute url_method
|
|
979
989
|
# HTTP request type used for `Url`. The default value is inherited from TeXML
|
|
980
990
|
# Application setting.
|
|
981
991
|
#
|
|
982
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
992
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::URLMethod, nil]
|
|
983
993
|
optional :url_method,
|
|
984
|
-
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::
|
|
994
|
+
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::URLMethod },
|
|
985
995
|
api_name: :UrlMethod
|
|
986
996
|
|
|
987
997
|
# @!method initialize(texml:, application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url: nil, url_method: nil)
|
|
988
998
|
# Some parameter documentations has been truncated, see
|
|
989
|
-
# {Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
999
|
+
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml} for more
|
|
990
1000
|
# details.
|
|
991
1001
|
#
|
|
992
1002
|
# @param texml [String] TeXML to be used as instructions for the call. If provided, the call will execut
|
|
@@ -997,7 +1007,7 @@ module Telnyx
|
|
|
997
1007
|
#
|
|
998
1008
|
# @param async_amd_status_callback [String] URL destination for Telnyx to send AMD callback events to for the call.
|
|
999
1009
|
#
|
|
1000
|
-
# @param async_amd_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1010
|
+
# @param async_amd_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::AsyncAmdStatusCallbackMethod] HTTP request type used for `AsyncAmdStatusCallback`. The default value is inheri
|
|
1001
1011
|
#
|
|
1002
1012
|
# @param caller_id [String] To be used as the caller id name (SIP From Display Name) presented to the destin
|
|
1003
1013
|
#
|
|
@@ -1005,15 +1015,15 @@ module Telnyx
|
|
|
1005
1015
|
#
|
|
1006
1016
|
# @param cancel_playback_on_machine_detection [Boolean] Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
|
|
1007
1017
|
#
|
|
1008
|
-
# @param custom_headers [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1018
|
+
# @param custom_headers [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::CustomHeader>] Custom HTTP headers to be sent with the call. Each header should be an object wi
|
|
1009
1019
|
#
|
|
1010
|
-
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1020
|
+
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DetectionMode] Allows you to chose between Premium and Standard detections.
|
|
1011
1021
|
#
|
|
1012
1022
|
# @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
|
|
1013
1023
|
#
|
|
1014
1024
|
# @param from [String] The phone number of the party that initiated the call. Phone numbers are formatt
|
|
1015
1025
|
#
|
|
1016
|
-
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1026
|
+
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::MachineDetection] Enables Answering Machine Detection.
|
|
1017
1027
|
#
|
|
1018
1028
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
1019
1029
|
#
|
|
@@ -1023,23 +1033,23 @@ module Telnyx
|
|
|
1023
1033
|
#
|
|
1024
1034
|
# @param machine_detection_timeout [Integer] Maximum timeout threshold in milliseconds for overall detection.
|
|
1025
1035
|
#
|
|
1026
|
-
# @param media_encryption [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1036
|
+
# @param media_encryption [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::MediaEncryption] Defines whether media should be encrypted on the call. When set to `SRTP`, the c
|
|
1027
1037
|
#
|
|
1028
1038
|
# @param preferred_codecs [String] The list of comma-separated codecs to be offered on a call.
|
|
1029
1039
|
#
|
|
1030
1040
|
# @param record [Boolean] Whether to record the entire participant's call leg. Defaults to `false`.
|
|
1031
1041
|
#
|
|
1032
|
-
# @param recording_channels [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1042
|
+
# @param recording_channels [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::RecordingChannels] The number of channels in the final recording. Defaults to `mono`.
|
|
1033
1043
|
#
|
|
1034
1044
|
# @param recording_status_callback [String] The URL the recording callbacks will be sent to.
|
|
1035
1045
|
#
|
|
1036
1046
|
# @param recording_status_callback_event [String] The changes to the recording's state that should generate a call to `RecoridngSt
|
|
1037
1047
|
#
|
|
1038
|
-
# @param recording_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1048
|
+
# @param recording_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::RecordingStatusCallbackMethod] HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
|
|
1039
1049
|
#
|
|
1040
1050
|
# @param recording_timeout [Integer] The number of seconds that Telnyx will wait for the recording to be stopped if s
|
|
1041
1051
|
#
|
|
1042
|
-
# @param recording_track [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1052
|
+
# @param recording_track [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::RecordingTrack] The audio track to record for the call. The default is `both`.
|
|
1043
1053
|
#
|
|
1044
1054
|
# @param send_recording_url [Boolean] Whether to send RecordingUrl in webhooks.
|
|
1045
1055
|
#
|
|
@@ -1047,17 +1057,17 @@ module Telnyx
|
|
|
1047
1057
|
#
|
|
1048
1058
|
# @param sip_auth_username [String] The username to use for SIP authentication.
|
|
1049
1059
|
#
|
|
1050
|
-
# @param sip_region [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1060
|
+
# @param sip_region [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::SipRegion] Defines the SIP region to be used for the call.
|
|
1051
1061
|
#
|
|
1052
1062
|
# @param status_callback [String] URL destination for Telnyx to send status callback events to for the call.
|
|
1053
1063
|
#
|
|
1054
|
-
# @param status_callback_event [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1064
|
+
# @param status_callback_event [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::StatusCallbackEvent] The call events for which Telnyx should send a webhook. Multiple events can be d
|
|
1055
1065
|
#
|
|
1056
|
-
# @param status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1066
|
+
# @param status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::StatusCallbackMethod] HTTP request type used for `StatusCallback`.
|
|
1057
1067
|
#
|
|
1058
1068
|
# @param supervise_call_sid [String] The call control ID of the existing call to supervise. When provided, the create
|
|
1059
1069
|
#
|
|
1060
|
-
# @param supervising_role [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1070
|
+
# @param supervising_role [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::SupervisingRole] The supervising role for the new leg. Determines the audio behavior: barge (hear
|
|
1061
1071
|
#
|
|
1062
1072
|
# @param time_limit [Integer] The maximum duration of the call in seconds. The minimum value is 30 and the max
|
|
1063
1073
|
#
|
|
@@ -1065,16 +1075,16 @@ module Telnyx
|
|
|
1065
1075
|
#
|
|
1066
1076
|
# @param to [String] The phone number of the called party. Phone numbers are formatted with a `+` and
|
|
1067
1077
|
#
|
|
1068
|
-
# @param trim [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1078
|
+
# @param trim [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::Trim] Whether to trim any leading and trailing silence from the recording. Defaults to
|
|
1069
1079
|
#
|
|
1070
|
-
# @param url [
|
|
1080
|
+
# @param url [String, nil]
|
|
1071
1081
|
#
|
|
1072
|
-
# @param url_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1082
|
+
# @param url_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::URLMethod] HTTP request type used for `Url`. The default value is inherited from TeXML Appl
|
|
1073
1083
|
|
|
1074
1084
|
# HTTP request type used for `AsyncAmdStatusCallback`. The default value is
|
|
1075
1085
|
# inherited from TeXML Application setting.
|
|
1076
1086
|
#
|
|
1077
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1087
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#async_amd_status_callback_method
|
|
1078
1088
|
module AsyncAmdStatusCallbackMethod
|
|
1079
1089
|
extend Telnyx::Internal::Type::Enum
|
|
1080
1090
|
|
|
@@ -1106,7 +1116,7 @@ module Telnyx
|
|
|
1106
1116
|
|
|
1107
1117
|
# Allows you to chose between Premium and Standard detections.
|
|
1108
1118
|
#
|
|
1109
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1119
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#detection_mode
|
|
1110
1120
|
module DetectionMode
|
|
1111
1121
|
extend Telnyx::Internal::Type::Enum
|
|
1112
1122
|
|
|
@@ -1119,7 +1129,7 @@ module Telnyx
|
|
|
1119
1129
|
|
|
1120
1130
|
# Enables Answering Machine Detection.
|
|
1121
1131
|
#
|
|
1122
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1132
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#machine_detection
|
|
1123
1133
|
module MachineDetection
|
|
1124
1134
|
extend Telnyx::Internal::Type::Enum
|
|
1125
1135
|
|
|
@@ -1136,7 +1146,7 @@ module Telnyx
|
|
|
1136
1146
|
# to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
|
|
1137
1147
|
# destinations.
|
|
1138
1148
|
#
|
|
1139
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1149
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#media_encryption
|
|
1140
1150
|
module MediaEncryption
|
|
1141
1151
|
extend Telnyx::Internal::Type::Enum
|
|
1142
1152
|
|
|
@@ -1150,7 +1160,7 @@ module Telnyx
|
|
|
1150
1160
|
|
|
1151
1161
|
# The number of channels in the final recording. Defaults to `mono`.
|
|
1152
1162
|
#
|
|
1153
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1163
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#recording_channels
|
|
1154
1164
|
module RecordingChannels
|
|
1155
1165
|
extend Telnyx::Internal::Type::Enum
|
|
1156
1166
|
|
|
@@ -1163,7 +1173,7 @@ module Telnyx
|
|
|
1163
1173
|
|
|
1164
1174
|
# HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
|
|
1165
1175
|
#
|
|
1166
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1176
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#recording_status_callback_method
|
|
1167
1177
|
module RecordingStatusCallbackMethod
|
|
1168
1178
|
extend Telnyx::Internal::Type::Enum
|
|
1169
1179
|
|
|
@@ -1176,7 +1186,7 @@ module Telnyx
|
|
|
1176
1186
|
|
|
1177
1187
|
# The audio track to record for the call. The default is `both`.
|
|
1178
1188
|
#
|
|
1179
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1189
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#recording_track
|
|
1180
1190
|
module RecordingTrack
|
|
1181
1191
|
extend Telnyx::Internal::Type::Enum
|
|
1182
1192
|
|
|
@@ -1190,7 +1200,7 @@ module Telnyx
|
|
|
1190
1200
|
|
|
1191
1201
|
# Defines the SIP region to be used for the call.
|
|
1192
1202
|
#
|
|
1193
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1203
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#sip_region
|
|
1194
1204
|
module SipRegion
|
|
1195
1205
|
extend Telnyx::Internal::Type::Enum
|
|
1196
1206
|
|
|
@@ -1207,7 +1217,7 @@ module Telnyx
|
|
|
1207
1217
|
# The call events for which Telnyx should send a webhook. Multiple events can be
|
|
1208
1218
|
# defined when separated by a space.
|
|
1209
1219
|
#
|
|
1210
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1220
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#status_callback_event
|
|
1211
1221
|
module StatusCallbackEvent
|
|
1212
1222
|
extend Telnyx::Internal::Type::Enum
|
|
1213
1223
|
|
|
@@ -1222,7 +1232,7 @@ module Telnyx
|
|
|
1222
1232
|
|
|
1223
1233
|
# HTTP request type used for `StatusCallback`.
|
|
1224
1234
|
#
|
|
1225
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1235
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#status_callback_method
|
|
1226
1236
|
module StatusCallbackMethod
|
|
1227
1237
|
extend Telnyx::Internal::Type::Enum
|
|
1228
1238
|
|
|
@@ -1237,7 +1247,7 @@ module Telnyx
|
|
|
1237
1247
|
# both sides), whisper (only hear supervisor), monitor (hear both sides but
|
|
1238
1248
|
# supervisor muted). Default: barge
|
|
1239
1249
|
#
|
|
1240
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1250
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#supervising_role
|
|
1241
1251
|
module SupervisingRole
|
|
1242
1252
|
extend Telnyx::Internal::Type::Enum
|
|
1243
1253
|
|
|
@@ -1252,7 +1262,7 @@ module Telnyx
|
|
|
1252
1262
|
# Whether to trim any leading and trailing silence from the recording. Defaults to
|
|
1253
1263
|
# `trim-silence`.
|
|
1254
1264
|
#
|
|
1255
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1265
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#trim
|
|
1256
1266
|
module Trim
|
|
1257
1267
|
extend Telnyx::Internal::Type::Enum
|
|
1258
1268
|
|
|
@@ -1266,7 +1276,7 @@ module Telnyx
|
|
|
1266
1276
|
# HTTP request type used for `Url`. The default value is inherited from TeXML
|
|
1267
1277
|
# Application setting.
|
|
1268
1278
|
#
|
|
1269
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1279
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#url_method
|
|
1270
1280
|
module URLMethod
|
|
1271
1281
|
extend Telnyx::Internal::Type::Enum
|
|
1272
1282
|
|
|
@@ -1302,10 +1312,10 @@ module Telnyx
|
|
|
1302
1312
|
# HTTP request type used for `AsyncAmdStatusCallback`. The default value is
|
|
1303
1313
|
# inherited from TeXML Application setting.
|
|
1304
1314
|
#
|
|
1305
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1315
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::AsyncAmdStatusCallbackMethod, nil]
|
|
1306
1316
|
optional :async_amd_status_callback_method,
|
|
1307
1317
|
enum: -> {
|
|
1308
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1318
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::AsyncAmdStatusCallbackMethod
|
|
1309
1319
|
},
|
|
1310
1320
|
api_name: :AsyncAmdStatusCallbackMethod
|
|
1311
1321
|
|
|
@@ -1339,20 +1349,20 @@ module Telnyx
|
|
|
1339
1349
|
# Custom HTTP headers to be sent with the call. Each header should be an object
|
|
1340
1350
|
# with 'name' and 'value' properties.
|
|
1341
1351
|
#
|
|
1342
|
-
# @return [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1352
|
+
# @return [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::CustomHeader>, nil]
|
|
1343
1353
|
optional :custom_headers,
|
|
1344
1354
|
-> {
|
|
1345
|
-
Telnyx::Internal::Type::ArrayOf[Telnyx::Texml::Accounts::CallCallsParams::
|
|
1355
|
+
Telnyx::Internal::Type::ArrayOf[Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::CustomHeader]
|
|
1346
1356
|
},
|
|
1347
1357
|
api_name: :CustomHeaders
|
|
1348
1358
|
|
|
1349
1359
|
# @!attribute detection_mode
|
|
1350
1360
|
# Allows you to chose between Premium and Standard detections.
|
|
1351
1361
|
#
|
|
1352
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1362
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DetectionMode, nil]
|
|
1353
1363
|
optional :detection_mode,
|
|
1354
1364
|
enum: -> {
|
|
1355
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1365
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DetectionMode
|
|
1356
1366
|
},
|
|
1357
1367
|
api_name: :DetectionMode
|
|
1358
1368
|
|
|
@@ -1373,10 +1383,10 @@ module Telnyx
|
|
|
1373
1383
|
# @!attribute machine_detection
|
|
1374
1384
|
# Enables Answering Machine Detection.
|
|
1375
1385
|
#
|
|
1376
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1386
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::MachineDetection, nil]
|
|
1377
1387
|
optional :machine_detection,
|
|
1378
1388
|
enum: -> {
|
|
1379
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1389
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::MachineDetection
|
|
1380
1390
|
},
|
|
1381
1391
|
api_name: :MachineDetection
|
|
1382
1392
|
|
|
@@ -1417,10 +1427,10 @@ module Telnyx
|
|
|
1417
1427
|
# to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
|
|
1418
1428
|
# destinations.
|
|
1419
1429
|
#
|
|
1420
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1430
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::MediaEncryption, nil]
|
|
1421
1431
|
optional :media_encryption,
|
|
1422
1432
|
enum: -> {
|
|
1423
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1433
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::MediaEncryption
|
|
1424
1434
|
},
|
|
1425
1435
|
api_name: :MediaEncryption
|
|
1426
1436
|
|
|
@@ -1439,10 +1449,10 @@ module Telnyx
|
|
|
1439
1449
|
# @!attribute recording_channels
|
|
1440
1450
|
# The number of channels in the final recording. Defaults to `mono`.
|
|
1441
1451
|
#
|
|
1442
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1452
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::RecordingChannels, nil]
|
|
1443
1453
|
optional :recording_channels,
|
|
1444
1454
|
enum: -> {
|
|
1445
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1455
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::RecordingChannels
|
|
1446
1456
|
},
|
|
1447
1457
|
api_name: :RecordingChannels
|
|
1448
1458
|
|
|
@@ -1463,10 +1473,10 @@ module Telnyx
|
|
|
1463
1473
|
# @!attribute recording_status_callback_method
|
|
1464
1474
|
# HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
|
|
1465
1475
|
#
|
|
1466
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1476
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::RecordingStatusCallbackMethod, nil]
|
|
1467
1477
|
optional :recording_status_callback_method,
|
|
1468
1478
|
enum: -> {
|
|
1469
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1479
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::RecordingStatusCallbackMethod
|
|
1470
1480
|
},
|
|
1471
1481
|
api_name: :RecordingStatusCallbackMethod
|
|
1472
1482
|
|
|
@@ -1482,10 +1492,10 @@ module Telnyx
|
|
|
1482
1492
|
# @!attribute recording_track
|
|
1483
1493
|
# The audio track to record for the call. The default is `both`.
|
|
1484
1494
|
#
|
|
1485
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1495
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::RecordingTrack, nil]
|
|
1486
1496
|
optional :recording_track,
|
|
1487
1497
|
enum: -> {
|
|
1488
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1498
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::RecordingTrack
|
|
1489
1499
|
},
|
|
1490
1500
|
api_name: :RecordingTrack
|
|
1491
1501
|
|
|
@@ -1510,10 +1520,10 @@ module Telnyx
|
|
|
1510
1520
|
# @!attribute sip_region
|
|
1511
1521
|
# Defines the SIP region to be used for the call.
|
|
1512
1522
|
#
|
|
1513
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1523
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::SipRegion, nil]
|
|
1514
1524
|
optional :sip_region,
|
|
1515
1525
|
enum: -> {
|
|
1516
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1526
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::SipRegion
|
|
1517
1527
|
},
|
|
1518
1528
|
api_name: :SipRegion
|
|
1519
1529
|
|
|
@@ -1527,20 +1537,20 @@ module Telnyx
|
|
|
1527
1537
|
# The call events for which Telnyx should send a webhook. Multiple events can be
|
|
1528
1538
|
# defined when separated by a space.
|
|
1529
1539
|
#
|
|
1530
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1540
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::StatusCallbackEvent, nil]
|
|
1531
1541
|
optional :status_callback_event,
|
|
1532
1542
|
enum: -> {
|
|
1533
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1543
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::StatusCallbackEvent
|
|
1534
1544
|
},
|
|
1535
1545
|
api_name: :StatusCallbackEvent
|
|
1536
1546
|
|
|
1537
1547
|
# @!attribute status_callback_method
|
|
1538
1548
|
# HTTP request type used for `StatusCallback`.
|
|
1539
1549
|
#
|
|
1540
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1550
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::StatusCallbackMethod, nil]
|
|
1541
1551
|
optional :status_callback_method,
|
|
1542
1552
|
enum: -> {
|
|
1543
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1553
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::StatusCallbackMethod
|
|
1544
1554
|
},
|
|
1545
1555
|
api_name: :StatusCallbackMethod
|
|
1546
1556
|
|
|
@@ -1557,17 +1567,17 @@ module Telnyx
|
|
|
1557
1567
|
# both sides), whisper (only hear supervisor), monitor (hear both sides but
|
|
1558
1568
|
# supervisor muted). Default: barge
|
|
1559
1569
|
#
|
|
1560
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1570
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::SupervisingRole, nil]
|
|
1561
1571
|
optional :supervising_role,
|
|
1562
1572
|
enum: -> {
|
|
1563
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1573
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::SupervisingRole
|
|
1564
1574
|
},
|
|
1565
1575
|
api_name: :SupervisingRole
|
|
1566
1576
|
|
|
1567
1577
|
# @!attribute texml
|
|
1568
1578
|
#
|
|
1569
|
-
# @return [
|
|
1570
|
-
optional :texml,
|
|
1579
|
+
# @return [String, nil]
|
|
1580
|
+
optional :texml, String, api_name: :Texml, nil?: true
|
|
1571
1581
|
|
|
1572
1582
|
# @!attribute time_limit
|
|
1573
1583
|
# The maximum duration of the call in seconds. The minimum value is 30 and the
|
|
@@ -1595,31 +1605,33 @@ module Telnyx
|
|
|
1595
1605
|
# Whether to trim any leading and trailing silence from the recording. Defaults to
|
|
1596
1606
|
# `trim-silence`.
|
|
1597
1607
|
#
|
|
1598
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1608
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::Trim, nil]
|
|
1599
1609
|
optional :trim,
|
|
1600
|
-
enum: -> {
|
|
1610
|
+
enum: -> {
|
|
1611
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::Trim
|
|
1612
|
+
},
|
|
1601
1613
|
api_name: :Trim
|
|
1602
1614
|
|
|
1603
1615
|
# @!attribute url
|
|
1604
1616
|
#
|
|
1605
|
-
# @return [
|
|
1606
|
-
optional :url,
|
|
1617
|
+
# @return [String, nil]
|
|
1618
|
+
optional :url, String, api_name: :Url, nil?: true
|
|
1607
1619
|
|
|
1608
1620
|
# @!attribute url_method
|
|
1609
1621
|
# HTTP request type used for `Url`. The default value is inherited from TeXML
|
|
1610
1622
|
# Application setting.
|
|
1611
1623
|
#
|
|
1612
|
-
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1624
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::URLMethod, nil]
|
|
1613
1625
|
optional :url_method,
|
|
1614
1626
|
enum: -> {
|
|
1615
|
-
Telnyx::Texml::Accounts::CallCallsParams::
|
|
1627
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::URLMethod
|
|
1616
1628
|
},
|
|
1617
1629
|
api_name: :UrlMethod
|
|
1618
1630
|
|
|
1619
1631
|
# @!method initialize(application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, texml: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url: nil, url_method: nil)
|
|
1620
1632
|
# Some parameter documentations has been truncated, see
|
|
1621
|
-
# {Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1622
|
-
# more details.
|
|
1633
|
+
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault}
|
|
1634
|
+
# for more details.
|
|
1623
1635
|
#
|
|
1624
1636
|
# @param application_sid [String] The ID of the TeXML Application.
|
|
1625
1637
|
#
|
|
@@ -1627,7 +1639,7 @@ module Telnyx
|
|
|
1627
1639
|
#
|
|
1628
1640
|
# @param async_amd_status_callback [String] URL destination for Telnyx to send AMD callback events to for the call.
|
|
1629
1641
|
#
|
|
1630
|
-
# @param async_amd_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1642
|
+
# @param async_amd_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::AsyncAmdStatusCallbackMethod] HTTP request type used for `AsyncAmdStatusCallback`. The default value is inheri
|
|
1631
1643
|
#
|
|
1632
1644
|
# @param caller_id [String] To be used as the caller id name (SIP From Display Name) presented to the destin
|
|
1633
1645
|
#
|
|
@@ -1635,15 +1647,15 @@ module Telnyx
|
|
|
1635
1647
|
#
|
|
1636
1648
|
# @param cancel_playback_on_machine_detection [Boolean] Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
|
|
1637
1649
|
#
|
|
1638
|
-
# @param custom_headers [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1650
|
+
# @param custom_headers [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::CustomHeader>] Custom HTTP headers to be sent with the call. Each header should be an object wi
|
|
1639
1651
|
#
|
|
1640
|
-
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1652
|
+
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DetectionMode] Allows you to chose between Premium and Standard detections.
|
|
1641
1653
|
#
|
|
1642
1654
|
# @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
|
|
1643
1655
|
#
|
|
1644
1656
|
# @param from [String] The phone number of the party that initiated the call. Phone numbers are formatt
|
|
1645
1657
|
#
|
|
1646
|
-
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1658
|
+
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::MachineDetection] Enables Answering Machine Detection.
|
|
1647
1659
|
#
|
|
1648
1660
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
1649
1661
|
#
|
|
@@ -1653,23 +1665,23 @@ module Telnyx
|
|
|
1653
1665
|
#
|
|
1654
1666
|
# @param machine_detection_timeout [Integer] Maximum timeout threshold in milliseconds for overall detection.
|
|
1655
1667
|
#
|
|
1656
|
-
# @param media_encryption [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1668
|
+
# @param media_encryption [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::MediaEncryption] Defines whether media should be encrypted on the call. When set to `SRTP`, the c
|
|
1657
1669
|
#
|
|
1658
1670
|
# @param preferred_codecs [String] The list of comma-separated codecs to be offered on a call.
|
|
1659
1671
|
#
|
|
1660
1672
|
# @param record [Boolean] Whether to record the entire participant's call leg. Defaults to `false`.
|
|
1661
1673
|
#
|
|
1662
|
-
# @param recording_channels [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1674
|
+
# @param recording_channels [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::RecordingChannels] The number of channels in the final recording. Defaults to `mono`.
|
|
1663
1675
|
#
|
|
1664
1676
|
# @param recording_status_callback [String] The URL the recording callbacks will be sent to.
|
|
1665
1677
|
#
|
|
1666
1678
|
# @param recording_status_callback_event [String] The changes to the recording's state that should generate a call to `RecoridngSt
|
|
1667
1679
|
#
|
|
1668
|
-
# @param recording_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1680
|
+
# @param recording_status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::RecordingStatusCallbackMethod] HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
|
|
1669
1681
|
#
|
|
1670
1682
|
# @param recording_timeout [Integer] The number of seconds that Telnyx will wait for the recording to be stopped if s
|
|
1671
1683
|
#
|
|
1672
|
-
# @param recording_track [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1684
|
+
# @param recording_track [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::RecordingTrack] The audio track to record for the call. The default is `both`.
|
|
1673
1685
|
#
|
|
1674
1686
|
# @param send_recording_url [Boolean] Whether to send RecordingUrl in webhooks.
|
|
1675
1687
|
#
|
|
@@ -1677,19 +1689,19 @@ module Telnyx
|
|
|
1677
1689
|
#
|
|
1678
1690
|
# @param sip_auth_username [String] The username to use for SIP authentication.
|
|
1679
1691
|
#
|
|
1680
|
-
# @param sip_region [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1692
|
+
# @param sip_region [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::SipRegion] Defines the SIP region to be used for the call.
|
|
1681
1693
|
#
|
|
1682
1694
|
# @param status_callback [String] URL destination for Telnyx to send status callback events to for the call.
|
|
1683
1695
|
#
|
|
1684
|
-
# @param status_callback_event [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1696
|
+
# @param status_callback_event [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::StatusCallbackEvent] The call events for which Telnyx should send a webhook. Multiple events can be d
|
|
1685
1697
|
#
|
|
1686
|
-
# @param status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1698
|
+
# @param status_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::StatusCallbackMethod] HTTP request type used for `StatusCallback`.
|
|
1687
1699
|
#
|
|
1688
1700
|
# @param supervise_call_sid [String] The call control ID of the existing call to supervise. When provided, the create
|
|
1689
1701
|
#
|
|
1690
|
-
# @param supervising_role [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1702
|
+
# @param supervising_role [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::SupervisingRole] The supervising role for the new leg. Determines the audio behavior: barge (hear
|
|
1691
1703
|
#
|
|
1692
|
-
# @param texml [
|
|
1704
|
+
# @param texml [String, nil]
|
|
1693
1705
|
#
|
|
1694
1706
|
# @param time_limit [Integer] The maximum duration of the call in seconds. The minimum value is 30 and the max
|
|
1695
1707
|
#
|
|
@@ -1697,16 +1709,16 @@ module Telnyx
|
|
|
1697
1709
|
#
|
|
1698
1710
|
# @param to [String] The phone number of the called party. Phone numbers are formatted with a `+` and
|
|
1699
1711
|
#
|
|
1700
|
-
# @param trim [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1712
|
+
# @param trim [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::Trim] Whether to trim any leading and trailing silence from the recording. Defaults to
|
|
1701
1713
|
#
|
|
1702
|
-
# @param url [
|
|
1714
|
+
# @param url [String, nil]
|
|
1703
1715
|
#
|
|
1704
|
-
# @param url_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1716
|
+
# @param url_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::URLMethod] HTTP request type used for `Url`. The default value is inherited from TeXML Appl
|
|
1705
1717
|
|
|
1706
1718
|
# HTTP request type used for `AsyncAmdStatusCallback`. The default value is
|
|
1707
1719
|
# inherited from TeXML Application setting.
|
|
1708
1720
|
#
|
|
1709
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1721
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#async_amd_status_callback_method
|
|
1710
1722
|
module AsyncAmdStatusCallbackMethod
|
|
1711
1723
|
extend Telnyx::Internal::Type::Enum
|
|
1712
1724
|
|
|
@@ -1738,7 +1750,7 @@ module Telnyx
|
|
|
1738
1750
|
|
|
1739
1751
|
# Allows you to chose between Premium and Standard detections.
|
|
1740
1752
|
#
|
|
1741
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1753
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#detection_mode
|
|
1742
1754
|
module DetectionMode
|
|
1743
1755
|
extend Telnyx::Internal::Type::Enum
|
|
1744
1756
|
|
|
@@ -1751,7 +1763,7 @@ module Telnyx
|
|
|
1751
1763
|
|
|
1752
1764
|
# Enables Answering Machine Detection.
|
|
1753
1765
|
#
|
|
1754
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1766
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#machine_detection
|
|
1755
1767
|
module MachineDetection
|
|
1756
1768
|
extend Telnyx::Internal::Type::Enum
|
|
1757
1769
|
|
|
@@ -1768,7 +1780,7 @@ module Telnyx
|
|
|
1768
1780
|
# to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
|
|
1769
1781
|
# destinations.
|
|
1770
1782
|
#
|
|
1771
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1783
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#media_encryption
|
|
1772
1784
|
module MediaEncryption
|
|
1773
1785
|
extend Telnyx::Internal::Type::Enum
|
|
1774
1786
|
|
|
@@ -1782,7 +1794,7 @@ module Telnyx
|
|
|
1782
1794
|
|
|
1783
1795
|
# The number of channels in the final recording. Defaults to `mono`.
|
|
1784
1796
|
#
|
|
1785
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1797
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#recording_channels
|
|
1786
1798
|
module RecordingChannels
|
|
1787
1799
|
extend Telnyx::Internal::Type::Enum
|
|
1788
1800
|
|
|
@@ -1795,7 +1807,7 @@ module Telnyx
|
|
|
1795
1807
|
|
|
1796
1808
|
# HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
|
|
1797
1809
|
#
|
|
1798
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1810
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#recording_status_callback_method
|
|
1799
1811
|
module RecordingStatusCallbackMethod
|
|
1800
1812
|
extend Telnyx::Internal::Type::Enum
|
|
1801
1813
|
|
|
@@ -1808,7 +1820,7 @@ module Telnyx
|
|
|
1808
1820
|
|
|
1809
1821
|
# The audio track to record for the call. The default is `both`.
|
|
1810
1822
|
#
|
|
1811
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1823
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#recording_track
|
|
1812
1824
|
module RecordingTrack
|
|
1813
1825
|
extend Telnyx::Internal::Type::Enum
|
|
1814
1826
|
|
|
@@ -1822,7 +1834,7 @@ module Telnyx
|
|
|
1822
1834
|
|
|
1823
1835
|
# Defines the SIP region to be used for the call.
|
|
1824
1836
|
#
|
|
1825
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1837
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#sip_region
|
|
1826
1838
|
module SipRegion
|
|
1827
1839
|
extend Telnyx::Internal::Type::Enum
|
|
1828
1840
|
|
|
@@ -1839,7 +1851,7 @@ module Telnyx
|
|
|
1839
1851
|
# The call events for which Telnyx should send a webhook. Multiple events can be
|
|
1840
1852
|
# defined when separated by a space.
|
|
1841
1853
|
#
|
|
1842
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1854
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#status_callback_event
|
|
1843
1855
|
module StatusCallbackEvent
|
|
1844
1856
|
extend Telnyx::Internal::Type::Enum
|
|
1845
1857
|
|
|
@@ -1854,7 +1866,7 @@ module Telnyx
|
|
|
1854
1866
|
|
|
1855
1867
|
# HTTP request type used for `StatusCallback`.
|
|
1856
1868
|
#
|
|
1857
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1869
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#status_callback_method
|
|
1858
1870
|
module StatusCallbackMethod
|
|
1859
1871
|
extend Telnyx::Internal::Type::Enum
|
|
1860
1872
|
|
|
@@ -1869,7 +1881,7 @@ module Telnyx
|
|
|
1869
1881
|
# both sides), whisper (only hear supervisor), monitor (hear both sides but
|
|
1870
1882
|
# supervisor muted). Default: barge
|
|
1871
1883
|
#
|
|
1872
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1884
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#supervising_role
|
|
1873
1885
|
module SupervisingRole
|
|
1874
1886
|
extend Telnyx::Internal::Type::Enum
|
|
1875
1887
|
|
|
@@ -1884,7 +1896,7 @@ module Telnyx
|
|
|
1884
1896
|
# Whether to trim any leading and trailing silence from the recording. Defaults to
|
|
1885
1897
|
# `trim-silence`.
|
|
1886
1898
|
#
|
|
1887
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1899
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#trim
|
|
1888
1900
|
module Trim
|
|
1889
1901
|
extend Telnyx::Internal::Type::Enum
|
|
1890
1902
|
|
|
@@ -1898,7 +1910,7 @@ module Telnyx
|
|
|
1898
1910
|
# HTTP request type used for `Url`. The default value is inherited from TeXML
|
|
1899
1911
|
# Application setting.
|
|
1900
1912
|
#
|
|
1901
|
-
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1913
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#url_method
|
|
1902
1914
|
module URLMethod
|
|
1903
1915
|
extend Telnyx::Internal::Type::Enum
|
|
1904
1916
|
|
|
@@ -1911,7 +1923,7 @@ module Telnyx
|
|
|
1911
1923
|
end
|
|
1912
1924
|
|
|
1913
1925
|
# @!method self.variants
|
|
1914
|
-
# @return [Array(Telnyx::Models::Texml::Accounts::CallCallsParams::
|
|
1926
|
+
# @return [Array(Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault)]
|
|
1915
1927
|
end
|
|
1916
1928
|
end
|
|
1917
1929
|
end
|