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

Overview

See Also:

• Resources::Calls::Actions#start_conversation_relay

Defined Under Namespace

Modules: VoiceSettings Classes: Assistant, InterruptionSettings, Language, Participant, Transcription

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_url ⇒ String

  WebSocket URL for your Conversation Relay server.

• #greeting ⇒ String^?

  Text played when the relay session starts.

• #interruption_settings ⇒ Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings^?

  Settings for handling caller interruptions during Conversation Relay speech.

• #language ⇒ String^?

  Default language for the relay session.

• #languages ⇒ Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Language>^?

  Language-specific TTS and transcription settings.

• #participants ⇒ Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant>^?

  Participants to add to the conversation.

• #send_message_history_updates ⇒ Boolean^?

  When true, sends message history update webhooks.

• #transcription ⇒ Telnyx::Models::Calls::ActionStartConversationRelayParams::Transcription^?

  Speech-to-text settings for Conversation Relay.

• #transcription_language ⇒ String^?

  Language to use for speech recognition.

• #tts_language ⇒ String^?

  Language to use for text-to-speech.

• #user_response_timeout_ms ⇒ Integer^?

  Time in milliseconds to wait for caller input before timing out.

• #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(language: nil, model: nil, provider: nil) ⇒ Object constructor

  Speech-to-text settings for Conversation Relay.

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(language: nil, model: nil, provider: nil) ⇒ Object

Speech-to-text settings for Conversation Relay.

Parameters:

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

  Transcription language.

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

  Transcription model to use.

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

  Transcription provider to use.

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

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 28

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

#call_control_id ⇒ 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.

Returns:

• (String, nil)

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

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`.

Returns:

• (String, nil)

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

optional :command_id, String

#conversation_relay_dtmf_detection ⇒ Boolean^?

Enable DTMF detection for the relay session.

Returns:

• (Boolean, nil)

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

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

#conversation_relay_url ⇒ String

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

Returns:

• (String)

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

required :conversation_relay_url, String

#greeting ⇒ String^?

Text played when the relay session starts.

Returns:

• (String, nil)

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

optional :greeting, String

#interruption_settings ⇒ Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings^?

Settings for handling caller interruptions during Conversation Relay speech.

Returns:

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

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

optional :interruption_settings,
-> { Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings }

#language ⇒ String^?

Default language for the relay session. This value is used for both text-to-speech and speech recognition unless ‘tts_language` or `transcription_language` are provided.

Returns:

• (String, nil)

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

optional :language, String

#languages ⇒ Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Language>^?

Language-specific TTS and transcription settings. Use this when the relay session needs per-language provider, voice, or speech model configuration.

Returns:

• (Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Language>, nil)

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

optional :languages,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::ActionStartConversationRelayParams::Language] }

#participants ⇒ Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant>^?

Participants to add to the conversation.

Returns:

• (Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant>, nil)

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

optional :participants,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::ActionStartConversationRelayParams::Participant] }

#send_message_history_updates ⇒ Boolean^?

When true, sends message history update webhooks.

Returns:

• (Boolean, nil)

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

optional :send_message_history_updates, Telnyx::Internal::Type::Boolean

#transcription ⇒ Telnyx::Models::Calls::ActionStartConversationRelayParams::Transcription^?

Speech-to-text settings for Conversation Relay.

Returns:

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

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

optional :transcription, -> { Telnyx::Calls::ActionStartConversationRelayParams::Transcription }

#transcription_language ⇒ String^?

Language to use for speech recognition. Overrides ‘language` for transcription when provided.

Returns:

• (String, nil)

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

optional :transcription_language, String

#tts_language ⇒ String^?

Language to use for text-to-speech. Overrides ‘language` for TTS when provided.

Returns:

• (String, nil)

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

optional :tts_language, String

#user_response_timeout_ms ⇒ Integer^?

Time in milliseconds to wait for caller input before timing out.

Returns:

• (Integer, nil)

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

optional :user_response_timeout_ms, Integer

#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](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](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”: “<secret_id>”`. See [integration secrets documentation](developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) for details. Check [available voices](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`.

Returns:

• (String, nil)

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

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::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionStartConversationRelayParams::VoiceSettings::Xai, nil)

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

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 307