Class: Telnyx::Models::Calls::ActionStartConversationRelayParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Calls::ActionStartConversationRelayParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/calls/action_start_conversation_relay_params.rb,
sig/telnyx/models/calls/action_start_conversation_relay_params.rbs

Overview

See Also:

• Telnyx::Resources::Calls::Actions#start_conversation_relay

Defined Under Namespace

Modules: TranscriptionEngine, VoiceSettings Classes: Assistant, ConversationRelaySettings

Constant Summary

Telnyx =

Returns:

• (:ConversationRelayInterruptionSettings)

Instance Attribute Summary

• #assistant ⇒ Telnyx::Models::Calls::ActionStartConversationRelayParams::Assistant^?

  Custom parameters for the Conversation Relay session.

• #call_control_id ⇒ String
• #client_state ⇒ String^?

  Use this field to add state to subsequent webhooks.

• #command_id ⇒ String^?

  Use this field to avoid duplicate commands.

• #conversation_relay_dtmf_detection ⇒ Boolean^?

  Enable DTMF detection for the relay session.

• #conversation_relay_settings ⇒ Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings^?

  Conversation Relay connection settings.

• #conversation_relay_url ⇒ String^?

  WebSocket URL for your Conversation Relay server.

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

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

• #dtmf_detection ⇒ Boolean^?

  Public alias for conversation_relay_dtmf_detection.

• #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 the relay session.

• #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 ⇒ Hash{Symbol=>Object}^? deprecated Deprecated.
• #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^?

  Public alias for conversation_relay_url.

• #voice ⇒ String^?

  The voice to be used by the voice assistant.

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

  The settings associated with the voice selected.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(url:, dtmf_detection: nil, interruptible: nil, interruptible_greeting: nil, languages: nil) ⇒ Object constructor

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

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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:, dtmf_detection: nil, interruptible: nil, interruptible_greeting: nil, languages: nil) ⇒ Object

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

Conversation Relay connection settings. This object can provide url, dtmf_detection, interruptible, interruptible_greeting, and languages. Top-level aliases override nested values when both are present.

Parameters:

• url (String) —

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

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

  Whether to enable DTMF detection during the relay session.

• 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

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

  Language-specific TTS and transcription settings.

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 277

Instance Attribute Details

#assistant ⇒ Telnyx::Models::Calls::ActionStartConversationRelayParams::Assistant^?

Custom parameters for the Conversation Relay session. Pass key-value data as assistant.dynamic_variables to make it available to the relay session.

Returns:

• (Telnyx::Models::Calls::ActionStartConversationRelayParams::Assistant, nil)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 21

optional :assistant, -> { Telnyx::Calls::ActionStartConversationRelayParams::Assistant }

#call_control_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 14

required :call_control_id, String

#client_state ⇒ String^?

Use this field to add state to subsequent webhooks. It must be a valid Base-64 encoded string.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 28

optional :client_state, String

#command_id ⇒ String^?

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 35

optional :command_id, String

#conversation_relay_dtmf_detection ⇒ Boolean^?

Enable DTMF detection for the relay session.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 41

optional :conversation_relay_dtmf_detection, Telnyx::Internal::Type::Boolean

#conversation_relay_settings ⇒ Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings^?

Conversation Relay connection settings. This object can provide url, dtmf_detection, interruptible, interruptible_greeting, and languages. Top-level aliases override nested values when both are present.

Returns:

• (Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings, nil)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 49

optional :conversation_relay_settings,
-> { Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings }

#conversation_relay_url ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 57

optional :conversation_relay_url, String

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

Custom key-value parameters forwarded to the relay session as assistant.dynamic_variables. If assistant.dynamic_variables is also present, these values are merged in.

Parameters:

• (::Hash[Symbol, top])

Returns:

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

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 65

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

#dtmf_detection ⇒ Boolean^?

Public alias for conversation_relay_dtmf_detection. If both are present, this value wins.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 72

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/calls/action_start_conversation_relay_params.rb', line 78

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/calls/action_start_conversation_relay_params.rb', line 86

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/calls/action_start_conversation_relay_params.rb', line 94

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/calls/action_start_conversation_relay_params.rb', line 100

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

#language ⇒ String^?

Default language for the relay session. This value is used for both text-to-speech and speech recognition.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 107

optional :language, String

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

Per-language TTS and transcription settings.

Returns:

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

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 113

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/calls/action_start_conversation_relay_params.rb', line 119

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/calls/action_start_conversation_relay_params.rb', line 127

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

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

Deprecated.

Not supported for Conversation Relay start requests. Use transcription_engine and transcription_engine_config instead.

Parameters:

• (::Hash[Symbol, top])

Returns:

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

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 136

optional :transcription, 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::Calls::ActionStartConversationRelayParams::TranscriptionEngine, nil)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 145

optional :transcription_engine,
enum: -> { Telnyx::Calls::ActionStartConversationRelayParams::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/calls/action_start_conversation_relay_params.rb', line 155

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/calls/action_start_conversation_relay_params.rb', line 162

optional :tts_provider, String

#url ⇒ String^?

Public alias for conversation_relay_url. Must start with ws:// or wss://. If both are present, this value wins.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 169

optional :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/calls/action_start_conversation_relay_params.rb', line 208

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/calls/action_start_conversation_relay_params.rb', line 214

optional :voice_settings, union: -> { Telnyx::Calls::ActionStartConversationRelayParams::VoiceSettings }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 358

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/calls/action_start_conversation_relay_params.rbs', line 177

def to_hash: -> {