telnyx 5.85.0 → 5.87.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 +17 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/transcription_settings.rb +32 -13
- data/lib/telnyx/models/ai/transcription_settings_config.rb +30 -1
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +189 -3
- data/lib/telnyx/models/verify_profile.rb +17 -71
- data/lib/telnyx/models/verify_profile_create_params.rb +25 -69
- data/lib/telnyx/models/verify_profile_update_params.rb +23 -111
- data/lib/telnyx/resources/verify_profiles.rb +17 -6
- data/lib/telnyx/version.rb +1 -1
- data/rbi/telnyx/models/ai/transcription_settings.rbi +51 -16
- data/rbi/telnyx/models/ai/transcription_settings_config.rbi +43 -0
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +396 -0
- data/rbi/telnyx/models/verify_profile.rbi +22 -115
- data/rbi/telnyx/models/verify_profile_create_params.rbi +22 -118
- data/rbi/telnyx/models/verify_profile_update_params.rbi +20 -205
- data/rbi/telnyx/resources/verify_profiles.rbi +12 -6
- data/sig/telnyx/models/ai/transcription_settings.rbs +11 -0
- data/sig/telnyx/models/ai/transcription_settings_config.rbs +21 -0
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +138 -0
- data/sig/telnyx/models/verify_profile.rbs +14 -61
- data/sig/telnyx/models/verify_profile_create_params.rbs +14 -63
- data/sig/telnyx/models/verify_profile_update_params.rbs +12 -103
- data/sig/telnyx/resources/verify_profiles.rbs +4 -3
- 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: ffcd66b079e3b1f383cf0129abf12b67c82ce21c68c0c18fb655abce95ef4361
|
|
4
|
+
data.tar.gz: 0d06a0b499a3bb279bec8a233cb5057be066bd5da0c9213bc16178711b98b981
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1eaf982495df8c429c4a9f6feb93565e8167e68d068fbc93c1cf7502944607c361a4266c4330e73832d99accc580f274ca6b0ca3891986653ade9de540c54f55
|
|
7
|
+
data.tar.gz: f2877aeee3f1283b58dbb572f23eef9f1bd99b17a995648cde69c0780eebe6e077644bb71d9d4c366bf749ea5d013cc6f6a0623d2f76aa995da2d041a3b15793
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.87.0 (2026-04-28)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.86.0...v5.87.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.86.0...v5.87.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* TELAPPS-5725: Add deepfake detection params to call-scripting API docs ([f2d8e6c](https://github.com/team-telnyx/telnyx-ruby/commit/f2d8e6cff7100ae63512bb6d26f354d680fcc428))
|
|
10
|
+
|
|
11
|
+
## 5.86.0 (2026-04-28)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v5.85.0...v5.86.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.85.0...v5.86.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* Fix CreateVerifyProfileRequest to match messaging-2fa schema ([e64fe7b](https://github.com/team-telnyx/telnyx-ruby/commit/e64fe7bc0d090d86080445a4dbe149a216a09895))
|
|
18
|
+
* Update assistant transcription settings spec ([172cab5](https://github.com/team-telnyx/telnyx-ruby/commit/172cab549f428deb1fe9432bf91a1fa7fa9a9956))
|
|
19
|
+
|
|
3
20
|
## 5.85.0 (2026-04-27)
|
|
4
21
|
|
|
5
22
|
Full Changelog: [v5.84.0...v5.85.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.84.0...v5.85.0)
|
data/README.md
CHANGED
|
@@ -4,27 +4,38 @@ module Telnyx
|
|
|
4
4
|
module Models
|
|
5
5
|
module AI
|
|
6
6
|
class TranscriptionSettings < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute api_key_ref
|
|
8
|
+
# Integration secret identifier for the transcription provider API key. Currently
|
|
9
|
+
# used for Azure transcription regions that require a customer-provided API key.
|
|
10
|
+
#
|
|
11
|
+
# @return [String, nil]
|
|
12
|
+
optional :api_key_ref, String
|
|
13
|
+
|
|
7
14
|
# @!attribute language
|
|
8
|
-
# The language of the audio to be transcribed. If not set,
|
|
15
|
+
# The language of the audio to be transcribed. If not set, or if set to `auto`,
|
|
9
16
|
# the model will automatically detect the language.
|
|
10
17
|
#
|
|
11
18
|
# @return [String, nil]
|
|
12
19
|
optional :language, String
|
|
13
20
|
|
|
14
21
|
# @!attribute model
|
|
15
|
-
# The speech to text model to be used by the voice assistant. All
|
|
16
|
-
#
|
|
22
|
+
# The speech to text model to be used by the voice assistant. All Deepgram models
|
|
23
|
+
# are run on-premise.
|
|
17
24
|
#
|
|
18
25
|
# - `deepgram/flux` is optimized for turn-taking but is English-only.
|
|
19
|
-
# - `deepgram/nova-3` is
|
|
20
|
-
#
|
|
26
|
+
# - `deepgram/nova-3` is multilingual with automatic language detection.
|
|
27
|
+
# - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
|
|
28
|
+
# - `azure/fast` is a multilingual Azure transcription model.
|
|
29
|
+
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
30
|
+
# configurable turn detection.
|
|
31
|
+
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
21
32
|
#
|
|
22
33
|
# @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model, nil]
|
|
23
34
|
optional :model, enum: -> { Telnyx::AI::TranscriptionSettings::Model }
|
|
24
35
|
|
|
25
36
|
# @!attribute region
|
|
26
37
|
# Region on third party cloud providers (currently Azure) if using one of their
|
|
27
|
-
# models
|
|
38
|
+
# models. Some regions require `api_key_ref`.
|
|
28
39
|
#
|
|
29
40
|
# @return [String, nil]
|
|
30
41
|
optional :region, String
|
|
@@ -34,24 +45,30 @@ module Telnyx
|
|
|
34
45
|
# @return [Telnyx::Models::AI::TranscriptionSettingsConfig, nil]
|
|
35
46
|
optional :settings, -> { Telnyx::AI::TranscriptionSettingsConfig }
|
|
36
47
|
|
|
37
|
-
# @!method initialize(language: nil, model: nil, region: nil, settings: nil)
|
|
48
|
+
# @!method initialize(api_key_ref: nil, language: nil, model: nil, region: nil, settings: nil)
|
|
38
49
|
# Some parameter documentations has been truncated, see
|
|
39
50
|
# {Telnyx::Models::AI::TranscriptionSettings} for more details.
|
|
40
51
|
#
|
|
41
|
-
# @param
|
|
52
|
+
# @param api_key_ref [String] Integration secret identifier for the transcription provider API key. Currently
|
|
53
|
+
#
|
|
54
|
+
# @param language [String] The language of the audio to be transcribed. If not set, or if set to `auto`, th
|
|
42
55
|
#
|
|
43
|
-
# @param model [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model] The speech to text model to be used by the voice assistant. All
|
|
56
|
+
# @param model [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model] The speech to text model to be used by the voice assistant. All Deepgram models
|
|
44
57
|
#
|
|
45
58
|
# @param region [String] Region on third party cloud providers (currently Azure) if using one of their mo
|
|
46
59
|
#
|
|
47
60
|
# @param settings [Telnyx::Models::AI::TranscriptionSettingsConfig]
|
|
48
61
|
|
|
49
|
-
# The speech to text model to be used by the voice assistant. All
|
|
50
|
-
#
|
|
62
|
+
# The speech to text model to be used by the voice assistant. All Deepgram models
|
|
63
|
+
# are run on-premise.
|
|
51
64
|
#
|
|
52
65
|
# - `deepgram/flux` is optimized for turn-taking but is English-only.
|
|
53
|
-
# - `deepgram/nova-3` is
|
|
54
|
-
#
|
|
66
|
+
# - `deepgram/nova-3` is multilingual with automatic language detection.
|
|
67
|
+
# - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
|
|
68
|
+
# - `azure/fast` is a multilingual Azure transcription model.
|
|
69
|
+
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
70
|
+
# configurable turn detection.
|
|
71
|
+
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
55
72
|
#
|
|
56
73
|
# @see Telnyx::Models::AI::TranscriptionSettings#model
|
|
57
74
|
module Model
|
|
@@ -61,6 +78,8 @@ module Telnyx
|
|
|
61
78
|
DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
|
|
62
79
|
DEEPGRAM_NOVA_2 = :"deepgram/nova-2"
|
|
63
80
|
AZURE_FAST = :"azure/fast"
|
|
81
|
+
ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
|
|
82
|
+
XAI_GROK_STT = :"xai/grok-stt"
|
|
64
83
|
DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
|
|
65
84
|
OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
|
|
66
85
|
|
|
@@ -12,6 +12,14 @@ module Telnyx
|
|
|
12
12
|
# @return [Float, nil]
|
|
13
13
|
optional :eager_eot_threshold, Float
|
|
14
14
|
|
|
15
|
+
# @!attribute end_of_turn_confidence_threshold
|
|
16
|
+
# Available only for assemblyai/universal-streaming. Confidence level required to
|
|
17
|
+
# trigger an end of turn. Higher values require more certainty before ending a
|
|
18
|
+
# turn.
|
|
19
|
+
#
|
|
20
|
+
# @return [Float, nil]
|
|
21
|
+
optional :end_of_turn_confidence_threshold, Float
|
|
22
|
+
|
|
15
23
|
# @!attribute eot_threshold
|
|
16
24
|
# Available only for deepgram/flux. Confidence required to trigger an end of turn.
|
|
17
25
|
# Higher values = more reliable turn detection but slightly increased latency.
|
|
@@ -34,6 +42,21 @@ module Telnyx
|
|
|
34
42
|
# @return [String, nil]
|
|
35
43
|
optional :keyterm, String
|
|
36
44
|
|
|
45
|
+
# @!attribute max_turn_silence
|
|
46
|
+
# Available only for assemblyai/universal-streaming. Maximum duration of silence
|
|
47
|
+
# in milliseconds before forcing an end of turn.
|
|
48
|
+
#
|
|
49
|
+
# @return [Integer, nil]
|
|
50
|
+
optional :max_turn_silence, Integer
|
|
51
|
+
|
|
52
|
+
# @!attribute min_turn_silence
|
|
53
|
+
# Available only for assemblyai/universal-streaming. Minimum duration of silence
|
|
54
|
+
# in milliseconds before a turn can end. Must be less than or equal to
|
|
55
|
+
# max_turn_silence.
|
|
56
|
+
#
|
|
57
|
+
# @return [Integer, nil]
|
|
58
|
+
optional :min_turn_silence, Integer
|
|
59
|
+
|
|
37
60
|
# @!attribute numerals
|
|
38
61
|
#
|
|
39
62
|
# @return [Boolean, nil]
|
|
@@ -44,18 +67,24 @@ module Telnyx
|
|
|
44
67
|
# @return [Boolean, nil]
|
|
45
68
|
optional :smart_format, Telnyx::Internal::Type::Boolean
|
|
46
69
|
|
|
47
|
-
# @!method initialize(eager_eot_threshold: nil, eot_threshold: nil, eot_timeout_ms: nil, keyterm: nil, numerals: nil, smart_format: nil)
|
|
70
|
+
# @!method initialize(eager_eot_threshold: nil, end_of_turn_confidence_threshold: nil, eot_threshold: nil, eot_timeout_ms: nil, keyterm: nil, max_turn_silence: nil, min_turn_silence: nil, numerals: nil, smart_format: nil)
|
|
48
71
|
# Some parameter documentations has been truncated, see
|
|
49
72
|
# {Telnyx::Models::AI::TranscriptionSettingsConfig} for more details.
|
|
50
73
|
#
|
|
51
74
|
# @param eager_eot_threshold [Float] Available only for deepgram/flux. Confidence threshold for eager end of turn det
|
|
52
75
|
#
|
|
76
|
+
# @param end_of_turn_confidence_threshold [Float] Available only for assemblyai/universal-streaming. Confidence level required to
|
|
77
|
+
#
|
|
53
78
|
# @param eot_threshold [Float] Available only for deepgram/flux. Confidence required to trigger an end of turn.
|
|
54
79
|
#
|
|
55
80
|
# @param eot_timeout_ms [Integer] Available only for deepgram/flux. Maximum milliseconds of silence before forcing
|
|
56
81
|
#
|
|
57
82
|
# @param keyterm [String] Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of
|
|
58
83
|
#
|
|
84
|
+
# @param max_turn_silence [Integer] Available only for assemblyai/universal-streaming. Maximum duration of silence i
|
|
85
|
+
#
|
|
86
|
+
# @param min_turn_silence [Integer] Available only for assemblyai/universal-streaming. Minimum duration of silence i
|
|
87
|
+
#
|
|
59
88
|
# @param numerals [Boolean]
|
|
60
89
|
#
|
|
61
90
|
# @param smart_format [Boolean]
|
|
@@ -107,6 +107,35 @@ module Telnyx
|
|
|
107
107
|
},
|
|
108
108
|
api_name: :CustomHeaders
|
|
109
109
|
|
|
110
|
+
# @!attribute deepfake_detection
|
|
111
|
+
# Enables Deepfake Detection on the dialed call. When enabled, audio from the
|
|
112
|
+
# remote party is analyzed to determine whether the voice is AI-generated. Results
|
|
113
|
+
# are delivered asynchronously via a callback.
|
|
114
|
+
#
|
|
115
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetection, nil]
|
|
116
|
+
optional :deepfake_detection,
|
|
117
|
+
enum: -> {
|
|
118
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetection
|
|
119
|
+
},
|
|
120
|
+
api_name: :DeepfakeDetection
|
|
121
|
+
|
|
122
|
+
# @!attribute deepfake_detection_callback_method
|
|
123
|
+
# HTTP request type used for `DeepfakeDetectionCallbackUrl`.
|
|
124
|
+
#
|
|
125
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetectionCallbackMethod, nil]
|
|
126
|
+
optional :deepfake_detection_callback_method,
|
|
127
|
+
enum: -> {
|
|
128
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetectionCallbackMethod
|
|
129
|
+
},
|
|
130
|
+
api_name: :DeepfakeDetectionCallbackMethod
|
|
131
|
+
|
|
132
|
+
# @!attribute deepfake_detection_callback_url
|
|
133
|
+
# URL destination for Telnyx to send deepfake detection callback events to for the
|
|
134
|
+
# call.
|
|
135
|
+
#
|
|
136
|
+
# @return [String, nil]
|
|
137
|
+
optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
|
|
138
|
+
|
|
110
139
|
# @!attribute detection_mode
|
|
111
140
|
# Allows you to chose between Premium and Standard detections.
|
|
112
141
|
#
|
|
@@ -364,7 +393,7 @@ module Telnyx
|
|
|
364
393
|
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::URLMethod },
|
|
365
394
|
api_name: :UrlMethod
|
|
366
395
|
|
|
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)
|
|
396
|
+
# @!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_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)
|
|
368
397
|
# Some parameter documentations has been truncated, see
|
|
369
398
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL} for more
|
|
370
399
|
# details.
|
|
@@ -387,6 +416,12 @@ module Telnyx
|
|
|
387
416
|
#
|
|
388
417
|
# @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
|
|
389
418
|
#
|
|
419
|
+
# @param deepfake_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetection] Enables Deepfake Detection on the dialed call. When enabled, audio from the remo
|
|
420
|
+
#
|
|
421
|
+
# @param deepfake_detection_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetectionCallbackMethod] HTTP request type used for `DeepfakeDetectionCallbackUrl`.
|
|
422
|
+
#
|
|
423
|
+
# @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
|
|
424
|
+
#
|
|
390
425
|
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode] Allows you to chose between Premium and Standard detections.
|
|
391
426
|
#
|
|
392
427
|
# @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
|
|
@@ -484,6 +519,33 @@ module Telnyx
|
|
|
484
519
|
# @param value [String] The value of the custom header
|
|
485
520
|
end
|
|
486
521
|
|
|
522
|
+
# Enables Deepfake Detection on the dialed call. When enabled, audio from the
|
|
523
|
+
# remote party is analyzed to determine whether the voice is AI-generated. Results
|
|
524
|
+
# are delivered asynchronously via a callback.
|
|
525
|
+
#
|
|
526
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#deepfake_detection
|
|
527
|
+
module DeepfakeDetection
|
|
528
|
+
extend Telnyx::Internal::Type::Enum
|
|
529
|
+
|
|
530
|
+
ENABLE = :Enable
|
|
531
|
+
|
|
532
|
+
# @!method self.values
|
|
533
|
+
# @return [Array<Symbol>]
|
|
534
|
+
end
|
|
535
|
+
|
|
536
|
+
# HTTP request type used for `DeepfakeDetectionCallbackUrl`.
|
|
537
|
+
#
|
|
538
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#deepfake_detection_callback_method
|
|
539
|
+
module DeepfakeDetectionCallbackMethod
|
|
540
|
+
extend Telnyx::Internal::Type::Enum
|
|
541
|
+
|
|
542
|
+
GET = :GET
|
|
543
|
+
POST = :POST
|
|
544
|
+
|
|
545
|
+
# @!method self.values
|
|
546
|
+
# @return [Array<Symbol>]
|
|
547
|
+
end
|
|
548
|
+
|
|
487
549
|
# Allows you to chose between Premium and Standard detections.
|
|
488
550
|
#
|
|
489
551
|
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#detection_mode
|
|
@@ -733,6 +795,35 @@ module Telnyx
|
|
|
733
795
|
},
|
|
734
796
|
api_name: :CustomHeaders
|
|
735
797
|
|
|
798
|
+
# @!attribute deepfake_detection
|
|
799
|
+
# Enables Deepfake Detection on the dialed call. When enabled, audio from the
|
|
800
|
+
# remote party is analyzed to determine whether the voice is AI-generated. Results
|
|
801
|
+
# are delivered asynchronously via a callback.
|
|
802
|
+
#
|
|
803
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetection, nil]
|
|
804
|
+
optional :deepfake_detection,
|
|
805
|
+
enum: -> {
|
|
806
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetection
|
|
807
|
+
},
|
|
808
|
+
api_name: :DeepfakeDetection
|
|
809
|
+
|
|
810
|
+
# @!attribute deepfake_detection_callback_method
|
|
811
|
+
# HTTP request type used for `DeepfakeDetectionCallbackUrl`.
|
|
812
|
+
#
|
|
813
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetectionCallbackMethod, nil]
|
|
814
|
+
optional :deepfake_detection_callback_method,
|
|
815
|
+
enum: -> {
|
|
816
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetectionCallbackMethod
|
|
817
|
+
},
|
|
818
|
+
api_name: :DeepfakeDetectionCallbackMethod
|
|
819
|
+
|
|
820
|
+
# @!attribute deepfake_detection_callback_url
|
|
821
|
+
# URL destination for Telnyx to send deepfake detection callback events to for the
|
|
822
|
+
# call.
|
|
823
|
+
#
|
|
824
|
+
# @return [String, nil]
|
|
825
|
+
optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
|
|
826
|
+
|
|
736
827
|
# @!attribute detection_mode
|
|
737
828
|
# Allows you to chose between Premium and Standard detections.
|
|
738
829
|
#
|
|
@@ -994,7 +1085,7 @@ module Telnyx
|
|
|
994
1085
|
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::URLMethod },
|
|
995
1086
|
api_name: :UrlMethod
|
|
996
1087
|
|
|
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)
|
|
1088
|
+
# @!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_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)
|
|
998
1089
|
# Some parameter documentations has been truncated, see
|
|
999
1090
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml} for more
|
|
1000
1091
|
# details.
|
|
@@ -1017,6 +1108,12 @@ module Telnyx
|
|
|
1017
1108
|
#
|
|
1018
1109
|
# @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
|
|
1019
1110
|
#
|
|
1111
|
+
# @param deepfake_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetection] Enables Deepfake Detection on the dialed call. When enabled, audio from the remo
|
|
1112
|
+
#
|
|
1113
|
+
# @param deepfake_detection_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetectionCallbackMethod] HTTP request type used for `DeepfakeDetectionCallbackUrl`.
|
|
1114
|
+
#
|
|
1115
|
+
# @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
|
|
1116
|
+
#
|
|
1020
1117
|
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DetectionMode] Allows you to chose between Premium and Standard detections.
|
|
1021
1118
|
#
|
|
1022
1119
|
# @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
|
|
@@ -1114,6 +1211,33 @@ module Telnyx
|
|
|
1114
1211
|
# @param value [String] The value of the custom header
|
|
1115
1212
|
end
|
|
1116
1213
|
|
|
1214
|
+
# Enables Deepfake Detection on the dialed call. When enabled, audio from the
|
|
1215
|
+
# remote party is analyzed to determine whether the voice is AI-generated. Results
|
|
1216
|
+
# are delivered asynchronously via a callback.
|
|
1217
|
+
#
|
|
1218
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#deepfake_detection
|
|
1219
|
+
module DeepfakeDetection
|
|
1220
|
+
extend Telnyx::Internal::Type::Enum
|
|
1221
|
+
|
|
1222
|
+
ENABLE = :Enable
|
|
1223
|
+
|
|
1224
|
+
# @!method self.values
|
|
1225
|
+
# @return [Array<Symbol>]
|
|
1226
|
+
end
|
|
1227
|
+
|
|
1228
|
+
# HTTP request type used for `DeepfakeDetectionCallbackUrl`.
|
|
1229
|
+
#
|
|
1230
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#deepfake_detection_callback_method
|
|
1231
|
+
module DeepfakeDetectionCallbackMethod
|
|
1232
|
+
extend Telnyx::Internal::Type::Enum
|
|
1233
|
+
|
|
1234
|
+
GET = :GET
|
|
1235
|
+
POST = :POST
|
|
1236
|
+
|
|
1237
|
+
# @!method self.values
|
|
1238
|
+
# @return [Array<Symbol>]
|
|
1239
|
+
end
|
|
1240
|
+
|
|
1117
1241
|
# Allows you to chose between Premium and Standard detections.
|
|
1118
1242
|
#
|
|
1119
1243
|
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#detection_mode
|
|
@@ -1356,6 +1480,35 @@ module Telnyx
|
|
|
1356
1480
|
},
|
|
1357
1481
|
api_name: :CustomHeaders
|
|
1358
1482
|
|
|
1483
|
+
# @!attribute deepfake_detection
|
|
1484
|
+
# Enables Deepfake Detection on the dialed call. When enabled, audio from the
|
|
1485
|
+
# remote party is analyzed to determine whether the voice is AI-generated. Results
|
|
1486
|
+
# are delivered asynchronously via a callback.
|
|
1487
|
+
#
|
|
1488
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetection, nil]
|
|
1489
|
+
optional :deepfake_detection,
|
|
1490
|
+
enum: -> {
|
|
1491
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetection
|
|
1492
|
+
},
|
|
1493
|
+
api_name: :DeepfakeDetection
|
|
1494
|
+
|
|
1495
|
+
# @!attribute deepfake_detection_callback_method
|
|
1496
|
+
# HTTP request type used for `DeepfakeDetectionCallbackUrl`.
|
|
1497
|
+
#
|
|
1498
|
+
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetectionCallbackMethod, nil]
|
|
1499
|
+
optional :deepfake_detection_callback_method,
|
|
1500
|
+
enum: -> {
|
|
1501
|
+
Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetectionCallbackMethod
|
|
1502
|
+
},
|
|
1503
|
+
api_name: :DeepfakeDetectionCallbackMethod
|
|
1504
|
+
|
|
1505
|
+
# @!attribute deepfake_detection_callback_url
|
|
1506
|
+
# URL destination for Telnyx to send deepfake detection callback events to for the
|
|
1507
|
+
# call.
|
|
1508
|
+
#
|
|
1509
|
+
# @return [String, nil]
|
|
1510
|
+
optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
|
|
1511
|
+
|
|
1359
1512
|
# @!attribute detection_mode
|
|
1360
1513
|
# Allows you to chose between Premium and Standard detections.
|
|
1361
1514
|
#
|
|
@@ -1628,7 +1781,7 @@ module Telnyx
|
|
|
1628
1781
|
},
|
|
1629
1782
|
api_name: :UrlMethod
|
|
1630
1783
|
|
|
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)
|
|
1784
|
+
# @!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_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)
|
|
1632
1785
|
# Some parameter documentations has been truncated, see
|
|
1633
1786
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault}
|
|
1634
1787
|
# for more details.
|
|
@@ -1649,6 +1802,12 @@ module Telnyx
|
|
|
1649
1802
|
#
|
|
1650
1803
|
# @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
|
|
1651
1804
|
#
|
|
1805
|
+
# @param deepfake_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetection] Enables Deepfake Detection on the dialed call. When enabled, audio from the remo
|
|
1806
|
+
#
|
|
1807
|
+
# @param deepfake_detection_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetectionCallbackMethod] HTTP request type used for `DeepfakeDetectionCallbackUrl`.
|
|
1808
|
+
#
|
|
1809
|
+
# @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
|
|
1810
|
+
#
|
|
1652
1811
|
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DetectionMode] Allows you to chose between Premium and Standard detections.
|
|
1653
1812
|
#
|
|
1654
1813
|
# @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
|
|
@@ -1748,6 +1907,33 @@ module Telnyx
|
|
|
1748
1907
|
# @param value [String] The value of the custom header
|
|
1749
1908
|
end
|
|
1750
1909
|
|
|
1910
|
+
# Enables Deepfake Detection on the dialed call. When enabled, audio from the
|
|
1911
|
+
# remote party is analyzed to determine whether the voice is AI-generated. Results
|
|
1912
|
+
# are delivered asynchronously via a callback.
|
|
1913
|
+
#
|
|
1914
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#deepfake_detection
|
|
1915
|
+
module DeepfakeDetection
|
|
1916
|
+
extend Telnyx::Internal::Type::Enum
|
|
1917
|
+
|
|
1918
|
+
ENABLE = :Enable
|
|
1919
|
+
|
|
1920
|
+
# @!method self.values
|
|
1921
|
+
# @return [Array<Symbol>]
|
|
1922
|
+
end
|
|
1923
|
+
|
|
1924
|
+
# HTTP request type used for `DeepfakeDetectionCallbackUrl`.
|
|
1925
|
+
#
|
|
1926
|
+
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#deepfake_detection_callback_method
|
|
1927
|
+
module DeepfakeDetectionCallbackMethod
|
|
1928
|
+
extend Telnyx::Internal::Type::Enum
|
|
1929
|
+
|
|
1930
|
+
GET = :GET
|
|
1931
|
+
POST = :POST
|
|
1932
|
+
|
|
1933
|
+
# @!method self.values
|
|
1934
|
+
# @return [Array<Symbol>]
|
|
1935
|
+
end
|
|
1936
|
+
|
|
1751
1937
|
# Allows you to chose between Premium and Standard detections.
|
|
1752
1938
|
#
|
|
1753
1939
|
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#detection_mode
|
|
@@ -19,6 +19,18 @@ module Telnyx
|
|
|
19
19
|
# @return [String, nil]
|
|
20
20
|
optional :created_at, String
|
|
21
21
|
|
|
22
|
+
# @!attribute daily_spend_limit
|
|
23
|
+
# The maximum daily spend allowed on this verify profile, in USD.
|
|
24
|
+
#
|
|
25
|
+
# @return [Float, nil]
|
|
26
|
+
optional :daily_spend_limit, Float
|
|
27
|
+
|
|
28
|
+
# @!attribute daily_spend_limit_enabled
|
|
29
|
+
# Whether the daily spend limit is enforced for this verify profile.
|
|
30
|
+
#
|
|
31
|
+
# @return [Boolean, nil]
|
|
32
|
+
optional :daily_spend_limit_enabled, Telnyx::Internal::Type::Boolean
|
|
33
|
+
|
|
22
34
|
# @!attribute flashcall
|
|
23
35
|
#
|
|
24
36
|
# @return [Telnyx::Models::VerifyProfile::Flashcall, nil]
|
|
@@ -34,11 +46,6 @@ module Telnyx
|
|
|
34
46
|
# @return [String, nil]
|
|
35
47
|
optional :name, String
|
|
36
48
|
|
|
37
|
-
# @!attribute rcs
|
|
38
|
-
#
|
|
39
|
-
# @return [Telnyx::Models::VerifyProfile::Rcs, nil]
|
|
40
|
-
optional :rcs, -> { Telnyx::VerifyProfile::Rcs }
|
|
41
|
-
|
|
42
49
|
# @!attribute record_type
|
|
43
50
|
# The possible verification profile record types.
|
|
44
51
|
#
|
|
@@ -70,21 +77,23 @@ module Telnyx
|
|
|
70
77
|
# @return [Telnyx::Models::VerifyProfile::Whatsapp, nil]
|
|
71
78
|
optional :whatsapp, -> { Telnyx::VerifyProfile::Whatsapp }
|
|
72
79
|
|
|
73
|
-
# @!method initialize(id: nil, call: nil, created_at: nil,
|
|
80
|
+
# @!method initialize(id: nil, call: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, flashcall: nil, language: nil, name: nil, record_type: nil, sms: nil, updated_at: nil, webhook_failover_url: nil, webhook_url: nil, whatsapp: nil)
|
|
74
81
|
# @param id [String]
|
|
75
82
|
#
|
|
76
83
|
# @param call [Telnyx::Models::VerifyProfile::Call]
|
|
77
84
|
#
|
|
78
85
|
# @param created_at [String]
|
|
79
86
|
#
|
|
87
|
+
# @param daily_spend_limit [Float] The maximum daily spend allowed on this verify profile, in USD.
|
|
88
|
+
#
|
|
89
|
+
# @param daily_spend_limit_enabled [Boolean] Whether the daily spend limit is enforced for this verify profile.
|
|
90
|
+
#
|
|
80
91
|
# @param flashcall [Telnyx::Models::VerifyProfile::Flashcall]
|
|
81
92
|
#
|
|
82
93
|
# @param language [String]
|
|
83
94
|
#
|
|
84
95
|
# @param name [String]
|
|
85
96
|
#
|
|
86
|
-
# @param rcs [Telnyx::Models::VerifyProfile::Rcs]
|
|
87
|
-
#
|
|
88
97
|
# @param record_type [Symbol, Telnyx::Models::VerifyProfile::RecordType] The possible verification profile record types.
|
|
89
98
|
#
|
|
90
99
|
# @param sms [Telnyx::Models::VerifyProfile::SMS]
|
|
@@ -179,69 +188,6 @@ module Telnyx
|
|
|
179
188
|
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
180
189
|
end
|
|
181
190
|
|
|
182
|
-
# @see Telnyx::Models::VerifyProfile#rcs
|
|
183
|
-
class Rcs < Telnyx::Internal::Type::BaseModel
|
|
184
|
-
# @!attribute app_name
|
|
185
|
-
# The name that identifies the application requesting 2fa in the verification
|
|
186
|
-
# message.
|
|
187
|
-
#
|
|
188
|
-
# @return [String, nil]
|
|
189
|
-
optional :app_name, String
|
|
190
|
-
|
|
191
|
-
# @!attribute code_length
|
|
192
|
-
# The length of the verify code to generate.
|
|
193
|
-
#
|
|
194
|
-
# @return [Integer, nil]
|
|
195
|
-
optional :code_length, Integer
|
|
196
|
-
|
|
197
|
-
# @!attribute default_verification_timeout_secs
|
|
198
|
-
# For every request that is initiated via this Verify profile, this sets the
|
|
199
|
-
# number of seconds before a verification request code expires. Once the
|
|
200
|
-
# verification request expires, the user cannot use the code to verify their
|
|
201
|
-
# identity.
|
|
202
|
-
#
|
|
203
|
-
# @return [Integer, nil]
|
|
204
|
-
optional :default_verification_timeout_secs, Integer
|
|
205
|
-
|
|
206
|
-
# @!attribute messaging_template_id
|
|
207
|
-
# The message template identifier selected from /verify_profiles/templates
|
|
208
|
-
#
|
|
209
|
-
# @return [String, nil]
|
|
210
|
-
optional :messaging_template_id, String
|
|
211
|
-
|
|
212
|
-
# @!attribute sms_fallback
|
|
213
|
-
# Enable SMS fallback when RCS delivery fails.
|
|
214
|
-
#
|
|
215
|
-
# @return [Boolean, nil]
|
|
216
|
-
optional :sms_fallback, Telnyx::Internal::Type::Boolean
|
|
217
|
-
|
|
218
|
-
# @!attribute whitelisted_destinations
|
|
219
|
-
# Enabled country destinations to send verification codes. The elements in the
|
|
220
|
-
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
221
|
-
# destinations will be allowed. **Conditionally required:** this field must be
|
|
222
|
-
# provided when your organization is configured to require explicit whitelisted
|
|
223
|
-
# destinations; otherwise it is optional.
|
|
224
|
-
#
|
|
225
|
-
# @return [Array<String>, nil]
|
|
226
|
-
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
227
|
-
|
|
228
|
-
# @!method initialize(app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, sms_fallback: nil, whitelisted_destinations: nil)
|
|
229
|
-
# Some parameter documentations has been truncated, see
|
|
230
|
-
# {Telnyx::Models::VerifyProfile::Rcs} for more details.
|
|
231
|
-
#
|
|
232
|
-
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
233
|
-
#
|
|
234
|
-
# @param code_length [Integer] The length of the verify code to generate.
|
|
235
|
-
#
|
|
236
|
-
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
237
|
-
#
|
|
238
|
-
# @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
|
|
239
|
-
#
|
|
240
|
-
# @param sms_fallback [Boolean] Enable SMS fallback when RCS delivery fails.
|
|
241
|
-
#
|
|
242
|
-
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
243
|
-
end
|
|
244
|
-
|
|
245
191
|
# The possible verification profile record types.
|
|
246
192
|
#
|
|
247
193
|
# @see Telnyx::Models::VerifyProfile#record_type
|