telnyx 5.119.0 → 5.121.0

data/rbi/telnyx/models/call_dial_params.rbi

@@ -156,6 +156,25 @@ module Telnyx
       end
       attr_writer :conference_config
 
+      # Starts a Conversation Relay session automatically when the answered/dialed call
+      # is answered. This embedded shape is supported on `answer` and `dial`. It uses
+      # public field names (`url`, `dtmf_detection`, `greeting`, `voice`, `language`,
+      # etc.) and maps them to the underlying Conversation Relay action. `client_state`,
+      # `tts_language`, and `transcription_language` inside this object are ignored; use
+      # the parent command's `client_state` and `command_id` fields instead.
+      sig do
+        returns(T.nilable(Telnyx::CallDialParams::ConversationRelayConfig))
+      end
+      attr_reader :conversation_relay_config
+
+      sig do
+        params(
+          conversation_relay_config:
+            Telnyx::CallDialParams::ConversationRelayConfig::OrHash
+        ).void
+      end
+      attr_writer :conversation_relay_config
+
       # Custom headers to be added to the SIP INVITE.
       sig { returns(T.nilable(T::Array[Telnyx::CustomSipHeader])) }
       attr_reader :custom_headers
@@ -668,6 +687,8 @@ module Telnyx
           client_state: String,
           command_id: String,
           conference_config: Telnyx::CallDialParams::ConferenceConfig::OrHash,
+          conversation_relay_config:
+            Telnyx::CallDialParams::ConversationRelayConfig::OrHash,
           custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash],
           deepfake_detection: Telnyx::CallDialParams::DeepfakeDetection::OrHash,
           dialogflow_config: Telnyx::DialogflowConfig::OrHash,
@@ -798,6 +819,13 @@ module Telnyx
         command_id: nil,
         # Optional configuration parameters to dial new participant into a conference.
         conference_config: nil,
+        # Starts a Conversation Relay session automatically when the answered/dialed call
+        # is answered. This embedded shape is supported on `answer` and `dial`. It uses
+        # public field names (`url`, `dtmf_detection`, `greeting`, `voice`, `language`,
+        # etc.) and maps them to the underlying Conversation Relay action. `client_state`,
+        # `tts_language`, and `transcription_language` inside this object are ignored; use
+        # the parent command's `client_state` and `command_id` fields instead.
+        conversation_relay_config: nil,
         # Custom headers to be added to the SIP INVITE.
         custom_headers: nil,
         # Enables deepfake detection on the call. When enabled, audio from the remote
@@ -975,6 +1003,8 @@ module Telnyx
             client_state: String,
             command_id: String,
             conference_config: Telnyx::CallDialParams::ConferenceConfig,
+            conversation_relay_config:
+              Telnyx::CallDialParams::ConversationRelayConfig,
             custom_headers: T::Array[Telnyx::CustomSipHeader],
             deepfake_detection: Telnyx::CallDialParams::DeepfakeDetection,
             dialogflow_config: Telnyx::DialogflowConfig,
@@ -1636,6 +1666,1249 @@ module Telnyx
         end
       end
 
+      class ConversationRelayConfig < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::CallDialParams::ConversationRelayConfig,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # WebSocket URL for your Conversation Relay server. Must start with `ws://` or
+        # `wss://`.
+        sig { returns(String) }
+        attr_accessor :url
+
+        # Custom key-value parameters forwarded to the relay session as assistant dynamic
+        # variables.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :custom_parameters
+
+        sig { params(custom_parameters: T::Hash[Symbol, T.anything]).void }
+        attr_writer :custom_parameters
+
+        # Enable DTMF detection for the relay session.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :dtmf_detection
+
+        sig { params(dtmf_detection: T::Boolean).void }
+        attr_writer :dtmf_detection
+
+        # Text played when the relay session starts.
+        sig { returns(T.nilable(String)) }
+        attr_reader :greeting
+
+        sig { params(greeting: String).void }
+        attr_writer :greeting
+
+        # Controls when caller input can interrupt assistant speech. `any` allows speech
+        # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+        # only; `dtmf` allows DTMF only.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallDialParams::ConversationRelayConfig::Interruptible::OrSymbol
+            )
+          )
+        end
+        attr_reader :interruptible
+
+        sig do
+          params(
+            interruptible:
+              Telnyx::CallDialParams::ConversationRelayConfig::Interruptible::OrSymbol
+          ).void
+        end
+        attr_writer :interruptible
+
+        # Controls when caller input can interrupt assistant speech. `any` allows speech
+        # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+        # only; `dtmf` allows DTMF only.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallDialParams::ConversationRelayConfig::InterruptibleGreeting::OrSymbol
+            )
+          )
+        end
+        attr_reader :interruptible_greeting
+
+        sig do
+          params(
+            interruptible_greeting:
+              Telnyx::CallDialParams::ConversationRelayConfig::InterruptibleGreeting::OrSymbol
+          ).void
+        end
+        attr_writer :interruptible_greeting
+
+        # Settings for handling caller interruptions during Conversation Relay speech.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings
+            )
+          )
+        end
+        attr_reader :interruption_settings
+
+        sig do
+          params(
+            interruption_settings:
+              Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::OrHash
+          ).void
+        end
+        attr_writer :interruption_settings
+
+        # Default language for both text-to-speech and speech recognition.
+        sig { returns(T.nilable(String)) }
+        attr_reader :language
+
+        sig { params(language: String).void }
+        attr_writer :language
+
+        # Per-language TTS and transcription settings.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Telnyx::CallDialParams::ConversationRelayConfig::Language
+              ]
+            )
+          )
+        end
+        attr_reader :languages
+
+        sig do
+          params(
+            languages:
+              T::Array[
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::OrHash
+              ]
+          ).void
+        end
+        attr_writer :languages
+
+        # Structured voice provider. Must be supplied together with `structured_provider`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :provider
+
+        sig { params(provider: String).void }
+        attr_writer :provider
+
+        # Provider-specific structured voice settings. Must be supplied together with
+        # `provider`; Telnyx sends the value as the nested provider configuration for
+        # Conversation Relay.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :structured_provider
+
+        sig { params(structured_provider: T::Hash[Symbol, T.anything]).void }
+        attr_writer :structured_provider
+
+        # Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+        # `Telnyx` are supported for backward compatibility. For Conversation Relay, use
+        # this field with `transcription_engine_config`; the `transcription` object is not
+        # supported.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::OrSymbol
+            )
+          )
+        end
+        attr_reader :transcription_engine
+
+        sig do
+          params(
+            transcription_engine:
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::OrSymbol
+          ).void
+        end
+        attr_writer :transcription_engine
+
+        # Engine-specific transcription settings for Conversation Relay. This accepts the
+        # same provider-specific options used by the Call Transcription Start command,
+        # such as `transcription_model`, without requiring the engine discriminator to be
+        # repeated inside this object.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :transcription_engine_config
+
+        sig do
+          params(transcription_engine_config: T::Hash[Symbol, T.anything]).void
+        end
+        attr_writer :transcription_engine_config
+
+        # Text-to-speech provider. If omitted, Telnyx derives it from `voice` or
+        # `provider`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :tts_provider
+
+        sig { params(tts_provider: String).void }
+        attr_writer :tts_provider
+
+        # The voice to be used by the voice assistant. Currently we support ElevenLabs,
+        # Telnyx and AWS voices.
+        #
+        # **Supported Providers:**
+        #
+        # - **AWS:** Use `AWS.Polly.<VoiceId>` (e.g., `AWS.Polly.Joanna`). For neural
+        #   voices, which provide more realistic, human-like speech, append `-Neural` to
+        #   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).)
+        # - **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
+        #   under `"voice_settings": {"api_key_ref": "<secret_id>"}`. See
+        #   [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+        #   for details. Check
+        #   [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
+        # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
+        # - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
+        #   `Inworld.Max.Oliver`). Supported models: `Mini`, `Max`.
+        # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
+        #   `ara`, `rex`, `sal`, `leo`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :voice
+
+        sig { params(voice: String).void }
+        attr_writer :voice
+
+        # The settings associated with the voice selected
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                Telnyx::Calls::ElevenLabsVoiceSettings,
+                Telnyx::Calls::TelnyxVoiceSettings,
+                Telnyx::Calls::AwsVoiceSettings,
+                Telnyx::MinimaxVoiceSettings,
+                Telnyx::AzureVoiceSettings,
+                Telnyx::RimeVoiceSettings,
+                Telnyx::ResembleVoiceSettings,
+                Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld,
+                Telnyx::XaiVoiceSettings
+              )
+            )
+          )
+        end
+        attr_reader :voice_settings
+
+        sig do
+          params(
+            voice_settings:
+              T.any(
+                Telnyx::Calls::ElevenLabsVoiceSettings::OrHash,
+                Telnyx::Calls::TelnyxVoiceSettings::OrHash,
+                Telnyx::Calls::AwsVoiceSettings::OrHash,
+                Telnyx::MinimaxVoiceSettings::OrHash,
+                Telnyx::AzureVoiceSettings::OrHash,
+                Telnyx::RimeVoiceSettings::OrHash,
+                Telnyx::ResembleVoiceSettings::OrHash,
+                Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld::OrHash,
+                Telnyx::XaiVoiceSettings::OrHash
+              )
+          ).void
+        end
+        attr_writer :voice_settings
+
+        # Starts a Conversation Relay session automatically when the answered/dialed call
+        # is answered. This embedded shape is supported on `answer` and `dial`. It uses
+        # public field names (`url`, `dtmf_detection`, `greeting`, `voice`, `language`,
+        # etc.) and maps them to the underlying Conversation Relay action. `client_state`,
+        # `tts_language`, and `transcription_language` inside this object are ignored; use
+        # the parent command's `client_state` and `command_id` fields instead.
+        sig do
+          params(
+            url: String,
+            custom_parameters: T::Hash[Symbol, T.anything],
+            dtmf_detection: T::Boolean,
+            greeting: String,
+            interruptible:
+              Telnyx::CallDialParams::ConversationRelayConfig::Interruptible::OrSymbol,
+            interruptible_greeting:
+              Telnyx::CallDialParams::ConversationRelayConfig::InterruptibleGreeting::OrSymbol,
+            interruption_settings:
+              Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::OrHash,
+            language: String,
+            languages:
+              T::Array[
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::OrHash
+              ],
+            provider: String,
+            structured_provider: T::Hash[Symbol, T.anything],
+            transcription_engine:
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::OrSymbol,
+            transcription_engine_config: T::Hash[Symbol, T.anything],
+            tts_provider: String,
+            voice: String,
+            voice_settings:
+              T.any(
+                Telnyx::Calls::ElevenLabsVoiceSettings::OrHash,
+                Telnyx::Calls::TelnyxVoiceSettings::OrHash,
+                Telnyx::Calls::AwsVoiceSettings::OrHash,
+                Telnyx::MinimaxVoiceSettings::OrHash,
+                Telnyx::AzureVoiceSettings::OrHash,
+                Telnyx::RimeVoiceSettings::OrHash,
+                Telnyx::ResembleVoiceSettings::OrHash,
+                Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld::OrHash,
+                Telnyx::XaiVoiceSettings::OrHash
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # WebSocket URL for your Conversation Relay server. Must start with `ws://` or
+          # `wss://`.
+          url:,
+          # Custom key-value parameters forwarded to the relay session as assistant dynamic
+          # variables.
+          custom_parameters: nil,
+          # Enable DTMF detection for the relay session.
+          dtmf_detection: nil,
+          # Text played when the relay session starts.
+          greeting: nil,
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          interruptible: nil,
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          interruptible_greeting: nil,
+          # Settings for handling caller interruptions during Conversation Relay speech.
+          interruption_settings: nil,
+          # Default language for both text-to-speech and speech recognition.
+          language: nil,
+          # Per-language TTS and transcription settings.
+          languages: nil,
+          # Structured voice provider. Must be supplied together with `structured_provider`.
+          provider: nil,
+          # Provider-specific structured voice settings. Must be supplied together with
+          # `provider`; Telnyx sends the value as the nested provider configuration for
+          # Conversation Relay.
+          structured_provider: nil,
+          # Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+          # `Telnyx` are supported for backward compatibility. For Conversation Relay, use
+          # this field with `transcription_engine_config`; the `transcription` object is not
+          # supported.
+          transcription_engine: nil,
+          # Engine-specific transcription settings for Conversation Relay. This accepts the
+          # same provider-specific options used by the Call Transcription Start command,
+          # such as `transcription_model`, without requiring the engine discriminator to be
+          # repeated inside this object.
+          transcription_engine_config: nil,
+          # Text-to-speech provider. If omitted, Telnyx derives it from `voice` or
+          # `provider`.
+          tts_provider: nil,
+          # The voice to be used by the voice assistant. Currently we support ElevenLabs,
+          # Telnyx and AWS voices.
+          #
+          # **Supported Providers:**
+          #
+          # - **AWS:** Use `AWS.Polly.<VoiceId>` (e.g., `AWS.Polly.Joanna`). For neural
+          #   voices, which provide more realistic, human-like speech, append `-Neural` to
+          #   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).)
+          # - **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
+          #   under `"voice_settings": {"api_key_ref": "<secret_id>"}`. See
+          #   [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+          #   for details. Check
+          #   [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
+          # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
+          # - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
+          #   `Inworld.Max.Oliver`). Supported models: `Mini`, `Max`.
+          # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
+          #   `ara`, `rex`, `sal`, `leo`.
+          voice: nil,
+          # The settings associated with the voice selected
+          voice_settings: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              url: String,
+              custom_parameters: T::Hash[Symbol, T.anything],
+              dtmf_detection: T::Boolean,
+              greeting: String,
+              interruptible:
+                Telnyx::CallDialParams::ConversationRelayConfig::Interruptible::OrSymbol,
+              interruptible_greeting:
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptibleGreeting::OrSymbol,
+              interruption_settings:
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings,
+              language: String,
+              languages:
+                T::Array[
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language
+                ],
+              provider: String,
+              structured_provider: T::Hash[Symbol, T.anything],
+              transcription_engine:
+                Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::OrSymbol,
+              transcription_engine_config: T::Hash[Symbol, T.anything],
+              tts_provider: String,
+              voice: String,
+              voice_settings:
+                T.any(
+                  Telnyx::Calls::ElevenLabsVoiceSettings,
+                  Telnyx::Calls::TelnyxVoiceSettings,
+                  Telnyx::Calls::AwsVoiceSettings,
+                  Telnyx::MinimaxVoiceSettings,
+                  Telnyx::AzureVoiceSettings,
+                  Telnyx::RimeVoiceSettings,
+                  Telnyx::ResembleVoiceSettings,
+                  Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld,
+                  Telnyx::XaiVoiceSettings
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Controls when caller input can interrupt assistant speech. `any` allows speech
+        # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+        # only; `dtmf` allows DTMF only.
+        module Interruptible
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::CallDialParams::ConversationRelayConfig::Interruptible
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NONE =
+            T.let(
+              :none,
+              Telnyx::CallDialParams::ConversationRelayConfig::Interruptible::TaggedSymbol
+            )
+          ANY =
+            T.let(
+              :any,
+              Telnyx::CallDialParams::ConversationRelayConfig::Interruptible::TaggedSymbol
+            )
+          SPEECH =
+            T.let(
+              :speech,
+              Telnyx::CallDialParams::ConversationRelayConfig::Interruptible::TaggedSymbol
+            )
+          DTMF =
+            T.let(
+              :dtmf,
+              Telnyx::CallDialParams::ConversationRelayConfig::Interruptible::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallDialParams::ConversationRelayConfig::Interruptible::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Controls when caller input can interrupt assistant speech. `any` allows speech
+        # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+        # only; `dtmf` allows DTMF only.
+        module InterruptibleGreeting
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptibleGreeting
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NONE =
+            T.let(
+              :none,
+              Telnyx::CallDialParams::ConversationRelayConfig::InterruptibleGreeting::TaggedSymbol
+            )
+          ANY =
+            T.let(
+              :any,
+              Telnyx::CallDialParams::ConversationRelayConfig::InterruptibleGreeting::TaggedSymbol
+            )
+          SPEECH =
+            T.let(
+              :speech,
+              Telnyx::CallDialParams::ConversationRelayConfig::InterruptibleGreeting::TaggedSymbol
+            )
+          DTMF =
+            T.let(
+              :dtmf,
+              Telnyx::CallDialParams::ConversationRelayConfig::InterruptibleGreeting::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptibleGreeting::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class InterruptionSettings < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Legacy boolean form. `true` is equivalent to `interruptible=any`; `false` is
+          # equivalent to `interruptible=none`.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :enable
+
+          sig { params(enable: T::Boolean).void }
+          attr_writer :enable
+
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible::OrSymbol
+              )
+            )
+          end
+          attr_reader :interruptible
+
+          sig do
+            params(
+              interruptible:
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible::OrSymbol
+            ).void
+          end
+          attr_writer :interruptible
+
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting::OrSymbol
+              )
+            )
+          end
+          attr_reader :interruptible_greeting
+
+          sig do
+            params(
+              interruptible_greeting:
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting::OrSymbol
+            ).void
+          end
+          attr_writer :interruptible_greeting
+
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible::OrSymbol
+              )
+            )
+          end
+          attr_reader :welcome_greeting_interruptible
+
+          sig do
+            params(
+              welcome_greeting_interruptible:
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible::OrSymbol
+            ).void
+          end
+          attr_writer :welcome_greeting_interruptible
+
+          # Settings for handling caller interruptions during Conversation Relay speech.
+          sig do
+            params(
+              enable: T::Boolean,
+              interruptible:
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible::OrSymbol,
+              interruptible_greeting:
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting::OrSymbol,
+              welcome_greeting_interruptible:
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Legacy boolean form. `true` is equivalent to `interruptible=any`; `false` is
+            # equivalent to `interruptible=none`.
+            enable: nil,
+            # Controls when caller input can interrupt assistant speech. `any` allows speech
+            # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+            # only; `dtmf` allows DTMF only.
+            interruptible: nil,
+            # Controls when caller input can interrupt assistant speech. `any` allows speech
+            # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+            # only; `dtmf` allows DTMF only.
+            interruptible_greeting: nil,
+            # Controls when caller input can interrupt assistant speech. `any` allows speech
+            # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+            # only; `dtmf` allows DTMF only.
+            welcome_greeting_interruptible: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                enable: T::Boolean,
+                interruptible:
+                  Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible::OrSymbol,
+                interruptible_greeting:
+                  Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting::OrSymbol,
+                welcome_greeting_interruptible:
+                  Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          module Interruptible
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NONE =
+              T.let(
+                :none,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible::TaggedSymbol
+              )
+            ANY =
+              T.let(
+                :any,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible::TaggedSymbol
+              )
+            SPEECH =
+              T.let(
+                :speech,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible::TaggedSymbol
+              )
+            DTMF =
+              T.let(
+                :dtmf,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          module InterruptibleGreeting
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NONE =
+              T.let(
+                :none,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting::TaggedSymbol
+              )
+            ANY =
+              T.let(
+                :any,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting::TaggedSymbol
+              )
+            SPEECH =
+              T.let(
+                :speech,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting::TaggedSymbol
+              )
+            DTMF =
+              T.let(
+                :dtmf,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          module WelcomeGreetingInterruptible
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NONE =
+              T.let(
+                :none,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible::TaggedSymbol
+              )
+            ANY =
+              T.let(
+                :any,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible::TaggedSymbol
+              )
+            SPEECH =
+              T.let(
+                :speech,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible::TaggedSymbol
+              )
+            DTMF =
+              T.let(
+                :dtmf,
+                Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        class Language < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::CallDialParams::ConversationRelayConfig::Language,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # BCP 47 language tag for this language configuration.
+          sig { returns(String) }
+          attr_accessor :language
+
+          # Conversation Relay speech model. Prefer
+          # `transcription_engine_config.transcription_model` when configuring
+          # speech-to-text.
+          sig { returns(T.nilable(String)) }
+          attr_reader :speech_model
+
+          sig { params(speech_model: String).void }
+          attr_writer :speech_model
+
+          # Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+          # `Telnyx` are supported for backward compatibility. When provided in a
+          # Conversation Relay language entry, Telnyx derives `transcription_provider` and
+          # `speech_model` for that language.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::OrSymbol
+              )
+            )
+          end
+          attr_reader :transcription_engine
+
+          sig do
+            params(
+              transcription_engine:
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::OrSymbol
+            ).void
+          end
+          attr_writer :transcription_engine
+
+          # Engine-specific transcription settings for Conversation Relay. This accepts the
+          # same provider-specific options used by the Call Transcription Start command,
+          # such as `transcription_model`, without requiring the engine discriminator to be
+          # repeated inside this object.
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_reader :transcription_engine_config
+
+          sig do
+            params(
+              transcription_engine_config: T::Hash[Symbol, T.anything]
+            ).void
+          end
+          attr_writer :transcription_engine_config
+
+          # Conversation Relay transcription provider name. Prefer `transcription_engine`
+          # when configuring speech-to-text.
+          sig { returns(T.nilable(String)) }
+          attr_reader :transcription_provider
+
+          sig { params(transcription_provider: String).void }
+          attr_writer :transcription_provider
+
+          # Text-to-speech provider for this language. If omitted and `voice` is provided,
+          # Telnyx derives the provider from the voice identifier.
+          sig { returns(T.nilable(String)) }
+          attr_reader :tts_provider
+
+          sig { params(tts_provider: String).void }
+          attr_writer :tts_provider
+
+          # Voice identifier for this language.
+          sig { returns(T.nilable(String)) }
+          attr_reader :voice
+
+          sig { params(voice: String).void }
+          attr_writer :voice
+
+          # The settings associated with the voice selected
+          sig do
+            returns(
+              T.nilable(
+                T.any(
+                  Telnyx::Calls::ElevenLabsVoiceSettings,
+                  Telnyx::Calls::TelnyxVoiceSettings,
+                  Telnyx::Calls::AwsVoiceSettings,
+                  Telnyx::MinimaxVoiceSettings,
+                  Telnyx::AzureVoiceSettings,
+                  Telnyx::RimeVoiceSettings,
+                  Telnyx::ResembleVoiceSettings,
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld,
+                  Telnyx::XaiVoiceSettings
+                )
+              )
+            )
+          end
+          attr_reader :voice_settings
+
+          sig do
+            params(
+              voice_settings:
+                T.any(
+                  Telnyx::Calls::ElevenLabsVoiceSettings::OrHash,
+                  Telnyx::Calls::TelnyxVoiceSettings::OrHash,
+                  Telnyx::Calls::AwsVoiceSettings::OrHash,
+                  Telnyx::MinimaxVoiceSettings::OrHash,
+                  Telnyx::AzureVoiceSettings::OrHash,
+                  Telnyx::RimeVoiceSettings::OrHash,
+                  Telnyx::ResembleVoiceSettings::OrHash,
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld::OrHash,
+                  Telnyx::XaiVoiceSettings::OrHash
+                )
+            ).void
+          end
+          attr_writer :voice_settings
+
+          # Language-specific TTS and transcription settings for Conversation Relay.
+          sig do
+            params(
+              language: String,
+              speech_model: String,
+              transcription_engine:
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::OrSymbol,
+              transcription_engine_config: T::Hash[Symbol, T.anything],
+              transcription_provider: String,
+              tts_provider: String,
+              voice: String,
+              voice_settings:
+                T.any(
+                  Telnyx::Calls::ElevenLabsVoiceSettings::OrHash,
+                  Telnyx::Calls::TelnyxVoiceSettings::OrHash,
+                  Telnyx::Calls::AwsVoiceSettings::OrHash,
+                  Telnyx::MinimaxVoiceSettings::OrHash,
+                  Telnyx::AzureVoiceSettings::OrHash,
+                  Telnyx::RimeVoiceSettings::OrHash,
+                  Telnyx::ResembleVoiceSettings::OrHash,
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld::OrHash,
+                  Telnyx::XaiVoiceSettings::OrHash
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # BCP 47 language tag for this language configuration.
+            language:,
+            # Conversation Relay speech model. Prefer
+            # `transcription_engine_config.transcription_model` when configuring
+            # speech-to-text.
+            speech_model: nil,
+            # Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+            # `Telnyx` are supported for backward compatibility. When provided in a
+            # Conversation Relay language entry, Telnyx derives `transcription_provider` and
+            # `speech_model` for that language.
+            transcription_engine: nil,
+            # Engine-specific transcription settings for Conversation Relay. This accepts the
+            # same provider-specific options used by the Call Transcription Start command,
+            # such as `transcription_model`, without requiring the engine discriminator to be
+            # repeated inside this object.
+            transcription_engine_config: nil,
+            # Conversation Relay transcription provider name. Prefer `transcription_engine`
+            # when configuring speech-to-text.
+            transcription_provider: nil,
+            # Text-to-speech provider for this language. If omitted and `voice` is provided,
+            # Telnyx derives the provider from the voice identifier.
+            tts_provider: nil,
+            # Voice identifier for this language.
+            voice: nil,
+            # The settings associated with the voice selected
+            voice_settings: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                language: String,
+                speech_model: String,
+                transcription_engine:
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::OrSymbol,
+                transcription_engine_config: T::Hash[Symbol, T.anything],
+                transcription_provider: String,
+                tts_provider: String,
+                voice: String,
+                voice_settings:
+                  T.any(
+                    Telnyx::Calls::ElevenLabsVoiceSettings,
+                    Telnyx::Calls::TelnyxVoiceSettings,
+                    Telnyx::Calls::AwsVoiceSettings,
+                    Telnyx::MinimaxVoiceSettings,
+                    Telnyx::AzureVoiceSettings,
+                    Telnyx::RimeVoiceSettings,
+                    Telnyx::ResembleVoiceSettings,
+                    Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld,
+                    Telnyx::XaiVoiceSettings
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+          # `Telnyx` are supported for backward compatibility. When provided in a
+          # Conversation Relay language entry, Telnyx derives `transcription_provider` and
+          # `speech_model` for that language.
+          module TranscriptionEngine
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            GOOGLE =
+              T.let(
+                :Google,
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::TaggedSymbol
+              )
+            TELNYX =
+              T.let(
+                :Telnyx,
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::TaggedSymbol
+              )
+            DEEPGRAM =
+              T.let(
+                :Deepgram,
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::TaggedSymbol
+              )
+            AZURE =
+              T.let(
+                :Azure,
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::TaggedSymbol
+              )
+            X_AI =
+              T.let(
+                :xAI,
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::TaggedSymbol
+              )
+            ASSEMBLY_AI =
+              T.let(
+                :AssemblyAI,
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::TaggedSymbol
+              )
+            SPEECHMATICS =
+              T.let(
+                :Speechmatics,
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::TaggedSymbol
+              )
+            SONIOX =
+              T.let(
+                :Soniox,
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::TaggedSymbol
+              )
+            A =
+              T.let(
+                :A,
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::TaggedSymbol
+              )
+            B =
+              T.let(
+                :B,
+                Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The settings associated with the voice selected
+          module VoiceSettings
+            extend Telnyx::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  Telnyx::Calls::ElevenLabsVoiceSettings,
+                  Telnyx::Calls::TelnyxVoiceSettings,
+                  Telnyx::Calls::AwsVoiceSettings,
+                  Telnyx::MinimaxVoiceSettings,
+                  Telnyx::AzureVoiceSettings,
+                  Telnyx::RimeVoiceSettings,
+                  Telnyx::ResembleVoiceSettings,
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld,
+                  Telnyx::XaiVoiceSettings
+                )
+              end
+
+            class Inworld < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Voice settings provider type
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              sig { params(type: Symbol).returns(T.attached_class) }
+              def self.new(
+                # Voice settings provider type
+                type: :inworld
+              )
+              end
+
+              sig { override.returns({ type: Symbol }) }
+              def to_hash
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+        end
+
+        # Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+        # `Telnyx` are supported for backward compatibility. For Conversation Relay, use
+        # this field with `transcription_engine_config`; the `transcription` object is not
+        # supported.
+        module TranscriptionEngine
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          GOOGLE =
+            T.let(
+              :Google,
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::TaggedSymbol
+            )
+          TELNYX =
+            T.let(
+              :Telnyx,
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::TaggedSymbol
+            )
+          DEEPGRAM =
+            T.let(
+              :Deepgram,
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::TaggedSymbol
+            )
+          AZURE =
+            T.let(
+              :Azure,
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::TaggedSymbol
+            )
+          X_AI =
+            T.let(
+              :xAI,
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::TaggedSymbol
+            )
+          ASSEMBLY_AI =
+            T.let(
+              :AssemblyAI,
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::TaggedSymbol
+            )
+          SPEECHMATICS =
+            T.let(
+              :Speechmatics,
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::TaggedSymbol
+            )
+          SONIOX =
+            T.let(
+              :Soniox,
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::TaggedSymbol
+            )
+          A =
+            T.let(
+              :A,
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::TaggedSymbol
+            )
+          B =
+            T.let(
+              :B,
+              Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallDialParams::ConversationRelayConfig::TranscriptionEngine::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The settings associated with the voice selected
+        module VoiceSettings
+          extend Telnyx::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Telnyx::Calls::ElevenLabsVoiceSettings,
+                Telnyx::Calls::TelnyxVoiceSettings,
+                Telnyx::Calls::AwsVoiceSettings,
+                Telnyx::MinimaxVoiceSettings,
+                Telnyx::AzureVoiceSettings,
+                Telnyx::RimeVoiceSettings,
+                Telnyx::ResembleVoiceSettings,
+                Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld,
+                Telnyx::XaiVoiceSettings
+              )
+            end
+
+          class Inworld < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Voice settings provider type
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig { params(type: Symbol).returns(T.attached_class) }
+            def self.new(
+              # Voice settings provider type
+              type: :inworld
+            )
+            end
+
+            sig { override.returns({ type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+
       class DeepfakeDetection < Telnyx::Internal::Type::BaseModel
         OrHash =
           T.type_alias do