Class: Telnyx::Models::ConversationRelayEmbeddedConfig

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::ConversationRelayEmbeddedConfig

Defined in:

lib/telnyx/models/conversation_relay_embedded_config.rb,
sig/telnyx/models/conversation_relay_embedded_config.rbs

Defined Under Namespace

Modules: TranscriptionEngine, VoiceSettings

Constant Summary

Telnyx =

Returns:

• (:ConversationRelayInterruptionSettings)

Instance Attribute Summary

• #custom_parameters ⇒ Hash{Symbol=>Object}^?

  Custom key-value parameters forwarded to the relay session as assistant dynamic variables.

• #dtmf_detection ⇒ Boolean^?

  Enable DTMF detection for the relay session.

• #greeting ⇒ String^?

  Text played when the relay session starts.

• #interruptible ⇒ Symbol, ...

  Controls when caller input can interrupt assistant speech.

• #interruptible_greeting ⇒ Symbol, ...

  Controls when caller input can interrupt assistant speech.

• #interruption_settings ⇒ Telnyx::Models::ConversationRelayInterruptionSettings^?

  Settings for handling caller interruptions during Conversation Relay speech.

• #language ⇒ String^?

  Default language for both text-to-speech and speech recognition.

• #languages ⇒ Array<Telnyx::Models::ConversationRelayLanguage>^?

  Per-language TTS and transcription settings.

• #provider ⇒ String^?

  Structured voice provider.

• #structured_provider ⇒ Hash{Symbol=>Object}^?

  Provider-specific structured voice settings.

• #transcription_engine ⇒ Symbol, ...

  Engine to use for speech recognition.

• #transcription_engine_config ⇒ Hash{Symbol=>Object}^?

  Engine-specific transcription settings for Conversation Relay.

• #tts_provider ⇒ String^?

  Text-to-speech provider.

• #url ⇒ String

  WebSocket URL for your Conversation Relay server.

• #voice ⇒ String^?

  The voice to be used by the voice assistant.

• #voice_settings ⇒ Telnyx::Models::Calls::ElevenLabsVoiceSettings, ...

  The settings associated with the voice selected.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(url:, custom_parameters: nil, dtmf_detection: nil, greeting: nil, interruptible: nil, interruptible_greeting: nil, interruption_settings: nil, language: nil, languages: nil, provider: nil, structured_provider: nil, transcription_engine: nil, transcription_engine_config: nil, tts_provider: nil, voice: nil, voice_settings: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see ConversationRelayEmbeddedConfig for more details.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(url:, custom_parameters: nil, dtmf_detection: nil, greeting: nil, interruptible: nil, interruptible_greeting: nil, interruption_settings: nil, language: nil, languages: nil, provider: nil, structured_provider: nil, transcription_engine: nil, transcription_engine_config: nil, tts_provider: nil, voice: nil, voice_settings: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::ConversationRelayEmbeddedConfig for more details.

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.

Parameters:

• url (String) —

  WebSocket URL for your Conversation Relay server. Must start with ws:// or `ws

• custom_parameters (Hash{Symbol=>Object}) (defaults to: nil) —

  Custom key-value parameters forwarded to the relay session as assistant dynamic

• dtmf_detection (Boolean) (defaults to: nil) —

  Enable DTMF detection for the relay session.

• greeting (String) (defaults to: nil) —

  Text played when the relay session starts.

• interruptible (Symbol, Telnyx::Models::Calls::ConversationRelayInterruptible) (defaults to: nil) —

  Controls when caller input can interrupt assistant speech. any allows speech o

• interruptible_greeting (Symbol, Telnyx::Models::Calls::ConversationRelayInterruptible) (defaults to: nil) —

  Controls when caller input can interrupt assistant speech. any allows speech o

• interruption_settings (Telnyx::Models::ConversationRelayInterruptionSettings) (defaults to: nil) —

  Settings for handling caller interruptions during Conversation Relay speech.

• language (String) (defaults to: nil) —

  Default language for both text-to-speech and speech recognition.

• languages (Array<Telnyx::Models::ConversationRelayLanguage>) (defaults to: nil) —

  Per-language TTS and transcription settings.

• provider (String) (defaults to: nil) —

  Structured voice provider. Must be supplied together with structured_provider.

• structured_provider (Hash{Symbol=>Object}) (defaults to: nil) —

  Provider-specific structured voice settings. Must be supplied together with `pro

• transcription_engine (Symbol, Telnyx::Models::ConversationRelayEmbeddedConfig::TranscriptionEngine) (defaults to: nil) —

  Engine to use for speech recognition. Legacy values A - Google, B - `Telny

• transcription_engine_config (Hash{Symbol=>Object}) (defaults to: nil) —

  Engine-specific transcription settings for Conversation Relay. This accepts the

• tts_provider (String) (defaults to: nil) —

  Text-to-speech provider. If omitted, Telnyx derives it from voice or `provider

• voice (String) (defaults to: nil) —

  The voice to be used by the voice assistant. Currently we support ElevenLabs, Te

• voice_settings (Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings) (defaults to: nil) —

  The settings associated with the voice selected

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 150

Instance Attribute Details

#custom_parameters ⇒ Hash{Symbol=>Object}^?

Custom key-value parameters forwarded to the relay session as assistant dynamic variables.

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 18

optional :custom_parameters, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#dtmf_detection ⇒ Boolean^?

Enable DTMF detection for the relay session.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 24

optional :dtmf_detection, Telnyx::Internal::Type::Boolean

#greeting ⇒ String^?

Text played when the relay session starts.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 30

optional :greeting, String

#interruptible ⇒ Symbol, ...

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.

Returns:

• (Symbol, Telnyx::Models::Calls::ConversationRelayInterruptible, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 38

optional :interruptible, enum: -> { Telnyx::Calls::ConversationRelayInterruptible }

#interruptible_greeting ⇒ Symbol, ...

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.

Returns:

• (Symbol, Telnyx::Models::Calls::ConversationRelayInterruptible, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 46

optional :interruptible_greeting, enum: -> { Telnyx::Calls::ConversationRelayInterruptible }

#interruption_settings ⇒ Telnyx::Models::ConversationRelayInterruptionSettings^?

Settings for handling caller interruptions during Conversation Relay speech.

Returns:

• (Telnyx::Models::ConversationRelayInterruptionSettings, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 52

optional :interruption_settings, -> { Telnyx::ConversationRelayInterruptionSettings }

#language ⇒ String^?

Default language for both text-to-speech and speech recognition.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 58

optional :language, String

#languages ⇒ Array<Telnyx::Models::ConversationRelayLanguage>^?

Per-language TTS and transcription settings.

Returns:

• (Array<Telnyx::Models::ConversationRelayLanguage>, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 64

optional :languages, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::ConversationRelayLanguage] }

#provider ⇒ String^?

Structured voice provider. Must be supplied together with structured_provider.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 70

optional :provider, String

#structured_provider ⇒ Hash{Symbol=>Object}^?

Provider-specific structured voice settings. Must be supplied together with provider; Telnyx sends the value as the nested provider configuration for Conversation Relay.

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 78

optional :structured_provider, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#transcription_engine ⇒ Symbol, ...

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.

Returns:

• (Symbol, Telnyx::Models::ConversationRelayEmbeddedConfig::TranscriptionEngine, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 87

optional :transcription_engine, enum: -> { Telnyx::ConversationRelayEmbeddedConfig::TranscriptionEngine }

#transcription_engine_config ⇒ Hash{Symbol=>Object}^?

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.

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 96

optional :transcription_engine_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#tts_provider ⇒ String^?

Text-to-speech provider. If omitted, Telnyx derives it from voice or provider.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 103

optional :tts_provider, String

#url ⇒ String

WebSocket URL for your Conversation Relay server. Must start with ws:// or wss://.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 11

required :url, String

#voice ⇒ String^?

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 for compatibility.
• Azure: Use `Azure.. (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.)
• 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 for details. Check available voices.
• Telnyx: Use Telnyx.<model_id>.<voice_id>
• Inworld: Use Inworld.<ModelId>.<VoiceId> (e.g., Inworld.Mini.Loretta, Inworld.Max.Oliver, Inworld.TTS2.Loretta). Supported models: Mini, Max, TTS2.
• 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.
• 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: sara-en, abdulaziz-en, sara-ar, abdulaziz-ar, nourah-ar, abdullah-ar. Native Arabic (Saudi dialect) and English voices only — no ModelId segment.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 142

optional :voice, String

#voice_settings ⇒ Telnyx::Models::Calls::ElevenLabsVoiceSettings, ...

The settings associated with the voice selected

Returns:

• (Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, nil)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 148

optional :voice_settings, union: -> { Telnyx::ConversationRelayEmbeddedConfig::VoiceSettings }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/conversation_relay_embedded_config.rb', line 213

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/conversation_relay_embedded_config.rbs', line 119

def to_hash: -> {