telnyx 5.168.0 → 5.169.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 +7 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +40 -0
- data/lib/telnyx/internal/type/union.rb +6 -6
- data/lib/telnyx/models/ai/assistant_create_params.rb +6 -6
- data/lib/telnyx/models/ai/assistant_tool.rb +285 -12
- data/lib/telnyx/models/ai/assistant_update_params.rb +20 -9
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +20 -9
- data/lib/telnyx/models/ai/audio_transcribe_params.rb +33 -13
- data/lib/telnyx/models/ai/audio_transcribe_response.rb +34 -56
- data/lib/telnyx/models/ai/audio_transcription_response_word.rb +74 -0
- data/lib/telnyx/models/ai/chat_completion_request.rb +3 -26
- data/lib/telnyx/models/ai/flow_node.rb +2 -2
- data/lib/telnyx/models/ai/inference_embedding.rb +13 -10
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +10 -1
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +21 -1
- data/lib/telnyx/models/ai/openai/function_definition.rb +31 -0
- data/lib/telnyx/models/ai/post_conversation_settings.rb +4 -4
- data/lib/telnyx/models/ai/post_conversation_settings_req.rb +4 -4
- data/lib/telnyx/models/ai/privacy_settings.rb +20 -1
- data/lib/telnyx/models/ai/retrieval_tool.rb +21 -1
- data/lib/telnyx/models/ai/telephony_settings.rb +86 -16
- data/lib/telnyx/models/ai/tool_node.rb +2 -2
- data/lib/telnyx/models/ai/transcription_settings.rb +12 -4
- data/lib/telnyx/models/ai/transcription_settings_config.rb +12 -11
- data/lib/telnyx/models/ai/typesafe/v1_systemone_params.rb +268 -0
- data/lib/telnyx/models/ai/typesafe/v1_systemone_response.rb +222 -0
- data/lib/telnyx/models/bot_challenge_create_params.rb +38 -0
- data/lib/telnyx/models/bot_challenge_create_response.rb +87 -0
- data/lib/telnyx/models/bot_session_list_params.rb +34 -0
- data/lib/telnyx/models/bot_session_list_response.rb +32 -0
- data/lib/telnyx/models/bot_signup_create_params.rb +103 -0
- data/lib/telnyx/models/bot_signup_resend_magic_link_params.rb +22 -0
- data/lib/telnyx/models/call_dial_params.rb +75 -7
- data/lib/telnyx/models/calls/action_transfer_params.rb +75 -7
- data/lib/telnyx/models/calls/transcription_config.rb +14 -3
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +6 -3
- data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -0
- data/lib/telnyx/models/compute/funcs/export_create_params.rb +62 -0
- data/lib/telnyx/models/compute/funcs/export_delete_all_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/export_list_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/func_log_export_config_response.rb +113 -0
- data/lib/telnyx/models/connection_retrieve_count_params.rb +14 -0
- data/lib/telnyx/models/connection_retrieve_count_response.rb +215 -0
- data/lib/telnyx/models/detail_record_list_params.rb +19 -2
- data/lib/telnyx/models/inbound_message_webhook_event.rb +3 -70
- data/lib/telnyx/models/machine_payment_account_credit_params.rb +29 -0
- data/lib/telnyx/models/machine_payment_account_credit_response.rb +223 -0
- data/lib/telnyx/models/message_retrieve_group_messages_response.rb +3 -3
- data/lib/telnyx/models/message_retrieve_response.rb +4 -4
- data/lib/telnyx/models/message_schedule_response.rb +3 -3
- data/lib/telnyx/models/message_send_group_mms_response.rb +3 -3
- data/lib/telnyx/models/message_send_long_code_response.rb +3 -3
- data/lib/telnyx/models/message_send_number_pool_response.rb +3 -3
- data/lib/telnyx/models/message_send_response.rb +3 -3
- data/lib/telnyx/models/message_send_short_code_response.rb +3 -3
- data/lib/telnyx/models/messaging_inbound_message.rb +71 -0
- data/lib/telnyx/models/messaging_inbound_message_payload.rb +216 -13
- data/lib/telnyx/models/messaging_outbound_message_payload.rb +42 -2
- data/lib/telnyx/models/noise_suppression_engine_list_params.rb +14 -0
- data/lib/telnyx/models/noise_suppression_engine_list_response.rb +50 -0
- data/lib/telnyx/models/number_order_status_update.rb +15 -3
- data/lib/telnyx/models/number_order_status_update_webhook_event.rb +15 -3
- data/lib/telnyx/models/outbound_message.rb +1 -0
- data/lib/telnyx/models/outbound_message_payload.rb +45 -5
- data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -0
- data/lib/telnyx/models/success_response.rb +27 -0
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +246 -3
- data/lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb +82 -1
- data/lib/telnyx/models/texml/call_create_params.rb +78 -0
- data/lib/telnyx/models/texml/call_create_response.rb +55 -0
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +76 -1
- data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +2 -2
- data/lib/telnyx/models.rb +18 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
- data/lib/telnyx/resources/ai/assistants.rb +2 -2
- data/lib/telnyx/resources/ai/audio.rb +2 -2
- data/lib/telnyx/resources/ai/typesafe/v1.rb +62 -0
- data/lib/telnyx/resources/ai/typesafe.rb +22 -0
- data/lib/telnyx/resources/ai.rb +4 -0
- data/lib/telnyx/resources/bot_challenge.rb +53 -0
- data/lib/telnyx/resources/bot_sessions.rb +57 -0
- data/lib/telnyx/resources/bot_signup.rb +97 -0
- data/lib/telnyx/resources/calls/actions.rb +1 -1
- data/lib/telnyx/resources/calls.rb +1 -1
- data/lib/telnyx/resources/compute/funcs/export.rb +105 -0
- data/lib/telnyx/resources/compute/funcs.rb +4 -0
- data/lib/telnyx/resources/connections.rb +20 -0
- data/lib/telnyx/resources/detail_records.rb +1 -1
- data/lib/telnyx/resources/email_messages.rb +5 -3
- data/lib/telnyx/resources/machine_payments.rb +73 -0
- data/lib/telnyx/resources/noise_suppression_engines.rb +37 -0
- data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +15 -1
- data/lib/telnyx/resources/texml/calls.rb +57 -0
- data/lib/telnyx/resources/texml.rb +20 -1
- data/lib/telnyx/resources/voice_clones.rb +4 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +33 -0
- data/rbi/telnyx/client.rbi +35 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +16 -12
- data/rbi/telnyx/models/ai/assistant_tool.rbi +423 -20
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +42 -16
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +42 -16
- data/rbi/telnyx/models/ai/audio_transcribe_params.rbi +71 -20
- data/rbi/telnyx/models/ai/audio_transcribe_response.rbi +63 -97
- data/rbi/telnyx/models/ai/audio_transcription_response_word.rbi +108 -0
- data/rbi/telnyx/models/ai/chat_completion_request.rbi +4 -58
- data/rbi/telnyx/models/ai/flow_node.rbi +4 -2
- data/rbi/telnyx/models/ai/inference_embedding.rbi +24 -16
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +10 -0
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +29 -3
- data/rbi/telnyx/models/ai/openai/function_definition.rbi +56 -0
- data/rbi/telnyx/models/ai/post_conversation_settings.rbi +4 -4
- data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +4 -4
- data/rbi/telnyx/models/ai/privacy_settings.rbi +43 -3
- data/rbi/telnyx/models/ai/retrieval_tool.rbi +29 -3
- data/rbi/telnyx/models/ai/telephony_settings.rbi +174 -20
- data/rbi/telnyx/models/ai/tool_node.rbi +4 -2
- data/rbi/telnyx/models/ai/transcription_settings.rbi +25 -6
- data/rbi/telnyx/models/ai/transcription_settings_config.rbi +18 -16
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_params.rbi +504 -0
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_response.rbi +348 -0
- data/rbi/telnyx/models/bot_challenge_create_params.rbi +68 -0
- data/rbi/telnyx/models/bot_challenge_create_response.rbi +169 -0
- data/rbi/telnyx/models/bot_session_list_params.rbi +53 -0
- data/rbi/telnyx/models/bot_session_list_response.rbi +64 -0
- data/rbi/telnyx/models/bot_signup_create_params.rbi +179 -0
- data/rbi/telnyx/models/bot_signup_resend_magic_link_params.rbi +43 -0
- data/rbi/telnyx/models/call_dial_params.rbi +111 -10
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +111 -10
- data/rbi/telnyx/models/calls/transcription_config.rbi +29 -5
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +11 -3
- data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +5 -0
- data/rbi/telnyx/models/compute/funcs/export_create_params.rbi +84 -0
- data/rbi/telnyx/models/compute/funcs/export_delete_all_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/export_list_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/func_log_export_config_response.rbi +227 -0
- data/rbi/telnyx/models/connection_retrieve_count_params.rbi +30 -0
- data/rbi/telnyx/models/connection_retrieve_count_response.rbi +353 -0
- data/rbi/telnyx/models/detail_record_list_params.rbi +30 -2
- data/rbi/telnyx/models/inbound_message_webhook_event.rbi +4 -173
- data/rbi/telnyx/models/machine_payment_account_credit_params.rbi +51 -0
- data/rbi/telnyx/models/machine_payment_account_credit_response.rbi +446 -0
- data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi +6 -12
- data/rbi/telnyx/models/message_retrieve_response.rbi +3 -3
- data/rbi/telnyx/models/message_schedule_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_group_mms_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_long_code_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_number_pool_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_short_code_response.rbi +4 -6
- data/rbi/telnyx/models/messaging_inbound_message.rbi +152 -0
- data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +477 -15
- data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +90 -16
- data/rbi/telnyx/models/noise_suppression_engine_list_params.rbi +30 -0
- data/rbi/telnyx/models/noise_suppression_engine_list_response.rbi +94 -0
- data/rbi/telnyx/models/number_order_status_update.rbi +34 -3
- data/rbi/telnyx/models/number_order_status_update_webhook_event.rbi +39 -3
- data/rbi/telnyx/models/outbound_message.rbi +5 -0
- data/rbi/telnyx/models/outbound_message_payload.rbi +74 -4
- data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +5 -0
- data/rbi/telnyx/models/success_response.rbi +36 -0
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +339 -0
- data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_params.rbi +111 -0
- data/rbi/telnyx/models/texml/call_create_params.rbi +124 -0
- data/rbi/telnyx/models/texml/call_create_response.rbi +98 -0
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +103 -0
- data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +4 -4
- data/rbi/telnyx/models.rbi +21 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +19 -7
- data/rbi/telnyx/resources/ai/assistants.rbi +25 -12
- data/rbi/telnyx/resources/ai/audio.rbi +20 -9
- data/rbi/telnyx/resources/ai/typesafe/v1.rbi +61 -0
- data/rbi/telnyx/resources/ai/typesafe.rbi +19 -0
- data/rbi/telnyx/resources/ai.rbi +3 -0
- data/rbi/telnyx/resources/bot_challenge.rbi +45 -0
- data/rbi/telnyx/resources/bot_sessions.rbi +45 -0
- data/rbi/telnyx/resources/bot_signup.rbi +87 -0
- data/rbi/telnyx/resources/calls/actions.rbi +6 -5
- data/rbi/telnyx/resources/calls.rbi +6 -5
- data/rbi/telnyx/resources/compute/funcs/export.rbi +86 -0
- data/rbi/telnyx/resources/compute/funcs.rbi +3 -0
- data/rbi/telnyx/resources/connections.rbi +11 -0
- data/rbi/telnyx/resources/detail_records.rbi +12 -1
- data/rbi/telnyx/resources/email_messages.rbi +5 -3
- data/rbi/telnyx/resources/machine_payments.rbi +64 -0
- data/rbi/telnyx/resources/noise_suppression_engines.rbi +26 -0
- data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +32 -0
- data/rbi/telnyx/resources/texml/calls.rbi +50 -0
- data/rbi/telnyx/resources/texml.rbi +36 -0
- data/rbi/telnyx/resources/voice_clones.rbi +4 -2
- data/sig/telnyx/client.rbs +10 -0
- data/sig/telnyx/models/ai/assistant_tool.rbs +162 -23
- data/sig/telnyx/models/ai/audio_transcribe_params.rbs +10 -0
- data/sig/telnyx/models/ai/audio_transcribe_response.rbs +29 -43
- data/sig/telnyx/models/ai/audio_transcription_response_word.rbs +60 -0
- data/sig/telnyx/models/ai/chat_completion_request.rbs +4 -35
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +5 -0
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +10 -3
- data/sig/telnyx/models/ai/openai/function_definition.rbs +34 -0
- data/sig/telnyx/models/ai/privacy_settings.rbs +11 -3
- data/sig/telnyx/models/ai/retrieval_tool.rbs +10 -3
- data/sig/telnyx/models/ai/telephony_settings.rbs +52 -4
- data/sig/telnyx/models/ai/transcription_settings.rbs +4 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_params.rbs +195 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_response.rbs +141 -0
- data/sig/telnyx/models/bot_challenge_create_params.rbs +42 -0
- data/sig/telnyx/models/bot_challenge_create_response.rbs +72 -0
- data/sig/telnyx/models/bot_session_list_params.rbs +28 -0
- data/sig/telnyx/models/bot_session_list_response.rbs +26 -0
- data/sig/telnyx/models/bot_signup_create_params.rbs +89 -0
- data/sig/telnyx/models/bot_signup_resend_magic_link_params.rbs +20 -0
- data/sig/telnyx/models/call_dial_params.rbs +49 -0
- data/sig/telnyx/models/calls/action_transfer_params.rbs +49 -0
- data/sig/telnyx/models/calls/transcription_config.rbs +4 -0
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +3 -1
- data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +3 -1
- data/sig/telnyx/models/compute/funcs/export_create_params.rbs +50 -0
- data/sig/telnyx/models/compute/funcs/export_delete_all_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/export_list_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/func_log_export_config_response.rbs +115 -0
- data/sig/telnyx/models/connection_retrieve_count_params.rbs +15 -0
- data/sig/telnyx/models/connection_retrieve_count_response.rbs +169 -0
- data/sig/telnyx/models/inbound_message_webhook_event.rbs +6 -79
- data/sig/telnyx/models/machine_payment_account_credit_params.rbs +23 -0
- data/sig/telnyx/models/machine_payment_account_credit_response.rbs +164 -0
- data/sig/telnyx/models/message_retrieve_group_messages_response.rbs +6 -8
- data/sig/telnyx/models/message_retrieve_response.rbs +1 -2
- data/sig/telnyx/models/message_schedule_response.rbs +6 -7
- data/sig/telnyx/models/message_send_group_mms_response.rbs +6 -6
- data/sig/telnyx/models/message_send_long_code_response.rbs +6 -6
- data/sig/telnyx/models/message_send_number_pool_response.rbs +6 -6
- data/sig/telnyx/models/message_send_response.rbs +6 -7
- data/sig/telnyx/models/message_send_short_code_response.rbs +6 -6
- data/sig/telnyx/models/messaging_inbound_message.rbs +76 -0
- data/sig/telnyx/models/messaging_inbound_message_payload.rbs +235 -6
- data/sig/telnyx/models/messaging_outbound_message_payload.rbs +39 -1
- data/sig/telnyx/models/noise_suppression_engine_list_params.rbs +15 -0
- data/sig/telnyx/models/noise_suppression_engine_list_response.rbs +43 -0
- data/sig/telnyx/models/number_order_status_update.rbs +14 -4
- data/sig/telnyx/models/number_order_status_update_webhook_event.rbs +14 -4
- data/sig/telnyx/models/outbound_message.rbs +2 -1
- data/sig/telnyx/models/outbound_message_payload.rbs +45 -7
- data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -0
- data/sig/telnyx/models/success_response.rbs +15 -0
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +159 -0
- data/sig/telnyx/models/texml/accounts/conferences/participant_participants_params.rbs +49 -0
- data/sig/telnyx/models/texml/call_create_params.rbs +72 -0
- data/sig/telnyx/models/texml/call_create_response.rbs +47 -0
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +49 -0
- data/sig/telnyx/models.rbs +18 -0
- data/sig/telnyx/resources/ai/typesafe/v1.rbs +17 -0
- data/sig/telnyx/resources/ai/typesafe.rbs +11 -0
- data/sig/telnyx/resources/ai.rbs +2 -0
- data/sig/telnyx/resources/bot_challenge.rbs +14 -0
- data/sig/telnyx/resources/bot_sessions.rbs +13 -0
- data/sig/telnyx/resources/bot_signup.rbs +24 -0
- data/sig/telnyx/resources/compute/funcs/export.rbs +30 -0
- data/sig/telnyx/resources/compute/funcs.rbs +2 -0
- data/sig/telnyx/resources/connections.rbs +4 -0
- data/sig/telnyx/resources/machine_payments.rbs +12 -0
- data/sig/telnyx/resources/noise_suppression_engines.rbs +11 -0
- data/sig/telnyx/resources/texml/accounts/conferences/participants.rbs +7 -0
- data/sig/telnyx/resources/texml/calls.rbs +19 -0
- data/sig/telnyx/resources/texml.rbs +9 -0
- metadata +101 -2
|
@@ -28,8 +28,8 @@ module Telnyx
|
|
|
28
28
|
# @!attribute event_type
|
|
29
29
|
# The type of event being sent
|
|
30
30
|
#
|
|
31
|
-
# @return [
|
|
32
|
-
required :event_type,
|
|
31
|
+
# @return [Symbol, Telnyx::Models::NumberOrderStatusUpdate::Data::EventType]
|
|
32
|
+
required :event_type, enum: -> { Telnyx::NumberOrderStatusUpdate::Data::EventType }
|
|
33
33
|
|
|
34
34
|
# @!attribute occurred_at
|
|
35
35
|
# ISO 8601 timestamp of when the event occurred
|
|
@@ -51,13 +51,25 @@ module Telnyx
|
|
|
51
51
|
# @!method initialize(id:, event_type:, occurred_at:, payload:, record_type:)
|
|
52
52
|
# @param id [String] Unique identifier for the event
|
|
53
53
|
#
|
|
54
|
-
# @param event_type [
|
|
54
|
+
# @param event_type [Symbol, Telnyx::Models::NumberOrderStatusUpdate::Data::EventType] The type of event being sent
|
|
55
55
|
#
|
|
56
56
|
# @param occurred_at [Time] ISO 8601 timestamp of when the event occurred
|
|
57
57
|
#
|
|
58
58
|
# @param payload [Telnyx::Models::NumberOrderWithPhoneNumbers]
|
|
59
59
|
#
|
|
60
60
|
# @param record_type [String] Type of record
|
|
61
|
+
|
|
62
|
+
# The type of event being sent
|
|
63
|
+
#
|
|
64
|
+
# @see Telnyx::Models::NumberOrderStatusUpdate::Data#event_type
|
|
65
|
+
module EventType
|
|
66
|
+
extend Telnyx::Internal::Type::Enum
|
|
67
|
+
|
|
68
|
+
NUMBER_ORDER_COMPLETE = :"number_order.complete"
|
|
69
|
+
|
|
70
|
+
# @!method self.values
|
|
71
|
+
# @return [Array<Symbol>]
|
|
72
|
+
end
|
|
61
73
|
end
|
|
62
74
|
|
|
63
75
|
# @see Telnyx::Models::NumberOrderStatusUpdate#meta
|
|
@@ -28,8 +28,8 @@ module Telnyx
|
|
|
28
28
|
# @!attribute event_type
|
|
29
29
|
# The type of event being sent
|
|
30
30
|
#
|
|
31
|
-
# @return [
|
|
32
|
-
required :event_type,
|
|
31
|
+
# @return [Symbol, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent::Data::EventType]
|
|
32
|
+
required :event_type, enum: -> { Telnyx::NumberOrderStatusUpdateWebhookEvent::Data::EventType }
|
|
33
33
|
|
|
34
34
|
# @!attribute occurred_at
|
|
35
35
|
# ISO 8601 timestamp of when the event occurred
|
|
@@ -56,7 +56,7 @@ module Telnyx
|
|
|
56
56
|
#
|
|
57
57
|
# @param id [String] Unique identifier for the event
|
|
58
58
|
#
|
|
59
|
-
# @param event_type [
|
|
59
|
+
# @param event_type [Symbol, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent::Data::EventType] The type of event being sent
|
|
60
60
|
#
|
|
61
61
|
# @param occurred_at [Time] ISO 8601 timestamp of when the event occurred
|
|
62
62
|
#
|
|
@@ -64,6 +64,18 @@ module Telnyx
|
|
|
64
64
|
#
|
|
65
65
|
# @param record_type [String] Type of record
|
|
66
66
|
|
|
67
|
+
# The type of event being sent
|
|
68
|
+
#
|
|
69
|
+
# @see Telnyx::Models::NumberOrderStatusUpdateWebhookEvent::Data#event_type
|
|
70
|
+
module EventType
|
|
71
|
+
extend Telnyx::Internal::Type::Enum
|
|
72
|
+
|
|
73
|
+
NUMBER_ORDER_COMPLETE = :"number_order.complete"
|
|
74
|
+
|
|
75
|
+
# @!method self.values
|
|
76
|
+
# @return [Array<Symbol>]
|
|
77
|
+
end
|
|
78
|
+
|
|
67
79
|
# @see Telnyx::Models::NumberOrderStatusUpdateWebhookEvent::Data#payload
|
|
68
80
|
class Payload < Telnyx::Internal::Type::BaseModel
|
|
69
81
|
# @!attribute id
|
|
@@ -9,6 +9,12 @@ module Telnyx
|
|
|
9
9
|
# @return [String, nil]
|
|
10
10
|
optional :id, String
|
|
11
11
|
|
|
12
|
+
# @!attribute body
|
|
13
|
+
# RCS webhook message body. Text messages use the text property.
|
|
14
|
+
#
|
|
15
|
+
# @return [Telnyx::Models::OutboundMessagePayload::Body, nil]
|
|
16
|
+
optional :body, -> { Telnyx::OutboundMessagePayload::Body }
|
|
17
|
+
|
|
12
18
|
# @!attribute cc
|
|
13
19
|
#
|
|
14
20
|
# @return [Array<Telnyx::Models::OutboundMessagePayload::Cc>, nil]
|
|
@@ -48,8 +54,8 @@ module Telnyx
|
|
|
48
54
|
# These errors may point at addressees when referring to unsuccessful/unconfirmed
|
|
49
55
|
# delivery statuses.
|
|
50
56
|
#
|
|
51
|
-
# @return [Array<Telnyx::Models::
|
|
52
|
-
optional :errors, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::
|
|
57
|
+
# @return [Array<Telnyx::Models::MessagingError0b38e7044b>, nil]
|
|
58
|
+
optional :errors, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::MessagingError0b38e7044b] }
|
|
53
59
|
|
|
54
60
|
# @!attribute from
|
|
55
61
|
#
|
|
@@ -190,12 +196,14 @@ module Telnyx
|
|
|
190
196
|
# @return [String, nil]
|
|
191
197
|
optional :webhook_url, String, nil?: true
|
|
192
198
|
|
|
193
|
-
# @!method initialize(id: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
199
|
+
# @!method initialize(id: nil, body: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
194
200
|
# Some parameter documentations has been truncated, see
|
|
195
201
|
# {Telnyx::Models::OutboundMessagePayload} for more details.
|
|
196
202
|
#
|
|
197
203
|
# @param id [String] Identifies the type of resource.
|
|
198
204
|
#
|
|
205
|
+
# @param body [Telnyx::Models::OutboundMessagePayload::Body] RCS webhook message body. Text messages use the text property.
|
|
206
|
+
#
|
|
199
207
|
# @param cc [Array<Telnyx::Models::OutboundMessagePayload::Cc>]
|
|
200
208
|
#
|
|
201
209
|
# @param completed_at [Time, nil] ISO 8601 formatted date indicating when the message was finalized.
|
|
@@ -208,7 +216,7 @@ module Telnyx
|
|
|
208
216
|
#
|
|
209
217
|
# @param encoding [String] Encoding scheme used for the message body.
|
|
210
218
|
#
|
|
211
|
-
# @param errors [Array<Telnyx::Models::
|
|
219
|
+
# @param errors [Array<Telnyx::Models::MessagingError0b38e7044b>] These errors may point at addressees when referring to unsuccessful/unconfirmed
|
|
212
220
|
#
|
|
213
221
|
# @param from [Telnyx::Models::OutboundMessagePayload::From]
|
|
214
222
|
#
|
|
@@ -254,6 +262,20 @@ module Telnyx
|
|
|
254
262
|
#
|
|
255
263
|
# @param webhook_url [String, nil] The URL where webhooks related to this message will be sent.
|
|
256
264
|
|
|
265
|
+
# @see Telnyx::Models::OutboundMessagePayload#body
|
|
266
|
+
class Body < Telnyx::Internal::Type::BaseModel
|
|
267
|
+
# @!attribute text
|
|
268
|
+
# RCS text message.
|
|
269
|
+
#
|
|
270
|
+
# @return [String, nil]
|
|
271
|
+
optional :text, String
|
|
272
|
+
|
|
273
|
+
# @!method initialize(text: nil)
|
|
274
|
+
# RCS webhook message body. Text messages use the text property.
|
|
275
|
+
#
|
|
276
|
+
# @param text [String] RCS text message.
|
|
277
|
+
end
|
|
278
|
+
|
|
257
279
|
class Cc < Telnyx::Internal::Type::BaseModel
|
|
258
280
|
# @!attribute carrier
|
|
259
281
|
# The carrier of the receiver.
|
|
@@ -415,6 +437,18 @@ module Telnyx
|
|
|
415
437
|
|
|
416
438
|
# @see Telnyx::Models::OutboundMessagePayload#from
|
|
417
439
|
class From < Telnyx::Internal::Type::BaseModel
|
|
440
|
+
# @!attribute agent_id
|
|
441
|
+
# RCS agent identifier.
|
|
442
|
+
#
|
|
443
|
+
# @return [String, nil]
|
|
444
|
+
optional :agent_id, String
|
|
445
|
+
|
|
446
|
+
# @!attribute agent_name
|
|
447
|
+
# RCS agent name.
|
|
448
|
+
#
|
|
449
|
+
# @return [String, nil]
|
|
450
|
+
optional :agent_name, String
|
|
451
|
+
|
|
418
452
|
# @!attribute carrier
|
|
419
453
|
# The carrier of the receiver.
|
|
420
454
|
#
|
|
@@ -434,10 +468,14 @@ module Telnyx
|
|
|
434
468
|
# @return [String, nil]
|
|
435
469
|
optional :phone_number, String
|
|
436
470
|
|
|
437
|
-
# @!method initialize(carrier: nil, line_type: nil, phone_number: nil)
|
|
471
|
+
# @!method initialize(agent_id: nil, agent_name: nil, carrier: nil, line_type: nil, phone_number: nil)
|
|
438
472
|
# Some parameter documentations has been truncated, see
|
|
439
473
|
# {Telnyx::Models::OutboundMessagePayload::From} for more details.
|
|
440
474
|
#
|
|
475
|
+
# @param agent_id [String] RCS agent identifier.
|
|
476
|
+
#
|
|
477
|
+
# @param agent_name [String] RCS agent name.
|
|
478
|
+
#
|
|
441
479
|
# @param carrier [String] The carrier of the receiver.
|
|
442
480
|
#
|
|
443
481
|
# @param line_type [Symbol, Telnyx::Models::OutboundMessagePayload::From::LineType] The line-type of the receiver.
|
|
@@ -574,6 +612,7 @@ module Telnyx
|
|
|
574
612
|
DELIVERY_UNCONFIRMED = :delivery_unconfirmed
|
|
575
613
|
DELIVERED = :delivered
|
|
576
614
|
DELIVERY_FAILED = :delivery_failed
|
|
615
|
+
READ = :read
|
|
577
616
|
|
|
578
617
|
# @!method self.values
|
|
579
618
|
# @return [Array<Symbol>]
|
|
@@ -588,6 +627,7 @@ module Telnyx
|
|
|
588
627
|
|
|
589
628
|
SMS = :SMS
|
|
590
629
|
MMS = :MMS
|
|
630
|
+
RCS = :RCS
|
|
591
631
|
|
|
592
632
|
# @!method self.values
|
|
593
633
|
# @return [Array<Symbol>]
|
|
@@ -159,6 +159,7 @@ module Telnyx
|
|
|
159
159
|
SPEECHMATICS_STANDARD = :"speechmatics/standard"
|
|
160
160
|
SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
|
|
161
161
|
NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
|
|
162
|
+
OMI_HEALTH_OMI_MED_STT_V1 = :"omi-health/omi-med-stt-v1"
|
|
162
163
|
HUMAIN_REALTIME = :"humain/realtime"
|
|
163
164
|
RESON8_TURNS = :"reson8/turns"
|
|
164
165
|
COHERE_AR_STT = :"cohere/ar-stt"
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::BotSignup#create
|
|
6
|
+
class SuccessResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute message
|
|
8
|
+
# Human-readable status message.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :message, String
|
|
12
|
+
|
|
13
|
+
# @!attribute success
|
|
14
|
+
# Whether the request was accepted.
|
|
15
|
+
#
|
|
16
|
+
# @return [Boolean]
|
|
17
|
+
required :success, Telnyx::Internal::Type::Boolean
|
|
18
|
+
|
|
19
|
+
# @!method initialize(message:, success:)
|
|
20
|
+
# Status envelope used by the signup and magic-link flows.
|
|
21
|
+
#
|
|
22
|
+
# @param message [String] Human-readable status message.
|
|
23
|
+
#
|
|
24
|
+
# @param success [Boolean] Whether the request was accepted.
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
@@ -170,6 +170,36 @@ module Telnyx
|
|
|
170
170
|
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Body::WithURL::MachineDetection },
|
|
171
171
|
api_name: :MachineDetection
|
|
172
172
|
|
|
173
|
+
# @!attribute machine_detection_beep_max_frequency
|
|
174
|
+
# Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
|
|
175
|
+
# Only used when MachineDetection is enabled.
|
|
176
|
+
#
|
|
177
|
+
# @return [Integer, nil]
|
|
178
|
+
optional :machine_detection_beep_max_frequency,
|
|
179
|
+
Integer,
|
|
180
|
+
api_name: :MachineDetectionBeepMaxFrequency
|
|
181
|
+
|
|
182
|
+
# @!attribute machine_detection_beep_min_frequency
|
|
183
|
+
# Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
|
|
184
|
+
# it above 480 excludes North American ringback (440 + 480 Hz), which can
|
|
185
|
+
# otherwise be reported as a beep when the `freq_only` profile is in use. Only
|
|
186
|
+
# used when MachineDetection is enabled.
|
|
187
|
+
#
|
|
188
|
+
# @return [Integer, nil]
|
|
189
|
+
optional :machine_detection_beep_min_frequency,
|
|
190
|
+
Integer,
|
|
191
|
+
api_name: :MachineDetectionBeepMinFrequency
|
|
192
|
+
|
|
193
|
+
# @!attribute machine_detection_beep_min_tone_duration
|
|
194
|
+
# Shortest tone, in milliseconds, that can be treated as a beep. Raising it
|
|
195
|
+
# rejects brief tones such as call-progress blips. Only used when MachineDetection
|
|
196
|
+
# is enabled.
|
|
197
|
+
#
|
|
198
|
+
# @return [Integer, nil]
|
|
199
|
+
optional :machine_detection_beep_min_tone_duration,
|
|
200
|
+
Integer,
|
|
201
|
+
api_name: :MachineDetectionBeepMinToneDuration
|
|
202
|
+
|
|
173
203
|
# @!attribute machine_detection_beep_profile
|
|
174
204
|
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
175
205
|
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
@@ -183,6 +213,43 @@ module Telnyx
|
|
|
183
213
|
},
|
|
184
214
|
api_name: :MachineDetectionBeepProfile
|
|
185
215
|
|
|
216
|
+
# @!attribute machine_detection_beep_spectral_confirmation
|
|
217
|
+
# When enabled, a candidate beep must pass an additional spectral check before it
|
|
218
|
+
# is reported. Only used when MachineDetection is enabled.
|
|
219
|
+
#
|
|
220
|
+
# @return [Boolean, nil]
|
|
221
|
+
optional :machine_detection_beep_spectral_confirmation,
|
|
222
|
+
Telnyx::Internal::Type::Boolean,
|
|
223
|
+
api_name: :MachineDetectionBeepSpectralConfirmation
|
|
224
|
+
|
|
225
|
+
# @!attribute machine_detection_beep_spectral_min_purity
|
|
226
|
+
# Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
|
|
227
|
+
# Raising it rejects mixed tones such as ringback, which combines two frequencies.
|
|
228
|
+
# Only used when MachineDetection is enabled.
|
|
229
|
+
#
|
|
230
|
+
# @return [Float, nil]
|
|
231
|
+
optional :machine_detection_beep_spectral_min_purity,
|
|
232
|
+
Float,
|
|
233
|
+
api_name: :MachineDetectionBeepSpectralMinPurity
|
|
234
|
+
|
|
235
|
+
# @!attribute machine_detection_beep_spectral_reject_fax_cng
|
|
236
|
+
# When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
|
|
237
|
+
# used when MachineDetection is enabled.
|
|
238
|
+
#
|
|
239
|
+
# @return [Boolean, nil]
|
|
240
|
+
optional :machine_detection_beep_spectral_reject_fax_cng,
|
|
241
|
+
Telnyx::Internal::Type::Boolean,
|
|
242
|
+
api_name: :MachineDetectionBeepSpectralRejectFaxCng
|
|
243
|
+
|
|
244
|
+
# @!attribute machine_detection_beep_spectral_window
|
|
245
|
+
# Length of the spectral confirmation window, in milliseconds. Only used when
|
|
246
|
+
# MachineDetection is enabled.
|
|
247
|
+
#
|
|
248
|
+
# @return [Integer, nil]
|
|
249
|
+
optional :machine_detection_beep_spectral_window,
|
|
250
|
+
Integer,
|
|
251
|
+
api_name: :MachineDetectionBeepSpectralWindow
|
|
252
|
+
|
|
186
253
|
# @!attribute machine_detection_prompt_end_timeout
|
|
187
254
|
# Silence duration threshold after a call screening prompt before ending prompt
|
|
188
255
|
# detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
|
|
@@ -409,7 +476,7 @@ module Telnyx
|
|
|
409
476
|
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Body::WithURL::URLMethod },
|
|
410
477
|
api_name: :UrlMethod
|
|
411
478
|
|
|
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)
|
|
479
|
+
# @!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_max_frequency: nil, machine_detection_beep_min_frequency: nil, machine_detection_beep_min_tone_duration: nil, machine_detection_beep_profile: nil, machine_detection_beep_spectral_confirmation: nil, machine_detection_beep_spectral_min_purity: nil, machine_detection_beep_spectral_reject_fax_cng: nil, machine_detection_beep_spectral_window: 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)
|
|
413
480
|
# Some parameter documentations has been truncated, see
|
|
414
481
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithURL} for more
|
|
415
482
|
# details.
|
|
@@ -446,8 +513,22 @@ module Telnyx
|
|
|
446
513
|
#
|
|
447
514
|
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithURL::MachineDetection] Enables Answering Machine Detection.
|
|
448
515
|
#
|
|
516
|
+
# @param machine_detection_beep_max_frequency [Integer] Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
|
|
517
|
+
#
|
|
518
|
+
# @param machine_detection_beep_min_frequency [Integer] Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
|
|
519
|
+
#
|
|
520
|
+
# @param machine_detection_beep_min_tone_duration [Integer] Shortest tone, in milliseconds, that can be treated as a beep. Raising it reject
|
|
521
|
+
#
|
|
449
522
|
# @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
523
|
#
|
|
524
|
+
# @param machine_detection_beep_spectral_confirmation [Boolean] When enabled, a candidate beep must pass an additional spectral check before it
|
|
525
|
+
#
|
|
526
|
+
# @param machine_detection_beep_spectral_min_purity [Float] Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep. Raisin
|
|
527
|
+
#
|
|
528
|
+
# @param machine_detection_beep_spectral_reject_fax_cng [Boolean] When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
|
|
529
|
+
#
|
|
530
|
+
# @param machine_detection_beep_spectral_window [Integer] Length of the spectral confirmation window, in milliseconds. Only used when Mach
|
|
531
|
+
#
|
|
451
532
|
# @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
|
|
452
533
|
#
|
|
453
534
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
@@ -881,6 +962,36 @@ module Telnyx
|
|
|
881
962
|
},
|
|
882
963
|
api_name: :MachineDetection
|
|
883
964
|
|
|
965
|
+
# @!attribute machine_detection_beep_max_frequency
|
|
966
|
+
# Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
|
|
967
|
+
# Only used when MachineDetection is enabled.
|
|
968
|
+
#
|
|
969
|
+
# @return [Integer, nil]
|
|
970
|
+
optional :machine_detection_beep_max_frequency,
|
|
971
|
+
Integer,
|
|
972
|
+
api_name: :MachineDetectionBeepMaxFrequency
|
|
973
|
+
|
|
974
|
+
# @!attribute machine_detection_beep_min_frequency
|
|
975
|
+
# Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
|
|
976
|
+
# it above 480 excludes North American ringback (440 + 480 Hz), which can
|
|
977
|
+
# otherwise be reported as a beep when the `freq_only` profile is in use. Only
|
|
978
|
+
# used when MachineDetection is enabled.
|
|
979
|
+
#
|
|
980
|
+
# @return [Integer, nil]
|
|
981
|
+
optional :machine_detection_beep_min_frequency,
|
|
982
|
+
Integer,
|
|
983
|
+
api_name: :MachineDetectionBeepMinFrequency
|
|
984
|
+
|
|
985
|
+
# @!attribute machine_detection_beep_min_tone_duration
|
|
986
|
+
# Shortest tone, in milliseconds, that can be treated as a beep. Raising it
|
|
987
|
+
# rejects brief tones such as call-progress blips. Only used when MachineDetection
|
|
988
|
+
# is enabled.
|
|
989
|
+
#
|
|
990
|
+
# @return [Integer, nil]
|
|
991
|
+
optional :machine_detection_beep_min_tone_duration,
|
|
992
|
+
Integer,
|
|
993
|
+
api_name: :MachineDetectionBeepMinToneDuration
|
|
994
|
+
|
|
884
995
|
# @!attribute machine_detection_beep_profile
|
|
885
996
|
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
886
997
|
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
@@ -894,6 +1005,43 @@ module Telnyx
|
|
|
894
1005
|
},
|
|
895
1006
|
api_name: :MachineDetectionBeepProfile
|
|
896
1007
|
|
|
1008
|
+
# @!attribute machine_detection_beep_spectral_confirmation
|
|
1009
|
+
# When enabled, a candidate beep must pass an additional spectral check before it
|
|
1010
|
+
# is reported. Only used when MachineDetection is enabled.
|
|
1011
|
+
#
|
|
1012
|
+
# @return [Boolean, nil]
|
|
1013
|
+
optional :machine_detection_beep_spectral_confirmation,
|
|
1014
|
+
Telnyx::Internal::Type::Boolean,
|
|
1015
|
+
api_name: :MachineDetectionBeepSpectralConfirmation
|
|
1016
|
+
|
|
1017
|
+
# @!attribute machine_detection_beep_spectral_min_purity
|
|
1018
|
+
# Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
|
|
1019
|
+
# Raising it rejects mixed tones such as ringback, which combines two frequencies.
|
|
1020
|
+
# Only used when MachineDetection is enabled.
|
|
1021
|
+
#
|
|
1022
|
+
# @return [Float, nil]
|
|
1023
|
+
optional :machine_detection_beep_spectral_min_purity,
|
|
1024
|
+
Float,
|
|
1025
|
+
api_name: :MachineDetectionBeepSpectralMinPurity
|
|
1026
|
+
|
|
1027
|
+
# @!attribute machine_detection_beep_spectral_reject_fax_cng
|
|
1028
|
+
# When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
|
|
1029
|
+
# used when MachineDetection is enabled.
|
|
1030
|
+
#
|
|
1031
|
+
# @return [Boolean, nil]
|
|
1032
|
+
optional :machine_detection_beep_spectral_reject_fax_cng,
|
|
1033
|
+
Telnyx::Internal::Type::Boolean,
|
|
1034
|
+
api_name: :MachineDetectionBeepSpectralRejectFaxCng
|
|
1035
|
+
|
|
1036
|
+
# @!attribute machine_detection_beep_spectral_window
|
|
1037
|
+
# Length of the spectral confirmation window, in milliseconds. Only used when
|
|
1038
|
+
# MachineDetection is enabled.
|
|
1039
|
+
#
|
|
1040
|
+
# @return [Integer, nil]
|
|
1041
|
+
optional :machine_detection_beep_spectral_window,
|
|
1042
|
+
Integer,
|
|
1043
|
+
api_name: :MachineDetectionBeepSpectralWindow
|
|
1044
|
+
|
|
897
1045
|
# @!attribute machine_detection_prompt_end_timeout
|
|
898
1046
|
# Silence duration threshold after a call screening prompt before ending prompt
|
|
899
1047
|
# detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
|
|
@@ -1124,7 +1272,7 @@ module Telnyx
|
|
|
1124
1272
|
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Body::WithTeXml::URLMethod },
|
|
1125
1273
|
api_name: :UrlMethod
|
|
1126
1274
|
|
|
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)
|
|
1275
|
+
# @!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_max_frequency: nil, machine_detection_beep_min_frequency: nil, machine_detection_beep_min_tone_duration: nil, machine_detection_beep_profile: nil, machine_detection_beep_spectral_confirmation: nil, machine_detection_beep_spectral_min_purity: nil, machine_detection_beep_spectral_reject_fax_cng: nil, machine_detection_beep_spectral_window: 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)
|
|
1128
1276
|
# Some parameter documentations has been truncated, see
|
|
1129
1277
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithTeXml} for more
|
|
1130
1278
|
# details.
|
|
@@ -1161,8 +1309,22 @@ module Telnyx
|
|
|
1161
1309
|
#
|
|
1162
1310
|
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::WithTeXml::MachineDetection] Enables Answering Machine Detection.
|
|
1163
1311
|
#
|
|
1312
|
+
# @param machine_detection_beep_max_frequency [Integer] Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
|
|
1313
|
+
#
|
|
1314
|
+
# @param machine_detection_beep_min_frequency [Integer] Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
|
|
1315
|
+
#
|
|
1316
|
+
# @param machine_detection_beep_min_tone_duration [Integer] Shortest tone, in milliseconds, that can be treated as a beep. Raising it reject
|
|
1317
|
+
#
|
|
1164
1318
|
# @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
1319
|
#
|
|
1320
|
+
# @param machine_detection_beep_spectral_confirmation [Boolean] When enabled, a candidate beep must pass an additional spectral check before it
|
|
1321
|
+
#
|
|
1322
|
+
# @param machine_detection_beep_spectral_min_purity [Float] Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep. Raisin
|
|
1323
|
+
#
|
|
1324
|
+
# @param machine_detection_beep_spectral_reject_fax_cng [Boolean] When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
|
|
1325
|
+
#
|
|
1326
|
+
# @param machine_detection_beep_spectral_window [Integer] Length of the spectral confirmation window, in milliseconds. Only used when Mach
|
|
1327
|
+
#
|
|
1166
1328
|
# @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
|
|
1167
1329
|
#
|
|
1168
1330
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|
|
@@ -1591,6 +1753,36 @@ module Telnyx
|
|
|
1591
1753
|
},
|
|
1592
1754
|
api_name: :MachineDetection
|
|
1593
1755
|
|
|
1756
|
+
# @!attribute machine_detection_beep_max_frequency
|
|
1757
|
+
# Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
|
|
1758
|
+
# Only used when MachineDetection is enabled.
|
|
1759
|
+
#
|
|
1760
|
+
# @return [Integer, nil]
|
|
1761
|
+
optional :machine_detection_beep_max_frequency,
|
|
1762
|
+
Integer,
|
|
1763
|
+
api_name: :MachineDetectionBeepMaxFrequency
|
|
1764
|
+
|
|
1765
|
+
# @!attribute machine_detection_beep_min_frequency
|
|
1766
|
+
# Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
|
|
1767
|
+
# it above 480 excludes North American ringback (440 + 480 Hz), which can
|
|
1768
|
+
# otherwise be reported as a beep when the `freq_only` profile is in use. Only
|
|
1769
|
+
# used when MachineDetection is enabled.
|
|
1770
|
+
#
|
|
1771
|
+
# @return [Integer, nil]
|
|
1772
|
+
optional :machine_detection_beep_min_frequency,
|
|
1773
|
+
Integer,
|
|
1774
|
+
api_name: :MachineDetectionBeepMinFrequency
|
|
1775
|
+
|
|
1776
|
+
# @!attribute machine_detection_beep_min_tone_duration
|
|
1777
|
+
# Shortest tone, in milliseconds, that can be treated as a beep. Raising it
|
|
1778
|
+
# rejects brief tones such as call-progress blips. Only used when MachineDetection
|
|
1779
|
+
# is enabled.
|
|
1780
|
+
#
|
|
1781
|
+
# @return [Integer, nil]
|
|
1782
|
+
optional :machine_detection_beep_min_tone_duration,
|
|
1783
|
+
Integer,
|
|
1784
|
+
api_name: :MachineDetectionBeepMinToneDuration
|
|
1785
|
+
|
|
1594
1786
|
# @!attribute machine_detection_beep_profile
|
|
1595
1787
|
# Selects which detectors must validate a beep. `both` requires the amplitude and
|
|
1596
1788
|
# frequency detectors to agree. `freq_only` uses the frequency detector alone, for
|
|
@@ -1604,6 +1796,43 @@ module Telnyx
|
|
|
1604
1796
|
},
|
|
1605
1797
|
api_name: :MachineDetectionBeepProfile
|
|
1606
1798
|
|
|
1799
|
+
# @!attribute machine_detection_beep_spectral_confirmation
|
|
1800
|
+
# When enabled, a candidate beep must pass an additional spectral check before it
|
|
1801
|
+
# is reported. Only used when MachineDetection is enabled.
|
|
1802
|
+
#
|
|
1803
|
+
# @return [Boolean, nil]
|
|
1804
|
+
optional :machine_detection_beep_spectral_confirmation,
|
|
1805
|
+
Telnyx::Internal::Type::Boolean,
|
|
1806
|
+
api_name: :MachineDetectionBeepSpectralConfirmation
|
|
1807
|
+
|
|
1808
|
+
# @!attribute machine_detection_beep_spectral_min_purity
|
|
1809
|
+
# Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
|
|
1810
|
+
# Raising it rejects mixed tones such as ringback, which combines two frequencies.
|
|
1811
|
+
# Only used when MachineDetection is enabled.
|
|
1812
|
+
#
|
|
1813
|
+
# @return [Float, nil]
|
|
1814
|
+
optional :machine_detection_beep_spectral_min_purity,
|
|
1815
|
+
Float,
|
|
1816
|
+
api_name: :MachineDetectionBeepSpectralMinPurity
|
|
1817
|
+
|
|
1818
|
+
# @!attribute machine_detection_beep_spectral_reject_fax_cng
|
|
1819
|
+
# When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
|
|
1820
|
+
# used when MachineDetection is enabled.
|
|
1821
|
+
#
|
|
1822
|
+
# @return [Boolean, nil]
|
|
1823
|
+
optional :machine_detection_beep_spectral_reject_fax_cng,
|
|
1824
|
+
Telnyx::Internal::Type::Boolean,
|
|
1825
|
+
api_name: :MachineDetectionBeepSpectralRejectFaxCng
|
|
1826
|
+
|
|
1827
|
+
# @!attribute machine_detection_beep_spectral_window
|
|
1828
|
+
# Length of the spectral confirmation window, in milliseconds. Only used when
|
|
1829
|
+
# MachineDetection is enabled.
|
|
1830
|
+
#
|
|
1831
|
+
# @return [Integer, nil]
|
|
1832
|
+
optional :machine_detection_beep_spectral_window,
|
|
1833
|
+
Integer,
|
|
1834
|
+
api_name: :MachineDetectionBeepSpectralWindow
|
|
1835
|
+
|
|
1607
1836
|
# @!attribute machine_detection_prompt_end_timeout
|
|
1608
1837
|
# Silence duration threshold after a call screening prompt before ending prompt
|
|
1609
1838
|
# detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
|
|
@@ -1845,7 +2074,7 @@ module Telnyx
|
|
|
1845
2074
|
},
|
|
1846
2075
|
api_name: :UrlMethod
|
|
1847
2076
|
|
|
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)
|
|
2077
|
+
# @!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_max_frequency: nil, machine_detection_beep_min_frequency: nil, machine_detection_beep_min_tone_duration: nil, machine_detection_beep_profile: nil, machine_detection_beep_spectral_confirmation: nil, machine_detection_beep_spectral_min_purity: nil, machine_detection_beep_spectral_reject_fax_cng: nil, machine_detection_beep_spectral_window: 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)
|
|
1849
2078
|
# Some parameter documentations has been truncated, see
|
|
1850
2079
|
# {Telnyx::Models::Texml::Accounts::CallCallsParams::Body::ApplicationDefault} for
|
|
1851
2080
|
# more details.
|
|
@@ -1880,8 +2109,22 @@ module Telnyx
|
|
|
1880
2109
|
#
|
|
1881
2110
|
# @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::MachineDetection] Enables Answering Machine Detection.
|
|
1882
2111
|
#
|
|
2112
|
+
# @param machine_detection_beep_max_frequency [Integer] Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
|
|
2113
|
+
#
|
|
2114
|
+
# @param machine_detection_beep_min_frequency [Integer] Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
|
|
2115
|
+
#
|
|
2116
|
+
# @param machine_detection_beep_min_tone_duration [Integer] Shortest tone, in milliseconds, that can be treated as a beep. Raising it reject
|
|
2117
|
+
#
|
|
1883
2118
|
# @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
2119
|
#
|
|
2120
|
+
# @param machine_detection_beep_spectral_confirmation [Boolean] When enabled, a candidate beep must pass an additional spectral check before it
|
|
2121
|
+
#
|
|
2122
|
+
# @param machine_detection_beep_spectral_min_purity [Float] Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep. Raisin
|
|
2123
|
+
#
|
|
2124
|
+
# @param machine_detection_beep_spectral_reject_fax_cng [Boolean] When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
|
|
2125
|
+
#
|
|
2126
|
+
# @param machine_detection_beep_spectral_window [Integer] Length of the spectral confirmation window, in milliseconds. Only used when Mach
|
|
2127
|
+
#
|
|
1885
2128
|
# @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
|
|
1886
2129
|
#
|
|
1887
2130
|
# @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
|