telnyx 5.111.0 → 5.113.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 +25 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/openai_create_response_params.rb +3 -3
- data/lib/telnyx/models/ai_create_response_params.rb +4 -4
- data/lib/telnyx/models/call_conversation_ended.rb +13 -1
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +542 -0
- data/lib/telnyx/models/calls/action_start_conversation_relay_response.rb +37 -0
- data/lib/telnyx/models/calls/action_stop_conversation_relay_params.rb +44 -0
- data/lib/telnyx/models/calls/action_stop_conversation_relay_response.rb +18 -0
- data/lib/telnyx/models/calls/transcription_engine_speechmatics_config.rb +100 -0
- data/lib/telnyx/models/calls/transcription_start_request.rb +6 -3
- data/lib/telnyx/models/fax.rb +7 -5
- data/lib/telnyx/models/fax_create_params.rb +7 -5
- data/lib/telnyx/models/fax_delivered.rb +3 -2
- data/lib/telnyx/models/fax_failed.rb +3 -2
- data/lib/telnyx/models/fax_media_processed.rb +3 -2
- data/lib/telnyx/models/fax_queued.rb +3 -2
- data/lib/telnyx/models/fax_sending_started.rb +3 -2
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +62 -12
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +18 -4
- data/lib/telnyx/resources/ai/openai.rb +1 -1
- data/lib/telnyx/resources/ai.rb +3 -3
- data/lib/telnyx/resources/calls/actions.rb +95 -1
- data/lib/telnyx/resources/faxes.rb +13 -1
- data/lib/telnyx/resources/texml.rb +4 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +5 -0
- data/rbi/telnyx/models/ai/openai_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/ai_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/call_conversation_ended.rbi +10 -0
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +1192 -0
- data/rbi/telnyx/models/calls/action_start_conversation_relay_response.rbi +95 -0
- data/rbi/telnyx/models/calls/action_stop_conversation_relay_params.rbi +72 -0
- data/rbi/telnyx/models/calls/action_stop_conversation_relay_response.rbi +39 -0
- data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi +289 -0
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +10 -0
- data/rbi/telnyx/models/fax.rbi +12 -8
- data/rbi/telnyx/models/fax_create_params.rbi +12 -8
- data/rbi/telnyx/models/fax_delivered.rbi +6 -4
- data/rbi/telnyx/models/fax_failed.rbi +6 -4
- data/rbi/telnyx/models/fax_media_processed.rbi +6 -4
- data/rbi/telnyx/models/fax_queued.rbi +6 -4
- data/rbi/telnyx/models/fax_sending_started.rbi +6 -4
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +81 -9
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +27 -3
- data/rbi/telnyx/resources/ai/openai.rbi +1 -1
- data/rbi/telnyx/resources/ai.rbi +2 -2
- data/rbi/telnyx/resources/calls/actions.rbi +146 -0
- data/rbi/telnyx/resources/faxes.rbi +18 -4
- data/rbi/telnyx/resources/texml.rbi +7 -1
- data/sig/telnyx/models/ai/openai_create_response_params.rbs +5 -5
- data/sig/telnyx/models/ai_create_response_params.rbs +5 -4
- data/sig/telnyx/models/call_conversation_ended.rbs +5 -0
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +455 -0
- data/sig/telnyx/models/calls/action_start_conversation_relay_response.rbs +45 -0
- data/sig/telnyx/models/calls/action_stop_conversation_relay_params.rbs +38 -0
- data/sig/telnyx/models/calls/action_stop_conversation_relay_response.rbs +20 -0
- data/sig/telnyx/models/calls/transcription_engine_speechmatics_config.rbs +114 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +11 -1
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +27 -3
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +9 -1
- data/sig/telnyx/resources/ai/openai.rbs +1 -1
- data/sig/telnyx/resources/ai.rbs +1 -1
- data/sig/telnyx/resources/calls/actions.rbs +27 -0
- data/sig/telnyx/resources/texml.rbs +1 -0
- metadata +17 -2
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
# @see Telnyx::Resources::Calls::Actions#start_conversation_relay
|
|
7
|
+
class ActionStartConversationRelayResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data]
|
|
15
|
+
|
|
16
|
+
# @see Telnyx::Models::Calls::ActionStartConversationRelayResponse#data
|
|
17
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute conversation_relay_id
|
|
19
|
+
# The ID of the Conversation Relay session created by the command.
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :conversation_relay_id, String
|
|
23
|
+
|
|
24
|
+
# @!attribute result
|
|
25
|
+
#
|
|
26
|
+
# @return [String, nil]
|
|
27
|
+
optional :result, String
|
|
28
|
+
|
|
29
|
+
# @!method initialize(conversation_relay_id: nil, result: nil)
|
|
30
|
+
# @param conversation_relay_id [String] The ID of the Conversation Relay session created by the command.
|
|
31
|
+
#
|
|
32
|
+
# @param result [String]
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
# @see Telnyx::Resources::Calls::Actions#stop_conversation_relay
|
|
7
|
+
class ActionStopConversationRelayParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute call_control_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :call_control_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute client_state
|
|
17
|
+
# Use this field to add state to subsequent webhooks. It must be a valid Base-64
|
|
18
|
+
# encoded string.
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
optional :client_state, String
|
|
22
|
+
|
|
23
|
+
# @!attribute command_id
|
|
24
|
+
# Use this field to avoid duplicate commands. Telnyx will ignore any command with
|
|
25
|
+
# the same `command_id` for the same `call_control_id`.
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :command_id, String
|
|
29
|
+
|
|
30
|
+
# @!method initialize(call_control_id:, client_state: nil, command_id: nil, request_options: {})
|
|
31
|
+
# Some parameter documentations has been truncated, see
|
|
32
|
+
# {Telnyx::Models::Calls::ActionStopConversationRelayParams} for more details.
|
|
33
|
+
#
|
|
34
|
+
# @param call_control_id [String]
|
|
35
|
+
#
|
|
36
|
+
# @param client_state [String] Use this field to add state to subsequent webhooks. It must be a valid Base-64 e
|
|
37
|
+
#
|
|
38
|
+
# @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
|
|
39
|
+
#
|
|
40
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
# @see Telnyx::Resources::Calls::Actions#stop_conversation_relay
|
|
7
|
+
class ActionStopConversationRelayResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::Calls::CallControlCommandResult, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Calls::CallControlCommandResult }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::Calls::CallControlCommandResult]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
class TranscriptionEngineSpeechmaticsConfig < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute interim_results
|
|
8
|
+
# Whether to send also interim results. If set to false, only final results will
|
|
9
|
+
# be sent.
|
|
10
|
+
#
|
|
11
|
+
# @return [Boolean, nil]
|
|
12
|
+
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
13
|
+
|
|
14
|
+
# @!attribute language
|
|
15
|
+
# Language to use for speech recognition
|
|
16
|
+
#
|
|
17
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::Language, nil]
|
|
18
|
+
optional :language, enum: -> { Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language }
|
|
19
|
+
|
|
20
|
+
# @!attribute transcription_engine
|
|
21
|
+
# Engine identifier for Speechmatics transcription service
|
|
22
|
+
#
|
|
23
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine, nil]
|
|
24
|
+
optional :transcription_engine,
|
|
25
|
+
enum: -> { Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine }
|
|
26
|
+
|
|
27
|
+
# @!attribute transcription_model
|
|
28
|
+
# The model to use for transcription.
|
|
29
|
+
#
|
|
30
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel, nil]
|
|
31
|
+
optional :transcription_model,
|
|
32
|
+
enum: -> { Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel }
|
|
33
|
+
|
|
34
|
+
# @!method initialize(interim_results: nil, language: nil, transcription_engine: nil, transcription_model: nil)
|
|
35
|
+
# Some parameter documentations has been truncated, see
|
|
36
|
+
# {Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig} for more details.
|
|
37
|
+
#
|
|
38
|
+
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
39
|
+
#
|
|
40
|
+
# @param language [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::Language] Language to use for speech recognition
|
|
41
|
+
#
|
|
42
|
+
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine] Engine identifier for Speechmatics transcription service
|
|
43
|
+
#
|
|
44
|
+
# @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel] The model to use for transcription.
|
|
45
|
+
|
|
46
|
+
# Language to use for speech recognition
|
|
47
|
+
#
|
|
48
|
+
# @see Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig#language
|
|
49
|
+
module Language
|
|
50
|
+
extend Telnyx::Internal::Type::Enum
|
|
51
|
+
|
|
52
|
+
EN = :en
|
|
53
|
+
BA = :ba
|
|
54
|
+
EU = :eu
|
|
55
|
+
GL = :gl
|
|
56
|
+
GA = :ga
|
|
57
|
+
MT = :mt
|
|
58
|
+
MN = :mn
|
|
59
|
+
SW = :sw
|
|
60
|
+
UG = :ug
|
|
61
|
+
CY = :cy
|
|
62
|
+
AR_EN = :ar_en
|
|
63
|
+
CMN_EN = :cmn_en
|
|
64
|
+
EN_MS = :en_ms
|
|
65
|
+
EN_TA = :en_ta
|
|
66
|
+
TL = :tl
|
|
67
|
+
ES_BILINGUAL_EN = :"es-bilingual-en"
|
|
68
|
+
CMN_EN_MS_TA = :cmn_en_ms_ta
|
|
69
|
+
|
|
70
|
+
# @!method self.values
|
|
71
|
+
# @return [Array<Symbol>]
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# Engine identifier for Speechmatics transcription service
|
|
75
|
+
#
|
|
76
|
+
# @see Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig#transcription_engine
|
|
77
|
+
module TranscriptionEngine
|
|
78
|
+
extend Telnyx::Internal::Type::Enum
|
|
79
|
+
|
|
80
|
+
SPEECHMATICS = :Speechmatics
|
|
81
|
+
|
|
82
|
+
# @!method self.values
|
|
83
|
+
# @return [Array<Symbol>]
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# The model to use for transcription.
|
|
87
|
+
#
|
|
88
|
+
# @see Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig#transcription_model
|
|
89
|
+
module TranscriptionModel
|
|
90
|
+
extend Telnyx::Internal::Type::Enum
|
|
91
|
+
|
|
92
|
+
SPEECHMATICS_STANDARD = :"speechmatics/standard"
|
|
93
|
+
|
|
94
|
+
# @!method self.values
|
|
95
|
+
# @return [Array<Symbol>]
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
end
|
|
@@ -27,7 +27,7 @@ module Telnyx
|
|
|
27
27
|
|
|
28
28
|
# @!attribute transcription_engine_config
|
|
29
29
|
#
|
|
30
|
-
# @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config, nil]
|
|
30
|
+
# @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config, nil]
|
|
31
31
|
optional :transcription_engine_config,
|
|
32
32
|
union: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig }
|
|
33
33
|
|
|
@@ -49,7 +49,7 @@ module Telnyx
|
|
|
49
49
|
#
|
|
50
50
|
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
|
|
51
51
|
#
|
|
52
|
-
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
|
|
52
|
+
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
|
|
53
53
|
#
|
|
54
54
|
# @param transcription_tracks [String] Indicates which leg of the call will be transcribed. Use `inbound` for the leg t
|
|
55
55
|
|
|
@@ -66,6 +66,7 @@ module Telnyx
|
|
|
66
66
|
AZURE = :Azure
|
|
67
67
|
X_AI = :xAI
|
|
68
68
|
ASSEMBLY_AI = :AssemblyAI
|
|
69
|
+
SPEECHMATICS = :Speechmatics
|
|
69
70
|
A = :A
|
|
70
71
|
B = :B
|
|
71
72
|
|
|
@@ -89,6 +90,8 @@ module Telnyx
|
|
|
89
90
|
|
|
90
91
|
variant :AssemblyAI, -> { Telnyx::Calls::TranscriptionEngineAssemblyaiConfig }
|
|
91
92
|
|
|
93
|
+
variant :Speechmatics, -> { Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig }
|
|
94
|
+
|
|
92
95
|
variant :A, -> { Telnyx::Calls::TranscriptionEngineAConfig }
|
|
93
96
|
|
|
94
97
|
variant :B, -> { Telnyx::Calls::TranscriptionEngineBConfig }
|
|
@@ -98,7 +101,7 @@ module Telnyx
|
|
|
98
101
|
variant :"deepgram/nova-3", -> { Telnyx::Calls::DeepgramNova3Config }
|
|
99
102
|
|
|
100
103
|
# @!method self.variants
|
|
101
|
-
# @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config)]
|
|
104
|
+
# @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config)]
|
|
102
105
|
end
|
|
103
106
|
end
|
|
104
107
|
end
|
data/lib/telnyx/models/fax.rb
CHANGED
|
@@ -49,15 +49,17 @@ module Telnyx
|
|
|
49
49
|
|
|
50
50
|
# @!attribute media_name
|
|
51
51
|
# The media_name used for the fax's media. Must point to a file previously
|
|
52
|
-
# uploaded to api.telnyx.com/v2/media by the same user/organization.
|
|
53
|
-
#
|
|
52
|
+
# uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
|
|
53
|
+
# formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
|
|
54
|
+
# media_url/contents can't be submitted together.
|
|
54
55
|
#
|
|
55
56
|
# @return [String, nil]
|
|
56
57
|
optional :media_name, String
|
|
57
58
|
|
|
58
59
|
# @!attribute media_url
|
|
59
|
-
# The URL (or list of URLs) to the
|
|
60
|
-
# media_name/contents can't be
|
|
60
|
+
# The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
|
|
61
|
+
# JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
|
|
62
|
+
# submitted together.
|
|
61
63
|
#
|
|
62
64
|
# @return [String, nil]
|
|
63
65
|
optional :media_url, String
|
|
@@ -147,7 +149,7 @@ module Telnyx
|
|
|
147
149
|
#
|
|
148
150
|
# @param media_name [String] The media_name used for the fax's media. Must point to a file previously uploade
|
|
149
151
|
#
|
|
150
|
-
# @param media_url [String] The URL (or list of URLs) to the
|
|
152
|
+
# @param media_url [String] The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF, JPE
|
|
151
153
|
#
|
|
152
154
|
# @param preview_url [String] If `store_preview` was set to `true`, this is a link to temporary location. Link
|
|
153
155
|
#
|
|
@@ -51,15 +51,17 @@ module Telnyx
|
|
|
51
51
|
|
|
52
52
|
# @!attribute media_name
|
|
53
53
|
# The media_name used for the fax's media. Must point to a file previously
|
|
54
|
-
# uploaded to api.telnyx.com/v2/media by the same user/organization.
|
|
55
|
-
#
|
|
54
|
+
# uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
|
|
55
|
+
# formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
|
|
56
|
+
# media_url/contents can't be submitted together.
|
|
56
57
|
#
|
|
57
58
|
# @return [String, nil]
|
|
58
59
|
optional :media_name, String
|
|
59
60
|
|
|
60
61
|
# @!attribute media_url
|
|
61
|
-
# The URL (or list of URLs) to the
|
|
62
|
-
# media_name/contents can't be
|
|
62
|
+
# The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
|
|
63
|
+
# JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
|
|
64
|
+
# submitted together.
|
|
63
65
|
#
|
|
64
66
|
# @return [String, nil]
|
|
65
67
|
optional :media_url, String
|
|
@@ -128,7 +130,7 @@ module Telnyx
|
|
|
128
130
|
#
|
|
129
131
|
# @param media_name [String] The media_name used for the fax's media. Must point to a file previously uploade
|
|
130
132
|
#
|
|
131
|
-
# @param media_url [String] The URL (or list of URLs) to the
|
|
133
|
+
# @param media_url [String] The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF, JPE
|
|
132
134
|
#
|
|
133
135
|
# @param monochrome [Boolean] The flag to enable monochrome, true black and white fax results.
|
|
134
136
|
#
|
|
@@ -113,8 +113,9 @@ module Telnyx
|
|
|
113
113
|
|
|
114
114
|
# @!attribute media_name
|
|
115
115
|
# The media_name used for the fax's media. Must point to a file previously
|
|
116
|
-
# uploaded to api.telnyx.com/v2/media by the same user/organization.
|
|
117
|
-
#
|
|
116
|
+
# uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
|
|
117
|
+
# formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
|
|
118
|
+
# media_url/contents can't be submitted together.
|
|
118
119
|
#
|
|
119
120
|
# @return [String, nil]
|
|
120
121
|
optional :media_name, String
|
|
@@ -113,8 +113,9 @@ module Telnyx
|
|
|
113
113
|
|
|
114
114
|
# @!attribute media_name
|
|
115
115
|
# The media_name used for the fax's media. Must point to a file previously
|
|
116
|
-
# uploaded to api.telnyx.com/v2/media by the same user/organization.
|
|
117
|
-
#
|
|
116
|
+
# uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
|
|
117
|
+
# formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
|
|
118
|
+
# media_url/contents can't be submitted together.
|
|
118
119
|
#
|
|
119
120
|
# @return [String, nil]
|
|
120
121
|
optional :media_name, String
|
|
@@ -107,8 +107,9 @@ module Telnyx
|
|
|
107
107
|
|
|
108
108
|
# @!attribute media_name
|
|
109
109
|
# The media_name used for the fax's media. Must point to a file previously
|
|
110
|
-
# uploaded to api.telnyx.com/v2/media by the same user/organization.
|
|
111
|
-
#
|
|
110
|
+
# uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
|
|
111
|
+
# formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
|
|
112
|
+
# media_url/contents can't be submitted together.
|
|
112
113
|
#
|
|
113
114
|
# @return [String, nil]
|
|
114
115
|
optional :media_name, String
|
|
@@ -107,8 +107,9 @@ module Telnyx
|
|
|
107
107
|
|
|
108
108
|
# @!attribute media_name
|
|
109
109
|
# The media_name used for the fax's media. Must point to a file previously
|
|
110
|
-
# uploaded to api.telnyx.com/v2/media by the same user/organization.
|
|
111
|
-
#
|
|
110
|
+
# uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
|
|
111
|
+
# formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
|
|
112
|
+
# media_url/contents can't be submitted together.
|
|
112
113
|
#
|
|
113
114
|
# @return [String, nil]
|
|
114
115
|
optional :media_name, String
|
|
@@ -107,8 +107,9 @@ module Telnyx
|
|
|
107
107
|
|
|
108
108
|
# @!attribute media_name
|
|
109
109
|
# The media_name used for the fax's media. Must point to a file previously
|
|
110
|
-
# uploaded to api.telnyx.com/v2/media by the same user/organization.
|
|
111
|
-
#
|
|
110
|
+
# uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
|
|
111
|
+
# formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
|
|
112
|
+
# media_url/contents can't be submitted together.
|
|
112
113
|
#
|
|
113
114
|
# @return [String, nil]
|
|
114
115
|
optional :media_name, String
|
|
@@ -27,6 +27,8 @@ module Telnyx
|
|
|
27
27
|
module Params
|
|
28
28
|
extend Telnyx::Internal::Type::Union
|
|
29
29
|
|
|
30
|
+
discriminator :Url
|
|
31
|
+
|
|
30
32
|
variant -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL }
|
|
31
33
|
|
|
32
34
|
variant -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml }
|
|
@@ -137,7 +139,9 @@ module Telnyx
|
|
|
137
139
|
optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
|
|
138
140
|
|
|
139
141
|
# @!attribute detection_mode
|
|
140
|
-
# Allows you to
|
|
142
|
+
# Allows you to choose between Regular, Premium, and PremiumCallScreening
|
|
143
|
+
# detections. See
|
|
144
|
+
# https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
|
|
141
145
|
#
|
|
142
146
|
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode, nil]
|
|
143
147
|
optional :detection_mode,
|
|
@@ -168,6 +172,15 @@ module Telnyx
|
|
|
168
172
|
},
|
|
169
173
|
api_name: :MachineDetection
|
|
170
174
|
|
|
175
|
+
# @!attribute machine_detection_prompt_end_timeout
|
|
176
|
+
# Silence duration threshold after a call screening prompt before ending prompt
|
|
177
|
+
# detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
|
|
178
|
+
#
|
|
179
|
+
# @return [Integer, nil]
|
|
180
|
+
optional :machine_detection_prompt_end_timeout,
|
|
181
|
+
Integer,
|
|
182
|
+
api_name: :MachineDetectionPromptEndTimeout
|
|
183
|
+
|
|
171
184
|
# @!attribute machine_detection_silence_timeout
|
|
172
185
|
# If initial silence duration is greater than this value, consider it a machine.
|
|
173
186
|
# Ignored when `premium` detection is used.
|
|
@@ -393,7 +406,7 @@ module Telnyx
|
|
|
393
406
|
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::URLMethod },
|
|
394
407
|
api_name: :UrlMethod
|
|
395
408
|
|
|
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)
|
|
409
|
+
# @!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)
|
|
397
410
|
# Some parameter documentations has been truncated, see
|
|
398
411
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL} for more
|
|
399
412
|
# details.
|
|
@@ -422,7 +435,7 @@ module Telnyx
|
|
|
422
435
|
#
|
|
423
436
|
# @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
|
|
424
437
|
#
|
|
425
|
-
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode] Allows you to
|
|
438
|
+
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode] Allows you to choose between Regular, Premium, and PremiumCallScreening detectio
|
|
426
439
|
#
|
|
427
440
|
# @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
|
|
428
441
|
#
|
|
@@ -430,6 +443,8 @@ module Telnyx
|
|
|
430
443
|
#
|
|
431
444
|
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::MachineDetection] Enables Answering Machine Detection.
|
|
432
445
|
#
|
|
446
|
+
# @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
|
|
447
|
+
#
|
|
433
448
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
434
449
|
#
|
|
435
450
|
# @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere
|
|
@@ -546,7 +561,9 @@ module Telnyx
|
|
|
546
561
|
# @return [Array<Symbol>]
|
|
547
562
|
end
|
|
548
563
|
|
|
549
|
-
# Allows you to
|
|
564
|
+
# Allows you to choose between Regular, Premium, and PremiumCallScreening
|
|
565
|
+
# detections. See
|
|
566
|
+
# https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
|
|
550
567
|
#
|
|
551
568
|
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#detection_mode
|
|
552
569
|
module DetectionMode
|
|
@@ -554,6 +571,7 @@ module Telnyx
|
|
|
554
571
|
|
|
555
572
|
PREMIUM = :Premium
|
|
556
573
|
REGULAR = :Regular
|
|
574
|
+
PREMIUM_CALL_SCREENING = :PremiumCallScreening
|
|
557
575
|
|
|
558
576
|
# @!method self.values
|
|
559
577
|
# @return [Array<Symbol>]
|
|
@@ -825,7 +843,9 @@ module Telnyx
|
|
|
825
843
|
optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
|
|
826
844
|
|
|
827
845
|
# @!attribute detection_mode
|
|
828
|
-
# Allows you to
|
|
846
|
+
# Allows you to choose between Regular, Premium, and PremiumCallScreening
|
|
847
|
+
# detections. See
|
|
848
|
+
# https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
|
|
829
849
|
#
|
|
830
850
|
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DetectionMode, nil]
|
|
831
851
|
optional :detection_mode,
|
|
@@ -858,6 +878,15 @@ module Telnyx
|
|
|
858
878
|
},
|
|
859
879
|
api_name: :MachineDetection
|
|
860
880
|
|
|
881
|
+
# @!attribute machine_detection_prompt_end_timeout
|
|
882
|
+
# Silence duration threshold after a call screening prompt before ending prompt
|
|
883
|
+
# detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
|
|
884
|
+
#
|
|
885
|
+
# @return [Integer, nil]
|
|
886
|
+
optional :machine_detection_prompt_end_timeout,
|
|
887
|
+
Integer,
|
|
888
|
+
api_name: :MachineDetectionPromptEndTimeout
|
|
889
|
+
|
|
861
890
|
# @!attribute machine_detection_silence_timeout
|
|
862
891
|
# If initial silence duration is greater than this value, consider it a machine.
|
|
863
892
|
# Ignored when `premium` detection is used.
|
|
@@ -1085,7 +1114,7 @@ module Telnyx
|
|
|
1085
1114
|
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::URLMethod },
|
|
1086
1115
|
api_name: :UrlMethod
|
|
1087
1116
|
|
|
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)
|
|
1117
|
+
# @!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)
|
|
1089
1118
|
# Some parameter documentations has been truncated, see
|
|
1090
1119
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml} for more
|
|
1091
1120
|
# details.
|
|
@@ -1114,7 +1143,7 @@ module Telnyx
|
|
|
1114
1143
|
#
|
|
1115
1144
|
# @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
|
|
1116
1145
|
#
|
|
1117
|
-
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DetectionMode] Allows you to
|
|
1146
|
+
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DetectionMode] Allows you to choose between Regular, Premium, and PremiumCallScreening detectio
|
|
1118
1147
|
#
|
|
1119
1148
|
# @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
|
|
1120
1149
|
#
|
|
@@ -1122,6 +1151,8 @@ module Telnyx
|
|
|
1122
1151
|
#
|
|
1123
1152
|
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::MachineDetection] Enables Answering Machine Detection.
|
|
1124
1153
|
#
|
|
1154
|
+
# @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
|
|
1155
|
+
#
|
|
1125
1156
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
1126
1157
|
#
|
|
1127
1158
|
# @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere
|
|
@@ -1238,7 +1269,9 @@ module Telnyx
|
|
|
1238
1269
|
# @return [Array<Symbol>]
|
|
1239
1270
|
end
|
|
1240
1271
|
|
|
1241
|
-
# Allows you to
|
|
1272
|
+
# Allows you to choose between Regular, Premium, and PremiumCallScreening
|
|
1273
|
+
# detections. See
|
|
1274
|
+
# https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
|
|
1242
1275
|
#
|
|
1243
1276
|
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#detection_mode
|
|
1244
1277
|
module DetectionMode
|
|
@@ -1246,6 +1279,7 @@ module Telnyx
|
|
|
1246
1279
|
|
|
1247
1280
|
PREMIUM = :Premium
|
|
1248
1281
|
REGULAR = :Regular
|
|
1282
|
+
PREMIUM_CALL_SCREENING = :PremiumCallScreening
|
|
1249
1283
|
|
|
1250
1284
|
# @!method self.values
|
|
1251
1285
|
# @return [Array<Symbol>]
|
|
@@ -1510,7 +1544,9 @@ module Telnyx
|
|
|
1510
1544
|
optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
|
|
1511
1545
|
|
|
1512
1546
|
# @!attribute detection_mode
|
|
1513
|
-
# Allows you to
|
|
1547
|
+
# Allows you to choose between Regular, Premium, and PremiumCallScreening
|
|
1548
|
+
# detections. See
|
|
1549
|
+
# https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
|
|
1514
1550
|
#
|
|
1515
1551
|
# @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DetectionMode, nil]
|
|
1516
1552
|
optional :detection_mode,
|
|
@@ -1543,6 +1579,15 @@ module Telnyx
|
|
|
1543
1579
|
},
|
|
1544
1580
|
api_name: :MachineDetection
|
|
1545
1581
|
|
|
1582
|
+
# @!attribute machine_detection_prompt_end_timeout
|
|
1583
|
+
# Silence duration threshold after a call screening prompt before ending prompt
|
|
1584
|
+
# detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
|
|
1585
|
+
#
|
|
1586
|
+
# @return [Integer, nil]
|
|
1587
|
+
optional :machine_detection_prompt_end_timeout,
|
|
1588
|
+
Integer,
|
|
1589
|
+
api_name: :MachineDetectionPromptEndTimeout
|
|
1590
|
+
|
|
1546
1591
|
# @!attribute machine_detection_silence_timeout
|
|
1547
1592
|
# If initial silence duration is greater than this value, consider it a machine.
|
|
1548
1593
|
# Ignored when `premium` detection is used.
|
|
@@ -1781,7 +1826,7 @@ module Telnyx
|
|
|
1781
1826
|
},
|
|
1782
1827
|
api_name: :UrlMethod
|
|
1783
1828
|
|
|
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)
|
|
1829
|
+
# @!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)
|
|
1785
1830
|
# Some parameter documentations has been truncated, see
|
|
1786
1831
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault}
|
|
1787
1832
|
# for more details.
|
|
@@ -1808,7 +1853,7 @@ module Telnyx
|
|
|
1808
1853
|
#
|
|
1809
1854
|
# @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
|
|
1810
1855
|
#
|
|
1811
|
-
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DetectionMode] Allows you to
|
|
1856
|
+
# @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DetectionMode] Allows you to choose between Regular, Premium, and PremiumCallScreening detectio
|
|
1812
1857
|
#
|
|
1813
1858
|
# @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
|
|
1814
1859
|
#
|
|
@@ -1816,6 +1861,8 @@ module Telnyx
|
|
|
1816
1861
|
#
|
|
1817
1862
|
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::MachineDetection] Enables Answering Machine Detection.
|
|
1818
1863
|
#
|
|
1864
|
+
# @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
|
|
1865
|
+
#
|
|
1819
1866
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
1820
1867
|
#
|
|
1821
1868
|
# @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere
|
|
@@ -1934,7 +1981,9 @@ module Telnyx
|
|
|
1934
1981
|
# @return [Array<Symbol>]
|
|
1935
1982
|
end
|
|
1936
1983
|
|
|
1937
|
-
# Allows you to
|
|
1984
|
+
# Allows you to choose between Regular, Premium, and PremiumCallScreening
|
|
1985
|
+
# detections. See
|
|
1986
|
+
# https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
|
|
1938
1987
|
#
|
|
1939
1988
|
# @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#detection_mode
|
|
1940
1989
|
module DetectionMode
|
|
@@ -1942,6 +1991,7 @@ module Telnyx
|
|
|
1942
1991
|
|
|
1943
1992
|
PREMIUM = :Premium
|
|
1944
1993
|
REGULAR = :Regular
|
|
1994
|
+
PREMIUM_CALL_SCREENING = :PremiumCallScreening
|
|
1945
1995
|
|
|
1946
1996
|
# @!method self.values
|
|
1947
1997
|
# @return [Array<Symbol>]
|