telnyx 5.161.0 → 5.162.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 +12 -0
- data/README.md +1 -1
- data/lib/telnyx/models/call_dial_params.rb +27 -1
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +6 -1
- data/lib/telnyx/models/calls/action_speak_params.rb +6 -1
- data/lib/telnyx/models/calls/action_transfer_params.rb +27 -1
- data/lib/telnyx/models/conferences/action_speak_params.rb +6 -1
- data/lib/telnyx/models/rime_voice_settings.rb +15 -1
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +96 -3
- data/lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb +30 -1
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +28 -1
- data/lib/telnyx/resources/messaging_profiles.rb +1 -1
- data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +3 -1
- data/lib/telnyx/resources/texml.rb +3 -1
- data/lib/telnyx/version.rb +1 -1
- data/rbi/telnyx/models/call_dial_params.rbi +65 -0
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +12 -2
- data/rbi/telnyx/models/calls/action_speak_params.rbi +12 -2
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +65 -0
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +12 -2
- data/rbi/telnyx/models/rime_voice_settings.rbi +17 -0
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +204 -0
- data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_params.rbi +68 -0
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +68 -0
- data/rbi/telnyx/resources/calls/actions.rbi +12 -2
- data/rbi/telnyx/resources/conferences/actions.rbi +6 -1
- data/rbi/telnyx/resources/messaging_profiles.rbi +1 -1
- data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +7 -0
- data/rbi/telnyx/resources/texml.rbi +7 -0
- data/sig/telnyx/models/call_dial_params.rbs +20 -0
- data/sig/telnyx/models/calls/action_transfer_params.rbs +20 -0
- data/sig/telnyx/models/rime_voice_settings.rbs +11 -1
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +60 -0
- data/sig/telnyx/models/texml/accounts/conferences/participant_participants_params.rbs +20 -0
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +20 -0
- data/sig/telnyx/resources/texml/accounts/conferences/participants.rbs +1 -0
- data/sig/telnyx/resources/texml.rbs +1 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b7708f9c5fde7caa42c63ed4cb40339bdfa84c9b161a6d524055843fd1988063
|
|
4
|
+
data.tar.gz: 4ab55177e33129022a5460eb6c41ad5b25963ece22d1aac684fcfbd796882201
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 72f99386036ffbb741f1ac5f927b7c98499e0b0a05664954098abaa9fb19f3b9315f03c9f482706de1a8060b7899b66821d06a79b0f3a48ee49feff2d4098882
|
|
7
|
+
data.tar.gz: 0f072694323630e69c4c11226d4f67ca42c525effdc7c191fe00c5a266b68dad7d35035696903e154d897ce9a08c13fba7c0a993bbf36430fff1f6b81780ae3b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [5.162.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.161.0...v5.162.0) (2026-08-18)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* promote from staging da5b392 ([a6f764f](https://github.com/team-telnyx/telnyx-ruby/commit/a6f764f5d8e682c5f37c1d0efb7cd007adc143be))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* **ci:** ignore closed release PR events ([#343](https://github.com/team-telnyx/telnyx-ruby/issues/343)) ([c65fae5](https://github.com/team-telnyx/telnyx-ruby/commit/c65fae5ee03bbbfab28da33b0204f3fc972b509f))
|
|
14
|
+
|
|
3
15
|
## [5.161.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.160.0...v5.161.0) (2026-08-16)
|
|
4
16
|
|
|
5
17
|
|
data/README.md
CHANGED
|
@@ -706,6 +706,15 @@ module Telnyx
|
|
|
706
706
|
# @return [Integer, nil]
|
|
707
707
|
optional :after_greeting_silence_millis, Integer
|
|
708
708
|
|
|
709
|
+
# @!attribute beep_detection_profile
|
|
710
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
711
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
712
|
+
# beeps whose volume is too unsteady for the default profile.
|
|
713
|
+
#
|
|
714
|
+
# @return [Symbol, Telnyx::Models::CallDialParams::AnsweringMachineDetectionConfig::BeepDetectionProfile, nil]
|
|
715
|
+
optional :beep_detection_profile,
|
|
716
|
+
enum: -> { Telnyx::CallDialParams::AnsweringMachineDetectionConfig::BeepDetectionProfile }
|
|
717
|
+
|
|
709
718
|
# @!attribute between_words_silence_millis
|
|
710
719
|
# Maximum threshold for silence between words.
|
|
711
720
|
#
|
|
@@ -763,7 +772,7 @@ module Telnyx
|
|
|
763
772
|
# @return [Integer, nil]
|
|
764
773
|
optional :total_analysis_time_millis, Integer
|
|
765
774
|
|
|
766
|
-
# @!method initialize(after_greeting_silence_millis: nil, between_words_silence_millis: nil, greeting_duration_millis: nil, greeting_silence_duration_millis: nil, greeting_total_analysis_time_millis: nil, initial_silence_millis: nil, maximum_number_of_words: nil, maximum_word_length_millis: nil, silence_threshold: nil, total_analysis_time_millis: nil)
|
|
775
|
+
# @!method initialize(after_greeting_silence_millis: nil, beep_detection_profile: nil, between_words_silence_millis: nil, greeting_duration_millis: nil, greeting_silence_duration_millis: nil, greeting_total_analysis_time_millis: nil, initial_silence_millis: nil, maximum_number_of_words: nil, maximum_word_length_millis: nil, silence_threshold: nil, total_analysis_time_millis: nil)
|
|
767
776
|
# Some parameter documentations has been truncated, see
|
|
768
777
|
# {Telnyx::Models::CallDialParams::AnsweringMachineDetectionConfig} for more
|
|
769
778
|
# details.
|
|
@@ -775,6 +784,8 @@ module Telnyx
|
|
|
775
784
|
#
|
|
776
785
|
# @param after_greeting_silence_millis [Integer] Silence duration threshold after a greeting message or voice for it be considere
|
|
777
786
|
#
|
|
787
|
+
# @param beep_detection_profile [Symbol, Telnyx::Models::CallDialParams::AnsweringMachineDetectionConfig::BeepDetectionProfile] Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
788
|
+
#
|
|
778
789
|
# @param between_words_silence_millis [Integer] Maximum threshold for silence between words.
|
|
779
790
|
#
|
|
780
791
|
# @param greeting_duration_millis [Integer] Maximum threshold of a human greeting. If greeting longer than this value, consi
|
|
@@ -792,6 +803,21 @@ module Telnyx
|
|
|
792
803
|
# @param silence_threshold [Integer] Minimum noise threshold for any analysis.
|
|
793
804
|
#
|
|
794
805
|
# @param total_analysis_time_millis [Integer] Maximum timeout threshold for overall detection.
|
|
806
|
+
|
|
807
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
808
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
809
|
+
# beeps whose volume is too unsteady for the default profile.
|
|
810
|
+
#
|
|
811
|
+
# @see Telnyx::Models::CallDialParams::AnsweringMachineDetectionConfig#beep_detection_profile
|
|
812
|
+
module BeepDetectionProfile
|
|
813
|
+
extend Telnyx::Internal::Type::Enum
|
|
814
|
+
|
|
815
|
+
BOTH = :both
|
|
816
|
+
FREQ_ONLY = :freq_only
|
|
817
|
+
|
|
818
|
+
# @!method self.values
|
|
819
|
+
# @return [Array<Symbol>]
|
|
820
|
+
end
|
|
795
821
|
end
|
|
796
822
|
|
|
797
823
|
class ConferenceConfig < Telnyx::Internal::Type::BaseModel
|
|
@@ -56,7 +56,12 @@ module Telnyx
|
|
|
56
56
|
# to configure speed, volume, pitch, and language_boost.
|
|
57
57
|
# - **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`).
|
|
58
58
|
# Supported model_ids: `Arcana`, `Mist`, `ArcanaV3`, `Coda`. Use
|
|
59
|
-
# `voice_settings` to configure voice_speed.
|
|
59
|
+
# `voice_settings` to configure voice_speed. To use your own Rime account,
|
|
60
|
+
# provide your Rime API key as an integration secret in
|
|
61
|
+
# `"voice_settings": {"type": "rime", "api_key_ref": "<secret_identifier>"}`.
|
|
62
|
+
# See
|
|
63
|
+
# [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
64
|
+
# for details.
|
|
60
65
|
# - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
|
|
61
66
|
# `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
|
|
62
67
|
# `voice_settings` to configure precision, sample_rate, and format.
|
|
@@ -56,7 +56,12 @@ module Telnyx
|
|
|
56
56
|
# to configure speed, volume, pitch, and language_boost.
|
|
57
57
|
# - **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`).
|
|
58
58
|
# Supported model_ids: `Arcana`, `Mist`, `ArcanaV3`, `Coda`. Use
|
|
59
|
-
# `voice_settings` to configure voice_speed.
|
|
59
|
+
# `voice_settings` to configure voice_speed. To use your own Rime account,
|
|
60
|
+
# provide your Rime API key as an integration secret in
|
|
61
|
+
# `"voice_settings": {"type": "rime", "api_key_ref": "<secret_identifier>"}`.
|
|
62
|
+
# See
|
|
63
|
+
# [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
64
|
+
# for details.
|
|
60
65
|
# - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
|
|
61
66
|
# `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
|
|
62
67
|
# `voice_settings` to configure precision, sample_rate, and format.
|
|
@@ -453,6 +453,15 @@ module Telnyx
|
|
|
453
453
|
# @return [Integer, nil]
|
|
454
454
|
optional :after_greeting_silence_millis, Integer
|
|
455
455
|
|
|
456
|
+
# @!attribute beep_detection_profile
|
|
457
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
458
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
459
|
+
# beeps whose volume is too unsteady for the default profile.
|
|
460
|
+
#
|
|
461
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionTransferParams::AnsweringMachineDetectionConfig::BeepDetectionProfile, nil]
|
|
462
|
+
optional :beep_detection_profile,
|
|
463
|
+
enum: -> { Telnyx::Calls::ActionTransferParams::AnsweringMachineDetectionConfig::BeepDetectionProfile }
|
|
464
|
+
|
|
456
465
|
# @!attribute between_words_silence_millis
|
|
457
466
|
# Maximum threshold for silence between words.
|
|
458
467
|
#
|
|
@@ -510,7 +519,7 @@ module Telnyx
|
|
|
510
519
|
# @return [Integer, nil]
|
|
511
520
|
optional :total_analysis_time_millis, Integer
|
|
512
521
|
|
|
513
|
-
# @!method initialize(after_greeting_silence_millis: nil, between_words_silence_millis: nil, greeting_duration_millis: nil, greeting_silence_duration_millis: nil, greeting_total_analysis_time_millis: nil, initial_silence_millis: nil, maximum_number_of_words: nil, maximum_word_length_millis: nil, silence_threshold: nil, total_analysis_time_millis: nil)
|
|
522
|
+
# @!method initialize(after_greeting_silence_millis: nil, beep_detection_profile: nil, between_words_silence_millis: nil, greeting_duration_millis: nil, greeting_silence_duration_millis: nil, greeting_total_analysis_time_millis: nil, initial_silence_millis: nil, maximum_number_of_words: nil, maximum_word_length_millis: nil, silence_threshold: nil, total_analysis_time_millis: nil)
|
|
514
523
|
# Some parameter documentations has been truncated, see
|
|
515
524
|
# {Telnyx::Models::Calls::ActionTransferParams::AnsweringMachineDetectionConfig}
|
|
516
525
|
# for more details.
|
|
@@ -522,6 +531,8 @@ module Telnyx
|
|
|
522
531
|
#
|
|
523
532
|
# @param after_greeting_silence_millis [Integer] Silence duration threshold after a greeting message or voice for it be considere
|
|
524
533
|
#
|
|
534
|
+
# @param beep_detection_profile [Symbol, Telnyx::Models::Calls::ActionTransferParams::AnsweringMachineDetectionConfig::BeepDetectionProfile] Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
535
|
+
#
|
|
525
536
|
# @param between_words_silence_millis [Integer] Maximum threshold for silence between words.
|
|
526
537
|
#
|
|
527
538
|
# @param greeting_duration_millis [Integer] Maximum threshold of a human greeting. If greeting longer than this value, consi
|
|
@@ -539,6 +550,21 @@ module Telnyx
|
|
|
539
550
|
# @param silence_threshold [Integer] Minimum noise threshold for any analysis.
|
|
540
551
|
#
|
|
541
552
|
# @param total_analysis_time_millis [Integer] Maximum timeout threshold for overall detection.
|
|
553
|
+
|
|
554
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
555
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
556
|
+
# beeps whose volume is too unsteady for the default profile.
|
|
557
|
+
#
|
|
558
|
+
# @see Telnyx::Models::Calls::ActionTransferParams::AnsweringMachineDetectionConfig#beep_detection_profile
|
|
559
|
+
module BeepDetectionProfile
|
|
560
|
+
extend Telnyx::Internal::Type::Enum
|
|
561
|
+
|
|
562
|
+
BOTH = :both
|
|
563
|
+
FREQ_ONLY = :freq_only
|
|
564
|
+
|
|
565
|
+
# @!method self.values
|
|
566
|
+
# @return [Array<Symbol>]
|
|
567
|
+
end
|
|
542
568
|
end
|
|
543
569
|
|
|
544
570
|
# Defines whether media should be encrypted on the new call leg. For SIP URI
|
|
@@ -56,7 +56,12 @@ module Telnyx
|
|
|
56
56
|
# to configure speed, volume, pitch, and language_boost.
|
|
57
57
|
# - **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`).
|
|
58
58
|
# Supported model_ids: `Arcana`, `Mist`, `ArcanaV3`, `Coda`. Use
|
|
59
|
-
# `voice_settings` to configure voice_speed.
|
|
59
|
+
# `voice_settings` to configure voice_speed. To use your own Rime account,
|
|
60
|
+
# provide your Rime API key as an integration secret in
|
|
61
|
+
# `"voice_settings": {"type": "rime", "api_key_ref": "<secret_identifier>"}`.
|
|
62
|
+
# See
|
|
63
|
+
# [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
64
|
+
# for details.
|
|
60
65
|
# - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
|
|
61
66
|
# `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
|
|
62
67
|
# `voice_settings` to configure precision, sample_rate, and format.
|
|
@@ -9,15 +9,29 @@ module Telnyx
|
|
|
9
9
|
# @return [Symbol, Telnyx::Models::RimeVoiceSettings::Type]
|
|
10
10
|
required :type, enum: -> { Telnyx::RimeVoiceSettings::Type }
|
|
11
11
|
|
|
12
|
+
# @!attribute api_key_ref
|
|
13
|
+
# The `identifier` for an integration secret
|
|
14
|
+
# [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
15
|
+
# that refers to your Rime API key. Only required when using your own Rime
|
|
16
|
+
# account.
|
|
17
|
+
#
|
|
18
|
+
# @return [String, nil]
|
|
19
|
+
optional :api_key_ref, String
|
|
20
|
+
|
|
12
21
|
# @!attribute voice_speed
|
|
13
22
|
# Speech speed multiplier. Default is 1.0.
|
|
14
23
|
#
|
|
15
24
|
# @return [Float, nil]
|
|
16
25
|
optional :voice_speed, Float
|
|
17
26
|
|
|
18
|
-
# @!method initialize(type:, voice_speed: nil)
|
|
27
|
+
# @!method initialize(type:, api_key_ref: nil, voice_speed: nil)
|
|
28
|
+
# Some parameter documentations has been truncated, see
|
|
29
|
+
# {Telnyx::Models::RimeVoiceSettings} for more details.
|
|
30
|
+
#
|
|
19
31
|
# @param type [Symbol, Telnyx::Models::RimeVoiceSettings::Type] Voice settings provider type
|
|
20
32
|
#
|
|
33
|
+
# @param api_key_ref [String] The `identifier` for an integration secret [/v2/integration_secrets](https://dev
|
|
34
|
+
#
|
|
21
35
|
# @param voice_speed [Float] Speech speed multiplier. Default is 1.0.
|
|
22
36
|
|
|
23
37
|
# Voice settings provider type
|
|
@@ -170,6 +170,19 @@ module Telnyx
|
|
|
170
170
|
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Body::WithURL::MachineDetection },
|
|
171
171
|
api_name: :MachineDetection
|
|
172
172
|
|
|
173
|
+
# @!attribute machine_detection_beep_profile
|
|
174
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
175
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
176
|
+
# beeps whose volume is too unsteady for the default profile. Only used when
|
|
177
|
+
# MachineDetection is enabled.
|
|
178
|
+
#
|
|
179
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithURL::MachineDetectionBeepProfile, nil]
|
|
180
|
+
optional :machine_detection_beep_profile,
|
|
181
|
+
enum: -> {
|
|
182
|
+
Telnyx::Texml::Accounts::CallCallsParams::Body::WithURL::MachineDetectionBeepProfile
|
|
183
|
+
},
|
|
184
|
+
api_name: :MachineDetectionBeepProfile
|
|
185
|
+
|
|
173
186
|
# @!attribute machine_detection_prompt_end_timeout
|
|
174
187
|
# Silence duration threshold after a call screening prompt before ending prompt
|
|
175
188
|
# detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
|
|
@@ -396,7 +409,7 @@ module Telnyx
|
|
|
396
409
|
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Body::WithURL::URLMethod },
|
|
397
410
|
api_name: :UrlMethod
|
|
398
411
|
|
|
399
|
-
# @!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, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_prompt_end_timeout: 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)
|
|
412
|
+
# @!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, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_beep_profile: nil, machine_detection_prompt_end_timeout: 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)
|
|
400
413
|
# Some parameter documentations has been truncated, see
|
|
401
414
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithURL} for more
|
|
402
415
|
# details.
|
|
@@ -433,6 +446,8 @@ module Telnyx
|
|
|
433
446
|
#
|
|
434
447
|
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithURL::MachineDetection] Enables Answering Machine Detection.
|
|
435
448
|
#
|
|
449
|
+
# @param machine_detection_beep_profile [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithURL::MachineDetectionBeepProfile] Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
450
|
+
#
|
|
436
451
|
# @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
|
|
437
452
|
#
|
|
438
453
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
@@ -581,6 +596,22 @@ module Telnyx
|
|
|
581
596
|
# @return [Array<Symbol>]
|
|
582
597
|
end
|
|
583
598
|
|
|
599
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
600
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
601
|
+
# beeps whose volume is too unsteady for the default profile. Only used when
|
|
602
|
+
# MachineDetection is enabled.
|
|
603
|
+
#
|
|
604
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithURL#machine_detection_beep_profile
|
|
605
|
+
module MachineDetectionBeepProfile
|
|
606
|
+
extend Telnyx::Internal::Type::Enum
|
|
607
|
+
|
|
608
|
+
BOTH = :both
|
|
609
|
+
FREQ_ONLY = :freq_only
|
|
610
|
+
|
|
611
|
+
# @!method self.values
|
|
612
|
+
# @return [Array<Symbol>]
|
|
613
|
+
end
|
|
614
|
+
|
|
584
615
|
# Defines whether media should be encrypted on the call. When set to `SRTP`, the
|
|
585
616
|
# call will use Secure Real-time Transport Protocol for media encryption. When set
|
|
586
617
|
# to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
|
|
@@ -850,6 +881,19 @@ module Telnyx
|
|
|
850
881
|
},
|
|
851
882
|
api_name: :MachineDetection
|
|
852
883
|
|
|
884
|
+
# @!attribute machine_detection_beep_profile
|
|
885
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
886
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
887
|
+
# beeps whose volume is too unsteady for the default profile. Only used when
|
|
888
|
+
# MachineDetection is enabled.
|
|
889
|
+
#
|
|
890
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithTeXml::MachineDetectionBeepProfile, nil]
|
|
891
|
+
optional :machine_detection_beep_profile,
|
|
892
|
+
enum: -> {
|
|
893
|
+
Telnyx::Texml::Accounts::CallCallsParams::Body::WithTeXml::MachineDetectionBeepProfile
|
|
894
|
+
},
|
|
895
|
+
api_name: :MachineDetectionBeepProfile
|
|
896
|
+
|
|
853
897
|
# @!attribute machine_detection_prompt_end_timeout
|
|
854
898
|
# Silence duration threshold after a call screening prompt before ending prompt
|
|
855
899
|
# detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
|
|
@@ -1080,7 +1124,7 @@ module Telnyx
|
|
|
1080
1124
|
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Body::WithTeXml::URLMethod },
|
|
1081
1125
|
api_name: :UrlMethod
|
|
1082
1126
|
|
|
1083
|
-
# @!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, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_prompt_end_timeout: 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)
|
|
1127
|
+
# @!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, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_beep_profile: nil, machine_detection_prompt_end_timeout: 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)
|
|
1084
1128
|
# Some parameter documentations has been truncated, see
|
|
1085
1129
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithTeXml} for more
|
|
1086
1130
|
# details.
|
|
@@ -1117,6 +1161,8 @@ module Telnyx
|
|
|
1117
1161
|
#
|
|
1118
1162
|
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithTeXml::MachineDetection] Enables Answering Machine Detection.
|
|
1119
1163
|
#
|
|
1164
|
+
# @param machine_detection_beep_profile [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithTeXml::MachineDetectionBeepProfile] Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
1165
|
+
#
|
|
1120
1166
|
# @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
|
|
1121
1167
|
#
|
|
1122
1168
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
@@ -1265,6 +1311,22 @@ module Telnyx
|
|
|
1265
1311
|
# @return [Array<Symbol>]
|
|
1266
1312
|
end
|
|
1267
1313
|
|
|
1314
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
1315
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
1316
|
+
# beeps whose volume is too unsteady for the default profile. Only used when
|
|
1317
|
+
# MachineDetection is enabled.
|
|
1318
|
+
#
|
|
1319
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithTeXml#machine_detection_beep_profile
|
|
1320
|
+
module MachineDetectionBeepProfile
|
|
1321
|
+
extend Telnyx::Internal::Type::Enum
|
|
1322
|
+
|
|
1323
|
+
BOTH = :both
|
|
1324
|
+
FREQ_ONLY = :freq_only
|
|
1325
|
+
|
|
1326
|
+
# @!method self.values
|
|
1327
|
+
# @return [Array<Symbol>]
|
|
1328
|
+
end
|
|
1329
|
+
|
|
1268
1330
|
# Defines whether media should be encrypted on the call. When set to `SRTP`, the
|
|
1269
1331
|
# call will use Secure Real-time Transport Protocol for media encryption. When set
|
|
1270
1332
|
# to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
|
|
@@ -1529,6 +1591,19 @@ module Telnyx
|
|
|
1529
1591
|
},
|
|
1530
1592
|
api_name: :MachineDetection
|
|
1531
1593
|
|
|
1594
|
+
# @!attribute machine_detection_beep_profile
|
|
1595
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
1596
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
1597
|
+
# beeps whose volume is too unsteady for the default profile. Only used when
|
|
1598
|
+
# MachineDetection is enabled.
|
|
1599
|
+
#
|
|
1600
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::MachineDetectionBeepProfile, nil]
|
|
1601
|
+
optional :machine_detection_beep_profile,
|
|
1602
|
+
enum: -> {
|
|
1603
|
+
Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::MachineDetectionBeepProfile
|
|
1604
|
+
},
|
|
1605
|
+
api_name: :MachineDetectionBeepProfile
|
|
1606
|
+
|
|
1532
1607
|
# @!attribute machine_detection_prompt_end_timeout
|
|
1533
1608
|
# Silence duration threshold after a call screening prompt before ending prompt
|
|
1534
1609
|
# detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
|
|
@@ -1770,7 +1845,7 @@ module Telnyx
|
|
|
1770
1845
|
},
|
|
1771
1846
|
api_name: :UrlMethod
|
|
1772
1847
|
|
|
1773
|
-
# @!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, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_prompt_end_timeout: 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)
|
|
1848
|
+
# @!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, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_beep_profile: nil, machine_detection_prompt_end_timeout: 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)
|
|
1774
1849
|
# Some parameter documentations has been truncated, see
|
|
1775
1850
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Body::ApplicationDefault} for
|
|
1776
1851
|
# more details.
|
|
@@ -1805,6 +1880,8 @@ module Telnyx
|
|
|
1805
1880
|
#
|
|
1806
1881
|
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::MachineDetection] Enables Answering Machine Detection.
|
|
1807
1882
|
#
|
|
1883
|
+
# @param machine_detection_beep_profile [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::MachineDetectionBeepProfile] Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
1884
|
+
#
|
|
1808
1885
|
# @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
|
|
1809
1886
|
#
|
|
1810
1887
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
@@ -1955,6 +2032,22 @@ module Telnyx
|
|
|
1955
2032
|
# @return [Array<Symbol>]
|
|
1956
2033
|
end
|
|
1957
2034
|
|
|
2035
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
2036
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
2037
|
+
# beeps whose volume is too unsteady for the default profile. Only used when
|
|
2038
|
+
# MachineDetection is enabled.
|
|
2039
|
+
#
|
|
2040
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Body::ApplicationDefault#machine_detection_beep_profile
|
|
2041
|
+
module MachineDetectionBeepProfile
|
|
2042
|
+
extend Telnyx::Internal::Type::Enum
|
|
2043
|
+
|
|
2044
|
+
BOTH = :both
|
|
2045
|
+
FREQ_ONLY = :freq_only
|
|
2046
|
+
|
|
2047
|
+
# @!method self.values
|
|
2048
|
+
# @return [Array<Symbol>]
|
|
2049
|
+
end
|
|
2050
|
+
|
|
1958
2051
|
# Defines whether media should be encrypted on the call. When set to `SRTP`, the
|
|
1959
2052
|
# call will use Secure Real-time Transport Protocol for media encryption. When set
|
|
1960
2053
|
# to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
|
|
@@ -230,6 +230,19 @@ module Telnyx
|
|
|
230
230
|
},
|
|
231
231
|
api_name: :MachineDetection
|
|
232
232
|
|
|
233
|
+
# @!attribute machine_detection_beep_profile
|
|
234
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
235
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
236
|
+
# beeps whose volume is too unsteady for the default profile. Only used when
|
|
237
|
+
# MachineDetection is enabled.
|
|
238
|
+
#
|
|
239
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::Conferences::ParticipantParticipantsParams::MachineDetectionBeepProfile, nil]
|
|
240
|
+
optional :machine_detection_beep_profile,
|
|
241
|
+
enum: -> {
|
|
242
|
+
Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::MachineDetectionBeepProfile
|
|
243
|
+
},
|
|
244
|
+
api_name: :MachineDetectionBeepProfile
|
|
245
|
+
|
|
233
246
|
# @!attribute machine_detection_silence_timeout
|
|
234
247
|
# If initial silence duration is greater than this value, consider it a machine.
|
|
235
248
|
# Ignored when `premium` detection is used.
|
|
@@ -410,7 +423,7 @@ module Telnyx
|
|
|
410
423
|
# @return [String, nil]
|
|
411
424
|
optional :wait_url, String, api_name: :WaitUrl
|
|
412
425
|
|
|
413
|
-
# @!method initialize(account_sid:, conference_sid:, amd_status_callback: nil, amd_status_callback_method: nil, application_sid: nil, beep: nil, caller_id: nil, call_sid_to_coach: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, coaching: nil, conference_record: nil, conference_recording_status_callback: nil, conference_recording_status_callback_event: nil, conference_recording_status_callback_method: nil, conference_recording_timeout: nil, conference_status_callback: nil, conference_status_callback_event: nil, conference_status_callback_method: nil, conference_trim: nil, custom_headers: nil, early_media: nil, end_conference_on_exit: nil, from: nil, label: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, max_participants: nil, muted: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_track: nil, sip_auth_password: nil, sip_auth_username: nil, start_conference_on_enter: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, time_limit: nil, timeout_seconds: nil, to: nil, trim: nil, wait_url: nil, request_options: {})
|
|
426
|
+
# @!method initialize(account_sid:, conference_sid:, amd_status_callback: nil, amd_status_callback_method: nil, application_sid: nil, beep: nil, caller_id: nil, call_sid_to_coach: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, coaching: nil, conference_record: nil, conference_recording_status_callback: nil, conference_recording_status_callback_event: nil, conference_recording_status_callback_method: nil, conference_recording_timeout: nil, conference_status_callback: nil, conference_status_callback_event: nil, conference_status_callback_method: nil, conference_trim: nil, custom_headers: nil, early_media: nil, end_conference_on_exit: nil, from: nil, label: nil, machine_detection: nil, machine_detection_beep_profile: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, max_participants: nil, muted: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_track: nil, sip_auth_password: nil, sip_auth_username: nil, start_conference_on_enter: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, time_limit: nil, timeout_seconds: nil, to: nil, trim: nil, wait_url: nil, request_options: {})
|
|
414
427
|
# Some parameter documentations has been truncated, see
|
|
415
428
|
# {Telnyx::Models::Texml::Accounts::Conferences::ParticipantParticipantsParams}
|
|
416
429
|
# for more details.
|
|
@@ -467,6 +480,8 @@ module Telnyx
|
|
|
467
480
|
#
|
|
468
481
|
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::Conferences::ParticipantParticipantsParams::MachineDetection] Whether to detect if a human or an answering machine picked up the call. Use `En
|
|
469
482
|
#
|
|
483
|
+
# @param machine_detection_beep_profile [Symbol, Telnyx::Models::Texml::Accounts::Conferences::ParticipantParticipantsParams::MachineDetectionBeepProfile] Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
484
|
+
#
|
|
470
485
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
471
486
|
#
|
|
472
487
|
# @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere
|
|
@@ -625,6 +640,20 @@ module Telnyx
|
|
|
625
640
|
# @return [Array<Symbol>]
|
|
626
641
|
end
|
|
627
642
|
|
|
643
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
644
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
645
|
+
# beeps whose volume is too unsteady for the default profile. Only used when
|
|
646
|
+
# MachineDetection is enabled.
|
|
647
|
+
module MachineDetectionBeepProfile
|
|
648
|
+
extend Telnyx::Internal::Type::Enum
|
|
649
|
+
|
|
650
|
+
BOTH = :both
|
|
651
|
+
FREQ_ONLY = :freq_only
|
|
652
|
+
|
|
653
|
+
# @!method self.values
|
|
654
|
+
# @return [Array<Symbol>]
|
|
655
|
+
end
|
|
656
|
+
|
|
628
657
|
# The number of channels in the final recording. Defaults to `mono`.
|
|
629
658
|
module RecordingChannels
|
|
630
659
|
extend Telnyx::Internal::Type::Enum
|
|
@@ -127,6 +127,17 @@ module Telnyx
|
|
|
127
127
|
enum: -> { Telnyx::TexmlInitiateAICallParams::MachineDetection },
|
|
128
128
|
api_name: :MachineDetection
|
|
129
129
|
|
|
130
|
+
# @!attribute machine_detection_beep_profile
|
|
131
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
132
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
133
|
+
# beeps whose volume is too unsteady for the default profile. Only used when
|
|
134
|
+
# MachineDetection is enabled.
|
|
135
|
+
#
|
|
136
|
+
# @return [Symbol, Telnyx::Models::TexmlInitiateAICallParams::MachineDetectionBeepProfile, nil]
|
|
137
|
+
optional :machine_detection_beep_profile,
|
|
138
|
+
enum: -> { Telnyx::TexmlInitiateAICallParams::MachineDetectionBeepProfile },
|
|
139
|
+
api_name: :MachineDetectionBeepProfile
|
|
140
|
+
|
|
130
141
|
# @!attribute machine_detection_prompt_end_timeout
|
|
131
142
|
# Silence duration threshold after a call screening prompt before ending prompt
|
|
132
143
|
# detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
|
|
@@ -307,7 +318,7 @@ module Telnyx
|
|
|
307
318
|
# @return [Symbol, Telnyx::Models::TexmlInitiateAICallParams::Trim, nil]
|
|
308
319
|
optional :trim, enum: -> { Telnyx::TexmlInitiateAICallParams::Trim }, api_name: :Trim
|
|
309
320
|
|
|
310
|
-
# @!method initialize(connection_id:, ai_assistant_id:, from:, to:, ai_assistant_dynamic_variables: nil, ai_assistant_version: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, conversation_callback: nil, conversation_callback_method: nil, conversation_callbacks: nil, custom_headers: nil, detection_mode: nil, machine_detection: nil, machine_detection_prompt_end_timeout: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, passports: 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, status_callbacks: nil, time_limit: nil, timeout_seconds: nil, trim: nil, request_options: {})
|
|
321
|
+
# @!method initialize(connection_id:, ai_assistant_id:, from:, to:, ai_assistant_dynamic_variables: nil, ai_assistant_version: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, conversation_callback: nil, conversation_callback_method: nil, conversation_callbacks: nil, custom_headers: nil, detection_mode: nil, machine_detection: nil, machine_detection_beep_profile: nil, machine_detection_prompt_end_timeout: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, passports: 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, status_callbacks: nil, time_limit: nil, timeout_seconds: nil, trim: nil, request_options: {})
|
|
311
322
|
# Some parameter documentations has been truncated, see
|
|
312
323
|
# {Telnyx::Models::TexmlInitiateAICallParams} for more details.
|
|
313
324
|
#
|
|
@@ -343,6 +354,8 @@ module Telnyx
|
|
|
343
354
|
#
|
|
344
355
|
# @param machine_detection [Symbol, Telnyx::Models::TexmlInitiateAICallParams::MachineDetection] Enables Answering Machine Detection.
|
|
345
356
|
#
|
|
357
|
+
# @param machine_detection_beep_profile [Symbol, Telnyx::Models::TexmlInitiateAICallParams::MachineDetectionBeepProfile] Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
358
|
+
#
|
|
346
359
|
# @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
|
|
347
360
|
#
|
|
348
361
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
@@ -462,6 +475,20 @@ module Telnyx
|
|
|
462
475
|
# @return [Array<Symbol>]
|
|
463
476
|
end
|
|
464
477
|
|
|
478
|
+
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
479
|
+
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
480
|
+
# beeps whose volume is too unsteady for the default profile. Only used when
|
|
481
|
+
# MachineDetection is enabled.
|
|
482
|
+
module MachineDetectionBeepProfile
|
|
483
|
+
extend Telnyx::Internal::Type::Enum
|
|
484
|
+
|
|
485
|
+
BOTH = :both
|
|
486
|
+
FREQ_ONLY = :freq_only
|
|
487
|
+
|
|
488
|
+
# @!method self.values
|
|
489
|
+
# @return [Array<Symbol>]
|
|
490
|
+
end
|
|
491
|
+
|
|
465
492
|
# The number of channels in the final recording. Defaults to `mono`.
|
|
466
493
|
module RecordingChannels
|
|
467
494
|
extend Telnyx::Internal::Type::Enum
|
|
@@ -151,7 +151,7 @@ module Telnyx
|
|
|
151
151
|
)
|
|
152
152
|
end
|
|
153
153
|
|
|
154
|
-
#
|
|
154
|
+
# Lists messaging profiles owned by the authenticated account. Apply the
|
|
155
155
|
# documented filters and pagination parameters to narrow the result set.
|
|
156
156
|
#
|
|
157
157
|
# @overload list(filter: nil, filter_name_contains: nil, filter_name_eq: nil, page_number: nil, page_size: nil, request_options: {})
|
|
@@ -155,7 +155,7 @@ module Telnyx
|
|
|
155
155
|
#
|
|
156
156
|
# Dials a new conference participant
|
|
157
157
|
#
|
|
158
|
-
# @overload participants(conference_sid, account_sid:, amd_status_callback: nil, amd_status_callback_method: nil, application_sid: nil, beep: nil, caller_id: nil, call_sid_to_coach: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, coaching: nil, conference_record: nil, conference_recording_status_callback: nil, conference_recording_status_callback_event: nil, conference_recording_status_callback_method: nil, conference_recording_timeout: nil, conference_status_callback: nil, conference_status_callback_event: nil, conference_status_callback_method: nil, conference_trim: nil, custom_headers: nil, early_media: nil, end_conference_on_exit: nil, from: nil, label: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, max_participants: nil, muted: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_track: nil, sip_auth_password: nil, sip_auth_username: nil, start_conference_on_enter: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, time_limit: nil, timeout_seconds: nil, to: nil, trim: nil, wait_url: nil, request_options: {})
|
|
158
|
+
# @overload participants(conference_sid, account_sid:, amd_status_callback: nil, amd_status_callback_method: nil, application_sid: nil, beep: nil, caller_id: nil, call_sid_to_coach: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, coaching: nil, conference_record: nil, conference_recording_status_callback: nil, conference_recording_status_callback_event: nil, conference_recording_status_callback_method: nil, conference_recording_timeout: nil, conference_status_callback: nil, conference_status_callback_event: nil, conference_status_callback_method: nil, conference_trim: nil, custom_headers: nil, early_media: nil, end_conference_on_exit: nil, from: nil, label: nil, machine_detection: nil, machine_detection_beep_profile: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, max_participants: nil, muted: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_track: nil, sip_auth_password: nil, sip_auth_username: nil, start_conference_on_enter: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, time_limit: nil, timeout_seconds: nil, to: nil, trim: nil, wait_url: nil, request_options: {})
|
|
159
159
|
#
|
|
160
160
|
# @param conference_sid [String] Path param: The ConferenceSid that uniquely identifies a conference.
|
|
161
161
|
#
|
|
@@ -209,6 +209,8 @@ module Telnyx
|
|
|
209
209
|
#
|
|
210
210
|
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::Conferences::ParticipantParticipantsParams::MachineDetection] Body param: Whether to detect if a human or an answering machine picked up the c
|
|
211
211
|
#
|
|
212
|
+
# @param machine_detection_beep_profile [Symbol, Telnyx::Models::Texml::Accounts::Conferences::ParticipantParticipantsParams::MachineDetectionBeepProfile] Body param: Selects which detectors must validate a beep. `both` requires the am
|
|
213
|
+
#
|
|
212
214
|
# @param machine_detection_silence_timeout [Integer] Body param: If initial silence duration is greater than this value, consider it
|
|
213
215
|
#
|
|
214
216
|
# @param machine_detection_speech_end_threshold [Integer] Body param: Silence duration threshold after a greeting message or voice for it
|
|
@@ -27,7 +27,7 @@ module Telnyx
|
|
|
27
27
|
# Recording, AMD, transcription, and deepfake detection callbacks are only sent
|
|
28
28
|
# when those features are enabled.
|
|
29
29
|
#
|
|
30
|
-
# @overload initiate_ai_call(connection_id, ai_assistant_id:, from:, to:, ai_assistant_dynamic_variables: nil, ai_assistant_version: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, conversation_callback: nil, conversation_callback_method: nil, conversation_callbacks: nil, custom_headers: nil, detection_mode: nil, machine_detection: nil, machine_detection_prompt_end_timeout: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, passports: 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, status_callbacks: nil, time_limit: nil, timeout_seconds: nil, trim: nil, request_options: {})
|
|
30
|
+
# @overload initiate_ai_call(connection_id, ai_assistant_id:, from:, to:, ai_assistant_dynamic_variables: nil, ai_assistant_version: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, conversation_callback: nil, conversation_callback_method: nil, conversation_callbacks: nil, custom_headers: nil, detection_mode: nil, machine_detection: nil, machine_detection_beep_profile: nil, machine_detection_prompt_end_timeout: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, passports: 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, status_callbacks: nil, time_limit: nil, timeout_seconds: nil, trim: nil, request_options: {})
|
|
31
31
|
#
|
|
32
32
|
# @param connection_id [String] The ID of the TeXML connection to use for the call.
|
|
33
33
|
#
|
|
@@ -61,6 +61,8 @@ module Telnyx
|
|
|
61
61
|
#
|
|
62
62
|
# @param machine_detection [Symbol, Telnyx::Models::TexmlInitiateAICallParams::MachineDetection] Enables Answering Machine Detection.
|
|
63
63
|
#
|
|
64
|
+
# @param machine_detection_beep_profile [Symbol, Telnyx::Models::TexmlInitiateAICallParams::MachineDetectionBeepProfile] Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
65
|
+
#
|
|
64
66
|
# @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
|
|
65
67
|
#
|
|
66
68
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
data/lib/telnyx/version.rb
CHANGED