telnyx 5.169.0 → 5.171.0

data/lib/telnyx/models/call_dial_params.rb

@@ -54,7 +54,16 @@ module Telnyx
       #   `greeting_end` or `detect_words` is used and a `machine` is detected, you will
       #   receive another `call.machine.greeting.ended` webhook when the answering machine
       #   greeting ends with a beep or silence. If `detect_beep` is used, you will only
-      #   receive `call.machine.greeting.ended` if a beep is detected.
+      #   receive `call.machine.greeting.ended` if a beep is detected. If
+      #   `answering_machine_detection` is set to `premium_ios_call_screening_detection`,
+      #   Premium AMD runs with iOS Call Screening support: after an initial `machine`
+      #   result, Telnyx listens for the iOS call-screening prompt to end or for an Apple
+      #   Call Screening tone, sends `call.machine.premium.greeting.ended` with
+      #   `result=prompt_ended` or `call.machine.premium.call_screening.detected` with
+      #   `result=screening` respectively. When the Apple Call Screening tone is detected,
+      #   Premium AMD is restarted on the screened call and a
+      #   `call.machine.premium.detection.ended` webhook with the post-screening
+      #   classification follows.
       #
       #   @return [Symbol, Telnyx::Models::CallDialParams::AnsweringMachineDetection, nil]
       optional :answering_machine_detection, enum: -> { Telnyx::CallDialParams::AnsweringMachineDetection }
@@ -63,16 +72,19 @@ module Telnyx
       #   Optional configuration parameters to modify 'answering_machine_detection'
       #   performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
       #   parameters are applicable when `premium` is selected as
-      #   answering_machine_detection.
+      #   answering_machine_detection. `prompt_end_timeout_millis` is additionally
+      #   applicable when `premium_ios_call_screening_detection` is selected.
       #
       #   @return [Telnyx::Models::CallDialParams::AnsweringMachineDetectionConfig, nil]
       optional :answering_machine_detection_config,
                -> { Telnyx::CallDialParams::AnsweringMachineDetectionConfig }
 
       # @!attribute assistant
-      #   AI Assistant configuration. All fields except `id` are optional — the
-      #   assistant's stored configuration will be used as fallback for any omitted
-      #   fields.
+      #   AI Assistant configuration and per-call overrides. All fields except `id` are
+      #   optional. Omitted assistant fields use the stored configuration. Supplied
+      #   `voice_settings` and `transcription` objects replace their stored objects rather
+      #   than merging individual settings; include every setting you want to retain.
+      #   `dynamic_variables` are merged, with request values taking precedence.
       #
       #   @return [Telnyx::Models::CallAssistantRequest, nil]
       optional :assistant, -> { Telnyx::CallAssistantRequest }
@@ -532,7 +544,7 @@ module Telnyx
       #
       #   @param answering_machine_detection_config [Telnyx::Models::CallDialParams::AnsweringMachineDetectionConfig] Optional configuration parameters to modify 'answering_machine_detection' perfor
       #
-      #   @param assistant [Telnyx::Models::CallAssistantRequest] AI Assistant configuration. All fields except `id` are optional — the assistant'
+      #   @param assistant [Telnyx::Models::CallAssistantRequest] AI Assistant configuration and per-call overrides. All fields except `id` are op
       #
       #   @param audio_url [String] The URL of a file to be played back to the callee when the call is answered. The
       #
@@ -696,11 +708,21 @@ module Telnyx
       # `greeting_end` or `detect_words` is used and a `machine` is detected, you will
       # receive another `call.machine.greeting.ended` webhook when the answering machine
       # greeting ends with a beep or silence. If `detect_beep` is used, you will only
-      # receive `call.machine.greeting.ended` if a beep is detected.
+      # receive `call.machine.greeting.ended` if a beep is detected. If
+      # `answering_machine_detection` is set to `premium_ios_call_screening_detection`,
+      # Premium AMD runs with iOS Call Screening support: after an initial `machine`
+      # result, Telnyx listens for the iOS call-screening prompt to end or for an Apple
+      # Call Screening tone, sends `call.machine.premium.greeting.ended` with
+      # `result=prompt_ended` or `call.machine.premium.call_screening.detected` with
+      # `result=screening` respectively. When the Apple Call Screening tone is detected,
+      # Premium AMD is restarted on the screened call and a
+      # `call.machine.premium.detection.ended` webhook with the post-screening
+      # classification follows.
       module AnsweringMachineDetection
         extend Telnyx::Internal::Type::Enum
 
         PREMIUM = :premium
+        PREMIUM_IOS_CALL_SCREENING_DETECTION = :premium_ios_call_screening_detection
         DETECT = :detect
         DETECT_BEEP = :detect_beep
         DETECT_WORDS = :detect_words
@@ -826,6 +848,15 @@ module Telnyx
         #   @return [Integer, nil]
         optional :maximum_word_length_millis, Integer
 
+        # @!attribute prompt_end_timeout_millis
+        #   Maximum time Telnyx waits, in milliseconds, for the iOS call-screening prompt to
+        #   end after Premium AMD initially detects a `machine`. Used when
+        #   `answering_machine_detection` is `premium_ios_call_screening_detection`.
+        #   Defaults to 5000 milliseconds.
+        #
+        #   @return [Integer, nil]
+        optional :prompt_end_timeout_millis, Integer
+
         # @!attribute silence_threshold
         #   Minimum noise threshold for any analysis.
         #
@@ -838,7 +869,7 @@ module Telnyx
         #   @return [Integer, nil]
         optional :total_analysis_time_millis, Integer
 
-        # @!method initialize(after_greeting_silence_millis: nil, beep_detection_profile: nil, beep_max_frequency_hz: nil, beep_min_frequency_hz: nil, beep_min_tone_duration_millis: nil, beep_spectral_confirmation: nil, beep_spectral_min_purity: nil, beep_spectral_reject_fax_cng: nil, beep_spectral_window_millis: nil, between_words_silence_millis: nil, greeting_duration_millis: nil, greeting_silence_duration_millis: nil, greeting_total_analysis_time_millis: nil, initial_silence_millis: nil, maximum_number_of_words: nil, maximum_word_length_millis: nil, silence_threshold: nil, total_analysis_time_millis: nil)
+        # @!method initialize(after_greeting_silence_millis: nil, beep_detection_profile: nil, beep_max_frequency_hz: nil, beep_min_frequency_hz: nil, beep_min_tone_duration_millis: nil, beep_spectral_confirmation: nil, beep_spectral_min_purity: nil, beep_spectral_reject_fax_cng: nil, beep_spectral_window_millis: nil, between_words_silence_millis: nil, greeting_duration_millis: nil, greeting_silence_duration_millis: nil, greeting_total_analysis_time_millis: nil, initial_silence_millis: nil, maximum_number_of_words: nil, maximum_word_length_millis: nil, prompt_end_timeout_millis: nil, silence_threshold: nil, total_analysis_time_millis: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::CallDialParams::AnsweringMachineDetectionConfig} for more
         #   details.
@@ -846,7 +877,8 @@ module Telnyx
         #   Optional configuration parameters to modify 'answering_machine_detection'
         #   performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
         #   parameters are applicable when `premium` is selected as
-        #   answering_machine_detection.
+        #   answering_machine_detection. `prompt_end_timeout_millis` is additionally
+        #   applicable when `premium_ios_call_screening_detection` is selected.
         #
         #   @param after_greeting_silence_millis [Integer] Silence duration threshold after a greeting message or voice for it be considere
         #
@@ -880,6 +912,8 @@ module Telnyx
         #
         #   @param maximum_word_length_millis [Integer] If a single word lasts longer than this threshold, consider it a machine.
         #
+        #   @param prompt_end_timeout_millis [Integer] Maximum time Telnyx waits, in milliseconds, for the iOS call-screening prompt to
+        #
         #   @param silence_threshold [Integer] Minimum noise threshold for any analysis.
         #
         #   @param total_analysis_time_millis [Integer] Maximum timeout threshold for overall detection.

data/lib/telnyx/models/call_machine_premium_call_screening_detected_webhook_event.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class CallMachinePremiumCallScreeningDetectedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data, nil]
+      optional :data, -> { Telnyx::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data]
+
+      # @see Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Identifies the type of resource.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute event_type
+        #   The type of event being delivered.
+        #
+        #   @return [Symbol, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::EventType, nil]
+        optional :event_type,
+                 enum: -> { Telnyx::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::EventType }
+
+        # @!attribute occurred_at
+        #   ISO 8601 datetime of when the event occurred.
+        #
+        #   @return [Time, nil]
+        optional :occurred_at, Time
+
+        # @!attribute payload
+        #
+        #   @return [Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::Payload, nil]
+        optional :payload, -> { Telnyx::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::Payload }
+
+        # @!attribute record_type
+        #   Identifies the type of the resource.
+        #
+        #   @return [Symbol, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::RecordType, nil]
+        optional :record_type,
+                 enum: -> { Telnyx::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::RecordType }
+
+        # @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
+        #   @param id [String] Identifies the type of resource.
+        #
+        #   @param event_type [Symbol, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::EventType] The type of event being delivered.
+        #
+        #   @param occurred_at [Time] ISO 8601 datetime of when the event occurred.
+        #
+        #   @param payload [Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::Payload]
+        #
+        #   @param record_type [Symbol, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::RecordType] Identifies the type of the resource.
+
+        # The type of event being delivered.
+        #
+        # @see Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data#event_type
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          CALL_MACHINE_PREMIUM_CALL_SCREENING_DETECTED = :"call.machine.premium.call_screening.detected"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data#payload
+        class Payload < Telnyx::Internal::Type::BaseModel
+          # @!attribute call_control_id
+          #   Call ID used to issue commands via Call Control API.
+          #
+          #   @return [String, nil]
+          optional :call_control_id, String
+
+          # @!attribute call_leg_id
+          #   ID that is unique to the call and can be used to correlate webhook events.
+          #
+          #   @return [String, nil]
+          optional :call_leg_id, String
+
+          # @!attribute call_session_id
+          #   ID that is unique to the call session and can be used to correlate webhook
+          #   events. Call session is a group of related call legs that logically belong to
+          #   the same phone call, e.g. an inbound and outbound leg of a transferred call.
+          #
+          #   @return [String, nil]
+          optional :call_session_id, String
+
+          # @!attribute client_state
+          #   State received from a command.
+          #
+          #   @return [String, nil]
+          optional :client_state, String
+
+          # @!attribute connection_id
+          #   Call Control App ID (formerly Telnyx connection ID) used in the call.
+          #
+          #   @return [String, nil]
+          optional :connection_id, String
+
+          # @!attribute from
+          #   Number or SIP URI placing the call.
+          #
+          #   @return [String, nil]
+          optional :from, String
+
+          # @!attribute result
+          #   Apple Call Screening detection result. Sent when an Apple Call Screening tone is
+          #   detected; Premium Answering Machine Detection is restarted on the screened call
+          #   afterwards.
+          #
+          #   @return [Symbol, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::Payload::Result, nil]
+          optional :result,
+                   enum: -> { Telnyx::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::Payload::Result }
+
+          # @!attribute to
+          #   Destination number or SIP URI of the call.
+          #
+          #   @return [String, nil]
+          optional :to, String
+
+          # @!method initialize(call_control_id: nil, call_leg_id: nil, call_session_id: nil, client_state: nil, connection_id: nil, from: nil, result: nil, to: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::Payload}
+          #   for more details.
+          #
+          #   @param call_control_id [String] Call ID used to issue commands via Call Control API.
+          #
+          #   @param call_leg_id [String] ID that is unique to the call and can be used to correlate webhook events.
+          #
+          #   @param call_session_id [String] ID that is unique to the call session and can be used to correlate webhook event
+          #
+          #   @param client_state [String] State received from a command.
+          #
+          #   @param connection_id [String] Call Control App ID (formerly Telnyx connection ID) used in the call.
+          #
+          #   @param from [String] Number or SIP URI placing the call.
+          #
+          #   @param result [Symbol, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::Payload::Result] Apple Call Screening detection result. Sent when an Apple Call Screening tone is
+          #
+          #   @param to [String] Destination number or SIP URI of the call.
+
+          # Apple Call Screening detection result. Sent when an Apple Call Screening tone is
+          # detected; Premium Answering Machine Detection is restarted on the screened call
+          # afterwards.
+          #
+          # @see Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data::Payload#result
+          module Result
+            extend Telnyx::Internal::Type::Enum
+
+            SCREENING = :screening
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Identifies the type of the resource.
+        #
+        # @see Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/call_machine_premium_detection_started_webhook_event.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class CallMachinePremiumDetectionStartedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data, nil]
+      optional :data, -> { Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data]
+
+      # @see Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Identifies the type of resource.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute event_type
+        #   The type of event being delivered.
+        #
+        #   @return [Symbol, Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data::EventType, nil]
+        optional :event_type, enum: -> { Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::EventType }
+
+        # @!attribute occurred_at
+        #   ISO 8601 datetime of when the event occurred.
+        #
+        #   @return [Time, nil]
+        optional :occurred_at, Time
+
+        # @!attribute payload
+        #
+        #   @return [Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data::Payload, nil]
+        optional :payload, -> { Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::Payload }
+
+        # @!attribute record_type
+        #   Identifies the type of the resource.
+        #
+        #   @return [Symbol, Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data::RecordType, nil]
+        optional :record_type,
+                 enum: -> { Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::RecordType }
+
+        # @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
+        #   @param id [String] Identifies the type of resource.
+        #
+        #   @param event_type [Symbol, Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data::EventType] The type of event being delivered.
+        #
+        #   @param occurred_at [Time] ISO 8601 datetime of when the event occurred.
+        #
+        #   @param payload [Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data::Payload]
+        #
+        #   @param record_type [Symbol, Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data::RecordType] Identifies the type of the resource.
+
+        # The type of event being delivered.
+        #
+        # @see Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data#event_type
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          CALL_MACHINE_PREMIUM_DETECTION_STARTED = :"call.machine.premium.detection.started"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data#payload
+        class Payload < Telnyx::Internal::Type::BaseModel
+          # @!attribute call_control_id
+          #   Call ID used to issue commands via Call Control API.
+          #
+          #   @return [String, nil]
+          optional :call_control_id, String
+
+          # @!attribute call_leg_id
+          #   ID that is unique to the call and can be used to correlate webhook events.
+          #
+          #   @return [String, nil]
+          optional :call_leg_id, String
+
+          # @!attribute call_session_id
+          #   ID that is unique to the call session and can be used to correlate webhook
+          #   events. Call session is a group of related call legs that logically belong to
+          #   the same phone call, e.g. an inbound and outbound leg of a transferred call.
+          #
+          #   @return [String, nil]
+          optional :call_session_id, String
+
+          # @!attribute client_state
+          #   State received from a command.
+          #
+          #   @return [String, nil]
+          optional :client_state, String
+
+          # @!attribute connection_id
+          #   Call Control App ID (formerly Telnyx connection ID) used in the call.
+          #
+          #   @return [String, nil]
+          optional :connection_id, String
+
+          # @!attribute from
+          #   Number or SIP URI placing the call.
+          #
+          #   @return [String, nil]
+          optional :from, String
+
+          # @!attribute to
+          #   Destination number or SIP URI of the call.
+          #
+          #   @return [String, nil]
+          optional :to, String
+
+          # @!method initialize(call_control_id: nil, call_leg_id: nil, call_session_id: nil, client_state: nil, connection_id: nil, from: nil, to: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data::Payload}
+          #   for more details.
+          #
+          #   @param call_control_id [String] Call ID used to issue commands via Call Control API.
+          #
+          #   @param call_leg_id [String] ID that is unique to the call and can be used to correlate webhook events.
+          #
+          #   @param call_session_id [String] ID that is unique to the call session and can be used to correlate webhook event
+          #
+          #   @param client_state [String] State received from a command.
+          #
+          #   @param connection_id [String] Call Control App ID (formerly Telnyx connection ID) used in the call.
+          #
+          #   @param from [String] Number or SIP URI placing the call.
+          #
+          #   @param to [String] Destination number or SIP URI of the call.
+        end
+
+        # Identifies the type of the resource.
+        #
+        # @see Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/call_machine_premium_greeting_ended.rb

@@ -96,7 +96,9 @@ module Telnyx
         optional :from, String
 
         # @!attribute result
-        #   Premium Answering Machine Greeting Ended result.
+        #   Premium Answering Machine Greeting Ended result. `prompt_ended` is only sent
+        #   when `answering_machine_detection` is `premium_ios_call_screening_detection` and
+        #   the iOS call-screening prompt ends without a beep.
         #
         #   @return [Symbol, Telnyx::Models::CallMachinePremiumGreetingEnded::Payload::Result, nil]
         optional :result, enum: -> { Telnyx::CallMachinePremiumGreetingEnded::Payload::Result }
@@ -123,11 +125,13 @@ module Telnyx
         #
         #   @param from [String] Number or SIP URI placing the call.
         #
-        #   @param result [Symbol, Telnyx::Models::CallMachinePremiumGreetingEnded::Payload::Result] Premium Answering Machine Greeting Ended result.
+        #   @param result [Symbol, Telnyx::Models::CallMachinePremiumGreetingEnded::Payload::Result] Premium Answering Machine Greeting Ended result. `prompt_ended` is only sent whe
         #
         #   @param to [String] Destination number or SIP URI of the call.
 
-        # Premium Answering Machine Greeting Ended result.
+        # Premium Answering Machine Greeting Ended result. `prompt_ended` is only sent
+        # when `answering_machine_detection` is `premium_ios_call_screening_detection` and
+        # the iOS call-screening prompt ends without a beep.
         #
         # @see Telnyx::Models::CallMachinePremiumGreetingEnded::Payload#result
         module Result
@@ -135,6 +139,7 @@ module Telnyx
 
           BEEP_DETECTED = :beep_detected
           NO_BEEP_DETECTED = :no_beep_detected
+          PROMPT_ENDED = :prompt_ended
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/telnyx/models/calls/action_answer_params.rb

@@ -14,9 +14,11 @@ module Telnyx
         required :call_control_id, String
 
         # @!attribute assistant
-        #   AI Assistant configuration. All fields except `id` are optional — the
-        #   assistant's stored configuration will be used as fallback for any omitted
-        #   fields.
+        #   AI Assistant configuration and per-call overrides. All fields except `id` are
+        #   optional. Omitted assistant fields use the stored configuration. Supplied
+        #   `voice_settings` and `transcription` objects replace their stored objects rather
+        #   than merging individual settings; include every setting you want to retain.
+        #   `dynamic_variables` are merged, with request values taking precedence.
         #
         #   @return [Telnyx::Models::CallAssistantRequest, nil]
         optional :assistant, -> { Telnyx::CallAssistantRequest }
@@ -192,7 +194,9 @@ module Telnyx
         optional :stream_url, String
 
         # @!attribute transcription
-        #   Enable transcription upon call answer. The default value is false.
+        #   Enable standalone call transcription upon call answer. The default value is
+        #   false. Configure this feature with `transcription_config`. To configure speech
+        #   recognition for an AI assistant, use `assistant.transcription` instead.
         #
         #   @return [Boolean, nil]
         optional :transcription, Telnyx::Internal::Type::Boolean
@@ -245,7 +249,7 @@ module Telnyx
         #
         #   @param call_control_id [String]
         #
-        #   @param assistant [Telnyx::Models::CallAssistantRequest] AI Assistant configuration. All fields except `id` are optional — the assistant'
+        #   @param assistant [Telnyx::Models::CallAssistantRequest] AI Assistant configuration and per-call overrides. All fields except `id` are op
         #
         #   @param billing_group_id [String] Use this field to set the Billing Group ID for the call. Must be a valid and exi
         #
@@ -296,7 +300,7 @@ module Telnyx
         #
         #   @param stream_url [String] The destination WebSocket address where the stream is going to be delivered.
         #
-        #   @param transcription [Boolean] Enable transcription upon call answer. The default value is false.
+        #   @param transcription [Boolean] Enable standalone call transcription upon call answer. The default value is fals
         #
         #   @param transcription_config [Telnyx::Models::Calls::TranscriptionStartRequest]
         #

data/lib/telnyx/models/calls/action_gather_using_ai_params.rb

@@ -121,10 +121,10 @@ module Telnyx
         #     the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
         #     [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
         #     for compatibility.
-        #   - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
-        #     Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
-        #     Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
-        #     [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
+        #   - **Azure:** Use `Azure.<VoiceId>` (e.g., `Azure.en-CA-ClaraNeural`,
+        #     `Azure.en-CA-LiamNeural`, `Azure.en-US-BrianMultilingualNeural`,
+        #     `Azure.en-US-Ava:DragonHDLatestNeural`). For a complete list of voices, go to
+        #     [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).
         #   - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
         #     `ElevenLabs.BaseModel.John`). The `ModelId` part is optional. To use
         #     ElevenLabs, you must provide your ElevenLabs API key as an integration secret
@@ -139,6 +139,12 @@ module Telnyx
         #   - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
         #     `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
         #     `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+        #   - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+        #     Supported model: `tts-rt-v2`. Browse the catalog via the
+        #     [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+        #     Every voice speaks all supported languages; set `language` to the two-letter
+        #     ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+        #     `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
         #   - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
         #     `ara`, `rex`, `sal`, `leo`.
         #   - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -152,7 +158,7 @@ module Telnyx
         # @!attribute voice_settings
         #   The settings associated with the voice selected
         #
-        #   @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings, nil]
+        #   @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings, nil]
         optional :voice_settings, union: -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings }
 
         # @!method initialize(call_control_id:, parameters:, assistant: nil, client_state: nil, command_id: nil, gather_ended_speech: nil, greeting: nil, interruption_settings: nil, language: nil, message_history: nil, send_message_history_updates: nil, send_partial_results: nil, transcription: nil, user_response_timeout_ms: nil, voice: nil, voice_settings: nil, request_options: {})
@@ -189,7 +195,7 @@ module Telnyx
         #
         #   @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
         #
-        #   @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
+        #   @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings] The settings associated with the voice selected
         #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
@@ -243,8 +249,10 @@ module Telnyx
 
           variant :xai, -> { Telnyx::XaiVoiceSettings }
 
+          variant :soniox, -> { Telnyx::Calls::SonioxVoiceSettings }
+
           # @!method self.variants
-          #   @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings)]
+          #   @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings)]
         end
       end
     end

data/lib/telnyx/models/calls/action_gather_using_speak_params.rb

@@ -64,6 +64,12 @@ module Telnyx
         #   - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
         #     `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
         #     `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+        #   - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+        #     Supported model: `tts-rt-v2`. Browse the catalog via the
+        #     [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+        #     Every voice speaks all supported languages; set `language` to the two-letter
+        #     ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+        #     `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
         #   - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
         #     `ara`, `rex`, `sal`, `leo`.
         #   - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -170,7 +176,7 @@ module Telnyx
         # @!attribute voice_settings
         #   The settings associated with the voice selected
         #
-        #   @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, nil]
+        #   @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings, nil]
         optional :voice_settings, union: -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings }
 
         # @!method initialize(call_control_id:, payload:, voice:, client_state: nil, command_id: nil, inter_digit_timeout_millis: nil, invalid_payload: nil, language: nil, maximum_digits: nil, maximum_tries: nil, minimum_digits: nil, payload_type: nil, service_level: nil, terminating_digit: nil, timeout_millis: nil, valid_digits: nil, voice_settings: nil, request_options: {})
@@ -210,7 +216,7 @@ module Telnyx
         #
         #   @param valid_digits [String] A list of all digits accepted as valid.
         #
-        #   @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
+        #   @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings] The settings associated with the voice selected
         #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
@@ -299,8 +305,10 @@ module Telnyx
 
           variant :xai, -> { Telnyx::XaiVoiceSettings }
 
+          variant :soniox, -> { Telnyx::Calls::SonioxVoiceSettings }
+
           # @!method self.variants
-          #   @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings)]
+          #   @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings)]
         end
       end
     end