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

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/telnyx/models/calls/action_start_conversation_relay_params.rb

Defined Under Namespace

Modules: Interruptible, InterruptibleGreeting Classes: Language

Instance Attribute Summary

• #dtmf_detection ⇒ Boolean^?

  Whether to enable DTMF detection during the relay session.

• #interruptible ⇒ Symbol, ...

  Controls when caller input can interrupt assistant speech.

• #interruptible_greeting ⇒ Symbol, ...

  Controls when caller input can interrupt assistant speech.

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

  Language-specific TTS and transcription settings.

• #url ⇒ String

  WebSocket URL for your Conversation Relay server.

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.

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 Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings for more details.

Conversation Relay connection settings. This object is used by TeXML Call Scripting’s ‘<ConversationRelay>` verb. The `interruptible` and `interruptible_greeting` fields are shorthand for `interruption_settings.interruptible` and `interruption_settings.interruptible_greeting`; use top-level `interruption_settings` for the full interruption settings shape.

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::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible) (defaults to: nil) —

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

• interruptible_greeting (Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting) (defaults to: nil) —

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

• languages (Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language>) (defaults to: nil) —

  Language-specific TTS and transcription settings.

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

Instance Attribute Details

#dtmf_detection ⇒ Boolean^?

Whether to enable DTMF detection during the relay session.

Returns:

• (Boolean, nil)

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

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

#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::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible, nil)

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

optional :interruptible,
enum: -> { Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible }

#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::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting, nil)

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

optional :interruptible_greeting,
enum: -> { Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting }

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

Language-specific TTS and transcription settings.

Returns:

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

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

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

#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 205

required :url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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