telnyx 5.160.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 +24 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +8 -0
- data/lib/telnyx/models/artifact_completed_webhook_event.rb +152 -0
- data/lib/telnyx/models/artifact_failed_webhook_event.rb +103 -0
- data/lib/telnyx/models/call_dial_params.rb +34 -8
- data/lib/telnyx/models/calls/action_answer_params.rb +7 -6
- 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 +34 -7
- data/lib/telnyx/models/conferences/action_speak_params.rb +6 -1
- data/lib/telnyx/models/meeting_session.rb +380 -0
- data/lib/telnyx/models/meeting_session_create_params.rb +309 -0
- data/lib/telnyx/models/meeting_session_delete_params.rb +20 -0
- data/lib/telnyx/models/meeting_session_delete_recording_media_params.rb +20 -0
- data/lib/telnyx/models/meeting_session_delete_recording_media_response.rb +61 -0
- data/lib/telnyx/models/meeting_session_list_params.rb +39 -0
- data/lib/telnyx/models/meeting_session_list_response.rb +16 -0
- data/lib/telnyx/models/meeting_session_response.rb +22 -0
- data/lib/telnyx/models/meeting_session_retrieve_events_params.rb +37 -0
- data/lib/telnyx/models/meeting_session_retrieve_events_response.rb +45 -0
- data/lib/telnyx/models/meeting_session_retrieve_params.rb +20 -0
- data/lib/telnyx/models/meeting_session_retrieve_recordings_params.rb +20 -0
- data/lib/telnyx/models/meeting_session_retrieve_recordings_response.rb +49 -0
- data/lib/telnyx/models/meeting_session_retrieve_transcript_params.rb +50 -0
- data/lib/telnyx/models/meeting_session_retrieve_transcript_response.rb +80 -0
- data/lib/telnyx/models/meeting_session_update_params.rb +37 -0
- data/lib/telnyx/models/meeting_sessions/action_accepted_response.rb +29 -0
- data/lib/telnyx/models/meeting_sessions/action_send_chat_params.rb +31 -0
- data/lib/telnyx/models/meeting_sessions/action_speak_params.rb +52 -0
- data/lib/telnyx/models/meeting_sessions/action_stop_speaking_params.rb +22 -0
- data/lib/telnyx/models/meeting_sessions/artifact_create_params.rb +42 -0
- data/lib/telnyx/models/meeting_sessions/artifact_list_params.rb +22 -0
- data/lib/telnyx/models/meeting_sessions/artifact_list_response.rb +18 -0
- data/lib/telnyx/models/meeting_sessions/artifact_retrieve_params.rb +28 -0
- data/lib/telnyx/models/meeting_sessions/meeting_session_artifact.rb +120 -0
- data/lib/telnyx/models/meeting_sessions/meeting_session_artifact_response.rb +20 -0
- data/lib/telnyx/models/phone_numbers/voicemail_pref_response.rb +64 -1
- data/lib/telnyx/models/phone_numbers/voicemail_request.rb +63 -1
- data/lib/telnyx/models/private_wireless_gateway_status.rb +2 -2
- data/lib/telnyx/models/recording_available_webhook_event.rb +82 -0
- data/lib/telnyx/models/rime_voice_settings.rb +15 -1
- data/lib/telnyx/models/session_status_changed_webhook_event.rb +102 -0
- data/lib/telnyx/models/sim_cards/action_bulk_enable_voice_params.rb +16 -1
- data/lib/telnyx/models/sim_cards/action_disable_voice_params.rb +22 -0
- data/lib/telnyx/models/sim_cards/action_disable_voice_response.rb +23 -0
- data/lib/telnyx/models/sim_cards/action_enable_voice_params.rb +37 -0
- data/lib/telnyx/models/sim_cards/action_enable_voice_response.rb +23 -0
- data/lib/telnyx/models/sim_cards/action_list_params.rb +2 -0
- data/lib/telnyx/models/sim_cards/wireless_sim_card_action.rb +6 -0
- data/lib/telnyx/models/storage/edge_compute_pagination_meta.rb +35 -0
- data/lib/telnyx/models/storage/sql_database.rb +75 -0
- data/lib/telnyx/models/storage/sql_database_response_wrapper.rb +18 -0
- data/lib/telnyx/models/storage/sqldb_create_params.rb +28 -0
- data/lib/telnyx/models/storage/sqldb_delete_params.rb +35 -0
- data/lib/telnyx/models/storage/sqldb_list_params.rb +85 -0
- data/lib/telnyx/models/storage/sqldb_retrieve_params.rb +22 -0
- data/lib/telnyx/models/storage/sqldbs/action_query_params.rb +66 -0
- data/lib/telnyx/models/storage/sqldbs/action_query_response.rb +109 -0
- 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/models/transcript_completed_webhook_event.rb +98 -0
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +11 -1
- data/lib/telnyx/models/unwrap_webhook_event.rb +11 -1
- data/lib/telnyx/models/web_search/research_citation.rb +34 -0
- data/lib/telnyx/models/web_search/research_create_params.rb +65 -0
- data/lib/telnyx/models/web_search/research_create_response.rb +93 -0
- data/lib/telnyx/models/web_search/research_retrieve_params.rb +22 -0
- data/lib/telnyx/models/web_search/research_retrieve_response.rb +77 -0
- data/lib/telnyx/models/web_search_contents_params.rb +63 -0
- data/lib/telnyx/models/web_search_contents_response.rb +97 -0
- data/lib/telnyx/models/web_search_create_params.rb +95 -0
- data/lib/telnyx/models/web_search_create_response.rb +47 -0
- data/lib/telnyx/models/web_search_result.rb +56 -0
- data/lib/telnyx/models.rb +42 -0
- data/lib/telnyx/resources/calls/actions.rb +2 -2
- data/lib/telnyx/resources/calls.rb +1 -1
- data/lib/telnyx/resources/meeting_sessions/actions.rb +92 -0
- data/lib/telnyx/resources/meeting_sessions/artifacts.rb +92 -0
- data/lib/telnyx/resources/meeting_sessions.rb +290 -0
- data/lib/telnyx/resources/messaging_profiles.rb +1 -1
- data/lib/telnyx/resources/phone_numbers/voicemail.rb +20 -4
- data/lib/telnyx/resources/sim_cards/actions.rb +66 -1
- data/lib/telnyx/resources/storage/sqldbs/actions.rb +50 -0
- data/lib/telnyx/resources/storage/sqldbs.rb +140 -0
- data/lib/telnyx/resources/storage.rb +5 -0
- data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +3 -1
- data/lib/telnyx/resources/texml.rb +3 -1
- data/lib/telnyx/resources/web_search/research.rb +86 -0
- data/lib/telnyx/resources/web_search.rb +96 -0
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +61 -0
- data/rbi/telnyx/client.rbi +6 -0
- data/rbi/telnyx/models/artifact_completed_webhook_event.rbi +283 -0
- data/rbi/telnyx/models/artifact_failed_webhook_event.rbi +185 -0
- data/rbi/telnyx/models/call_dial_params.rbi +77 -12
- data/rbi/telnyx/models/calls/action_answer_params.rbi +12 -10
- 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 +77 -10
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +12 -2
- data/rbi/telnyx/models/meeting_session.rbi +544 -0
- data/rbi/telnyx/models/meeting_session_create_params.rbi +526 -0
- data/rbi/telnyx/models/meeting_session_delete_params.rbi +35 -0
- data/rbi/telnyx/models/meeting_session_delete_recording_media_params.rbi +38 -0
- data/rbi/telnyx/models/meeting_session_delete_recording_media_response.rbi +143 -0
- data/rbi/telnyx/models/meeting_session_list_params.rbi +101 -0
- data/rbi/telnyx/models/meeting_session_list_response.rbi +30 -0
- data/rbi/telnyx/models/meeting_session_response.rbi +36 -0
- data/rbi/telnyx/models/meeting_session_retrieve_events_params.rbi +66 -0
- data/rbi/telnyx/models/meeting_session_retrieve_events_response.rbi +92 -0
- data/rbi/telnyx/models/meeting_session_retrieve_params.rbi +35 -0
- data/rbi/telnyx/models/meeting_session_retrieve_recordings_params.rbi +38 -0
- data/rbi/telnyx/models/meeting_session_retrieve_recordings_response.rbi +97 -0
- data/rbi/telnyx/models/meeting_session_retrieve_transcript_params.rbi +81 -0
- data/rbi/telnyx/models/meeting_session_retrieve_transcript_response.rbi +154 -0
- data/rbi/telnyx/models/meeting_session_update_params.rbi +63 -0
- data/rbi/telnyx/models/meeting_sessions/action_accepted_response.rbi +64 -0
- data/rbi/telnyx/models/meeting_sessions/action_send_chat_params.rbi +54 -0
- data/rbi/telnyx/models/meeting_sessions/action_speak_params.rbi +80 -0
- data/rbi/telnyx/models/meeting_sessions/action_stop_speaking_params.rbi +40 -0
- data/rbi/telnyx/models/meeting_sessions/artifact_create_params.rbi +89 -0
- data/rbi/telnyx/models/meeting_sessions/artifact_list_params.rbi +40 -0
- data/rbi/telnyx/models/meeting_sessions/artifact_list_response.rbi +39 -0
- data/rbi/telnyx/models/meeting_sessions/artifact_retrieve_params.rbi +48 -0
- data/rbi/telnyx/models/meeting_sessions/meeting_session_artifact.rbi +264 -0
- data/rbi/telnyx/models/meeting_sessions/meeting_session_artifact_response.rbi +46 -0
- data/rbi/telnyx/models/phone_numbers/voicemail_pref_response.rbi +149 -2
- data/rbi/telnyx/models/phone_numbers/voicemail_request.rbi +145 -2
- data/rbi/telnyx/models/private_wireless_gateway_status.rbi +2 -2
- data/rbi/telnyx/models/recording_available_webhook_event.rbi +146 -0
- data/rbi/telnyx/models/rime_voice_settings.rbi +17 -0
- data/rbi/telnyx/models/session_status_changed_webhook_event.rbi +171 -0
- data/rbi/telnyx/models/sim_cards/action_bulk_enable_voice_params.rbi +21 -1
- data/rbi/telnyx/models/sim_cards/action_disable_voice_params.rbi +40 -0
- data/rbi/telnyx/models/sim_cards/action_disable_voice_response.rbi +45 -0
- data/rbi/telnyx/models/sim_cards/action_enable_voice_params.rbi +63 -0
- data/rbi/telnyx/models/sim_cards/action_enable_voice_response.rbi +45 -0
- data/rbi/telnyx/models/sim_cards/action_list_params.rbi +10 -0
- data/rbi/telnyx/models/sim_cards/wireless_sim_card_action.rbi +16 -0
- data/rbi/telnyx/models/storage/edge_compute_pagination_meta.rbi +70 -0
- data/rbi/telnyx/models/storage/sql_database.rbi +131 -0
- data/rbi/telnyx/models/storage/sql_database_response_wrapper.rbi +35 -0
- data/rbi/telnyx/models/storage/sqldb_create_params.rbi +44 -0
- data/rbi/telnyx/models/storage/sqldb_delete_params.rbi +56 -0
- data/rbi/telnyx/models/storage/sqldb_list_params.rbi +198 -0
- data/rbi/telnyx/models/storage/sqldb_retrieve_params.rbi +40 -0
- data/rbi/telnyx/models/storage/sqldbs/action_query_params.rbi +125 -0
- data/rbi/telnyx/models/storage/sqldbs/action_query_response.rbi +226 -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/models/transcript_completed_webhook_event.rbi +166 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +5 -0
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +5 -0
- data/rbi/telnyx/models/web_search/research_citation.rbi +53 -0
- data/rbi/telnyx/models/web_search/research_create_params.rbi +138 -0
- data/rbi/telnyx/models/web_search/research_create_response.rbi +235 -0
- data/rbi/telnyx/models/web_search/research_retrieve_params.rbi +40 -0
- data/rbi/telnyx/models/web_search/research_retrieve_response.rbi +179 -0
- data/rbi/telnyx/models/web_search_contents_params.rbi +119 -0
- data/rbi/telnyx/models/web_search_contents_response.rbi +232 -0
- data/rbi/telnyx/models/web_search_create_params.rbi +162 -0
- data/rbi/telnyx/models/web_search_create_response.rbi +127 -0
- data/rbi/telnyx/models/web_search_result.rbi +83 -0
- data/rbi/telnyx/models.rbi +49 -0
- data/rbi/telnyx/resources/calls/actions.rbi +22 -10
- data/rbi/telnyx/resources/calls.rbi +5 -5
- data/rbi/telnyx/resources/conferences/actions.rbi +6 -1
- data/rbi/telnyx/resources/meeting_sessions/actions.rbi +71 -0
- data/rbi/telnyx/resources/meeting_sessions/artifacts.rbi +67 -0
- data/rbi/telnyx/resources/meeting_sessions.rbi +256 -0
- data/rbi/telnyx/resources/messaging_profiles.rbi +1 -1
- data/rbi/telnyx/resources/phone_numbers/voicemail.rbi +22 -2
- data/rbi/telnyx/resources/sim_cards/actions.rbi +56 -1
- data/rbi/telnyx/resources/storage/sqldbs/actions.rbi +50 -0
- data/rbi/telnyx/resources/storage/sqldbs.rbi +105 -0
- data/rbi/telnyx/resources/storage.rbi +4 -0
- data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +7 -0
- data/rbi/telnyx/resources/texml.rbi +7 -0
- data/rbi/telnyx/resources/web_search/research.rbi +71 -0
- data/rbi/telnyx/resources/web_search.rbi +86 -0
- data/rbi/telnyx/resources/webhooks.rbi +10 -0
- data/sig/telnyx/client.rbs +4 -0
- data/sig/telnyx/models/artifact_completed_webhook_event.rbs +120 -0
- data/sig/telnyx/models/artifact_failed_webhook_event.rbs +88 -0
- data/sig/telnyx/models/call_dial_params.rbs +27 -5
- data/sig/telnyx/models/calls/action_answer_params.rbs +7 -5
- data/sig/telnyx/models/calls/action_transfer_params.rbs +27 -5
- data/sig/telnyx/models/meeting_session.rbs +277 -0
- data/sig/telnyx/models/meeting_session_create_params.rbs +222 -0
- data/sig/telnyx/models/meeting_session_delete_params.rbs +20 -0
- data/sig/telnyx/models/meeting_session_delete_recording_media_params.rbs +20 -0
- data/sig/telnyx/models/meeting_session_delete_recording_media_response.rbs +61 -0
- data/sig/telnyx/models/meeting_session_list_params.rbs +53 -0
- data/sig/telnyx/models/meeting_session_list_response.rbs +14 -0
- data/sig/telnyx/models/meeting_session_response.rbs +13 -0
- data/sig/telnyx/models/meeting_session_retrieve_events_params.rbs +36 -0
- data/sig/telnyx/models/meeting_session_retrieve_events_response.rbs +52 -0
- data/sig/telnyx/models/meeting_session_retrieve_params.rbs +20 -0
- data/sig/telnyx/models/meeting_session_retrieve_recordings_params.rbs +20 -0
- data/sig/telnyx/models/meeting_session_retrieve_recordings_response.rbs +34 -0
- data/sig/telnyx/models/meeting_session_retrieve_transcript_params.rbs +42 -0
- data/sig/telnyx/models/meeting_session_retrieve_transcript_response.rbs +77 -0
- data/sig/telnyx/models/meeting_session_update_params.rbs +36 -0
- data/sig/telnyx/models/meeting_sessions/action_accepted_response.rbs +30 -0
- data/sig/telnyx/models/meeting_sessions/action_send_chat_params.rbs +30 -0
- data/sig/telnyx/models/meeting_sessions/action_speak_params.rbs +42 -0
- data/sig/telnyx/models/meeting_sessions/action_stop_speaking_params.rbs +22 -0
- data/sig/telnyx/models/meeting_sessions/artifact_create_params.rbs +44 -0
- data/sig/telnyx/models/meeting_sessions/artifact_list_params.rbs +22 -0
- data/sig/telnyx/models/meeting_sessions/artifact_list_response.rbs +20 -0
- data/sig/telnyx/models/meeting_sessions/artifact_retrieve_params.rbs +30 -0
- data/sig/telnyx/models/meeting_sessions/meeting_session_artifact.rbs +109 -0
- data/sig/telnyx/models/meeting_sessions/meeting_session_artifact_response.rbs +22 -0
- data/sig/telnyx/models/phone_numbers/voicemail_pref_response.rbs +59 -3
- data/sig/telnyx/models/phone_numbers/voicemail_request.rbs +59 -3
- data/sig/telnyx/models/recording_available_webhook_event.rbs +65 -0
- data/sig/telnyx/models/rime_voice_settings.rbs +11 -1
- data/sig/telnyx/models/session_status_changed_webhook_event.rbs +82 -0
- data/sig/telnyx/models/sim_cards/action_bulk_enable_voice_params.rbs +7 -1
- data/sig/telnyx/models/sim_cards/action_disable_voice_params.rbs +22 -0
- data/sig/telnyx/models/sim_cards/action_disable_voice_response.rbs +20 -0
- data/sig/telnyx/models/sim_cards/action_enable_voice_params.rbs +32 -0
- data/sig/telnyx/models/sim_cards/action_enable_voice_response.rbs +20 -0
- data/sig/telnyx/models/sim_cards/action_list_params.rbs +4 -0
- data/sig/telnyx/models/sim_cards/wireless_sim_card_action.rbs +8 -1
- data/sig/telnyx/models/storage/edge_compute_pagination_meta.rbs +45 -0
- data/sig/telnyx/models/storage/sql_database.rbs +80 -0
- data/sig/telnyx/models/storage/sql_database_response_wrapper.rbs +20 -0
- data/sig/telnyx/models/storage/sqldb_create_params.rbs +25 -0
- data/sig/telnyx/models/storage/sqldb_delete_params.rbs +31 -0
- data/sig/telnyx/models/storage/sqldb_list_params.rbs +97 -0
- data/sig/telnyx/models/storage/sqldb_retrieve_params.rbs +22 -0
- data/sig/telnyx/models/storage/sqldbs/action_query_params.rbs +52 -0
- data/sig/telnyx/models/storage/sqldbs/action_query_response.rbs +124 -0
- 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/models/transcript_completed_webhook_event.rbs +82 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +5 -0
- data/sig/telnyx/models/unwrap_webhook_event.rbs +5 -0
- data/sig/telnyx/models/web_search/research_citation.rbs +21 -0
- data/sig/telnyx/models/web_search/research_create_params.rbs +63 -0
- data/sig/telnyx/models/web_search/research_create_response.rbs +95 -0
- data/sig/telnyx/models/web_search/research_retrieve_params.rbs +25 -0
- data/sig/telnyx/models/web_search/research_retrieve_response.rbs +80 -0
- data/sig/telnyx/models/web_search_contents_params.rbs +59 -0
- data/sig/telnyx/models/web_search_contents_response.rbs +104 -0
- data/sig/telnyx/models/web_search_create_params.rbs +89 -0
- data/sig/telnyx/models/web_search_create_response.rbs +65 -0
- data/sig/telnyx/models/web_search_result.rbs +49 -0
- data/sig/telnyx/models.rbs +42 -0
- data/sig/telnyx/resources/calls/actions.rbs +2 -2
- data/sig/telnyx/resources/calls.rbs +1 -1
- data/sig/telnyx/resources/meeting_sessions/actions.rbs +28 -0
- data/sig/telnyx/resources/meeting_sessions/artifacts.rbs +26 -0
- data/sig/telnyx/resources/meeting_sessions.rbs +75 -0
- data/sig/telnyx/resources/phone_numbers/voicemail.rbs +2 -0
- data/sig/telnyx/resources/sim_cards/actions.rbs +12 -0
- data/sig/telnyx/resources/storage/sqldbs/actions.rbs +18 -0
- data/sig/telnyx/resources/storage/sqldbs.rbs +36 -0
- data/sig/telnyx/resources/storage.rbs +2 -0
- data/sig/telnyx/resources/texml/accounts/conferences/participants.rbs +1 -0
- data/sig/telnyx/resources/texml.rbs +1 -0
- data/sig/telnyx/resources/web_search/research.rbs +22 -0
- data/sig/telnyx/resources/web_search.rbs +29 -0
- data/sig/telnyx/resources/webhooks.rbs +10 -0
- metadata +185 -2
|
@@ -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
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
class TranscriptCompletedWebhookEvent < Telnyx::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# Unique event id; deduplicate deliveries on it.
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute data
|
|
13
|
+
# Finalized transcript details.
|
|
14
|
+
#
|
|
15
|
+
# @return [Telnyx::Models::TranscriptCompletedWebhookEvent::Data]
|
|
16
|
+
required :data, -> { Telnyx::TranscriptCompletedWebhookEvent::Data }
|
|
17
|
+
|
|
18
|
+
# @!attribute event
|
|
19
|
+
# Event type.
|
|
20
|
+
#
|
|
21
|
+
# @return [Symbol, Telnyx::Models::TranscriptCompletedWebhookEvent::Event]
|
|
22
|
+
required :event, enum: -> { Telnyx::TranscriptCompletedWebhookEvent::Event }
|
|
23
|
+
|
|
24
|
+
# @!attribute occurred_at
|
|
25
|
+
# When the event occurred.
|
|
26
|
+
#
|
|
27
|
+
# @return [Time]
|
|
28
|
+
required :occurred_at, Time
|
|
29
|
+
|
|
30
|
+
# @!attribute version
|
|
31
|
+
# Envelope version.
|
|
32
|
+
#
|
|
33
|
+
# @return [String]
|
|
34
|
+
required :version, String
|
|
35
|
+
|
|
36
|
+
# @!method initialize(id:, data:, event:, occurred_at:, version:)
|
|
37
|
+
# @param id [String] Unique event id; deduplicate deliveries on it.
|
|
38
|
+
#
|
|
39
|
+
# @param data [Telnyx::Models::TranscriptCompletedWebhookEvent::Data] Finalized transcript details.
|
|
40
|
+
#
|
|
41
|
+
# @param event [Symbol, Telnyx::Models::TranscriptCompletedWebhookEvent::Event] Event type.
|
|
42
|
+
#
|
|
43
|
+
# @param occurred_at [Time] When the event occurred.
|
|
44
|
+
#
|
|
45
|
+
# @param version [String] Envelope version.
|
|
46
|
+
|
|
47
|
+
# @see Telnyx::Models::TranscriptCompletedWebhookEvent#data
|
|
48
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
49
|
+
# @!attribute ended_at
|
|
50
|
+
# Session end time, or null when unavailable.
|
|
51
|
+
#
|
|
52
|
+
# @return [Time, nil]
|
|
53
|
+
required :ended_at, Time, nil?: true
|
|
54
|
+
|
|
55
|
+
# @!attribute last_seq
|
|
56
|
+
# Last transcript segment sequence number, or null for an empty transcript.
|
|
57
|
+
#
|
|
58
|
+
# @return [Integer, nil]
|
|
59
|
+
required :last_seq, Integer, nil?: true
|
|
60
|
+
|
|
61
|
+
# @!attribute segment_count
|
|
62
|
+
# Number of transcript segments observed during finalization.
|
|
63
|
+
#
|
|
64
|
+
# @return [Integer]
|
|
65
|
+
required :segment_count, Integer
|
|
66
|
+
|
|
67
|
+
# @!attribute session_id
|
|
68
|
+
# The meeting session this event belongs to.
|
|
69
|
+
#
|
|
70
|
+
# @return [String]
|
|
71
|
+
required :session_id, String
|
|
72
|
+
|
|
73
|
+
# @!method initialize(ended_at:, last_seq:, segment_count:, session_id:)
|
|
74
|
+
# Finalized transcript details.
|
|
75
|
+
#
|
|
76
|
+
# @param ended_at [Time, nil] Session end time, or null when unavailable.
|
|
77
|
+
#
|
|
78
|
+
# @param last_seq [Integer, nil] Last transcript segment sequence number, or null for an empty transcript.
|
|
79
|
+
#
|
|
80
|
+
# @param segment_count [Integer] Number of transcript segments observed during finalization.
|
|
81
|
+
#
|
|
82
|
+
# @param session_id [String] The meeting session this event belongs to.
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Event type.
|
|
86
|
+
#
|
|
87
|
+
# @see Telnyx::Models::TranscriptCompletedWebhookEvent#event
|
|
88
|
+
module Event
|
|
89
|
+
extend Telnyx::Internal::Type::Enum
|
|
90
|
+
|
|
91
|
+
TRANSCRIPT_COMPLETED = :"transcript.completed"
|
|
92
|
+
|
|
93
|
+
# @!method self.values
|
|
94
|
+
# @return [Array<Symbol>]
|
|
95
|
+
end
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
end
|
|
@@ -11,6 +11,10 @@ module Telnyx
|
|
|
11
11
|
|
|
12
12
|
variant -> { Telnyx::CallAIGatherPartialResultsWebhookEvent }
|
|
13
13
|
|
|
14
|
+
variant -> { Telnyx::ArtifactCompletedWebhookEvent }
|
|
15
|
+
|
|
16
|
+
variant -> { Telnyx::ArtifactFailedWebhookEvent }
|
|
17
|
+
|
|
14
18
|
variant -> { Telnyx::CallAnsweredWebhookEvent }
|
|
15
19
|
|
|
16
20
|
variant -> { Telnyx::CallBridgedWebhookEvent }
|
|
@@ -137,12 +141,18 @@ module Telnyx
|
|
|
137
141
|
|
|
138
142
|
variant -> { Telnyx::NumberOrderStatusUpdateWebhookEvent }
|
|
139
143
|
|
|
144
|
+
variant -> { Telnyx::RecordingAvailableWebhookEvent }
|
|
145
|
+
|
|
140
146
|
variant -> { Telnyx::ReplacedLinkClickWebhookEvent }
|
|
141
147
|
|
|
148
|
+
variant -> { Telnyx::SessionStatusChangedWebhookEvent }
|
|
149
|
+
|
|
150
|
+
variant -> { Telnyx::TranscriptCompletedWebhookEvent }
|
|
151
|
+
|
|
142
152
|
variant -> { Telnyx::TranscriptionWebhookEvent }
|
|
143
153
|
|
|
144
154
|
# @!method self.variants
|
|
145
|
-
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
155
|
+
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
146
156
|
end
|
|
147
157
|
end
|
|
148
158
|
end
|
|
@@ -11,6 +11,10 @@ module Telnyx
|
|
|
11
11
|
|
|
12
12
|
variant -> { Telnyx::CallAIGatherPartialResultsWebhookEvent }
|
|
13
13
|
|
|
14
|
+
variant -> { Telnyx::ArtifactCompletedWebhookEvent }
|
|
15
|
+
|
|
16
|
+
variant -> { Telnyx::ArtifactFailedWebhookEvent }
|
|
17
|
+
|
|
14
18
|
variant -> { Telnyx::CallAnsweredWebhookEvent }
|
|
15
19
|
|
|
16
20
|
variant -> { Telnyx::CallBridgedWebhookEvent }
|
|
@@ -137,12 +141,18 @@ module Telnyx
|
|
|
137
141
|
|
|
138
142
|
variant -> { Telnyx::NumberOrderStatusUpdateWebhookEvent }
|
|
139
143
|
|
|
144
|
+
variant -> { Telnyx::RecordingAvailableWebhookEvent }
|
|
145
|
+
|
|
140
146
|
variant -> { Telnyx::ReplacedLinkClickWebhookEvent }
|
|
141
147
|
|
|
148
|
+
variant -> { Telnyx::SessionStatusChangedWebhookEvent }
|
|
149
|
+
|
|
150
|
+
variant -> { Telnyx::TranscriptCompletedWebhookEvent }
|
|
151
|
+
|
|
142
152
|
variant -> { Telnyx::TranscriptionWebhookEvent }
|
|
143
153
|
|
|
144
154
|
# @!method self.variants
|
|
145
|
-
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
155
|
+
# @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
|
|
146
156
|
end
|
|
147
157
|
end
|
|
148
158
|
end
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module WebSearch
|
|
6
|
+
class ResearchCitation < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute title
|
|
8
|
+
# Title of the source page.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :title, String
|
|
12
|
+
|
|
13
|
+
# @!attribute url
|
|
14
|
+
# Source URL.
|
|
15
|
+
#
|
|
16
|
+
# @return [String]
|
|
17
|
+
required :url, String
|
|
18
|
+
|
|
19
|
+
# @!attribute snippet
|
|
20
|
+
# Relevant excerpt from the source (if available).
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :snippet, String
|
|
24
|
+
|
|
25
|
+
# @!method initialize(title:, url:, snippet: nil)
|
|
26
|
+
# @param title [String] Title of the source page.
|
|
27
|
+
#
|
|
28
|
+
# @param url [String] Source URL.
|
|
29
|
+
#
|
|
30
|
+
# @param snippet [String] Relevant excerpt from the source (if available).
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module WebSearch
|
|
6
|
+
# @see Telnyx::Resources::WebSearch::Research#create
|
|
7
|
+
class ResearchCreateParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute query
|
|
12
|
+
# The research question or topic.
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :query, String
|
|
16
|
+
|
|
17
|
+
# @!attribute background
|
|
18
|
+
# When `true`, the research runs asynchronously. The response returns a `task_id`
|
|
19
|
+
# immediately instead of waiting for the result. Poll
|
|
20
|
+
# `GET /web_search/research/{task_id}` to check status.
|
|
21
|
+
#
|
|
22
|
+
# @return [Boolean, nil]
|
|
23
|
+
optional :background, Telnyx::Internal::Type::Boolean
|
|
24
|
+
|
|
25
|
+
# @!attribute max_sources
|
|
26
|
+
# Maximum number of sources to use.
|
|
27
|
+
#
|
|
28
|
+
# @return [Integer, nil]
|
|
29
|
+
optional :max_sources, Integer
|
|
30
|
+
|
|
31
|
+
# @!attribute research_effort
|
|
32
|
+
# Research depth level. `lite` is fastest, `deep` is most thorough.
|
|
33
|
+
#
|
|
34
|
+
# @return [Symbol, Telnyx::Models::WebSearch::ResearchCreateParams::ResearchEffort, nil]
|
|
35
|
+
optional :research_effort, enum: -> { Telnyx::WebSearch::ResearchCreateParams::ResearchEffort }
|
|
36
|
+
|
|
37
|
+
# @!method initialize(query:, background: nil, max_sources: nil, research_effort: nil, request_options: {})
|
|
38
|
+
# Some parameter documentations has been truncated, see
|
|
39
|
+
# {Telnyx::Models::WebSearch::ResearchCreateParams} for more details.
|
|
40
|
+
#
|
|
41
|
+
# @param query [String] The research question or topic.
|
|
42
|
+
#
|
|
43
|
+
# @param background [Boolean] When `true`, the research runs asynchronously. The response returns a `task_id`
|
|
44
|
+
#
|
|
45
|
+
# @param max_sources [Integer] Maximum number of sources to use.
|
|
46
|
+
#
|
|
47
|
+
# @param research_effort [Symbol, Telnyx::Models::WebSearch::ResearchCreateParams::ResearchEffort] Research depth level. `lite` is fastest, `deep` is most thorough.
|
|
48
|
+
#
|
|
49
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
50
|
+
|
|
51
|
+
# Research depth level. `lite` is fastest, `deep` is most thorough.
|
|
52
|
+
module ResearchEffort
|
|
53
|
+
extend Telnyx::Internal::Type::Enum
|
|
54
|
+
|
|
55
|
+
LITE = :lite
|
|
56
|
+
STANDARD = :standard
|
|
57
|
+
DEEP = :deep
|
|
58
|
+
|
|
59
|
+
# @!method self.values
|
|
60
|
+
# @return [Array<Symbol>]
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|