Class: Telnyx::Models::AI::TelephonySettings

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/telephony_settings.rb,
sig/telnyx/models/ai/telephony_settings.rbs

Defined Under Namespace

Modules: NoiseSuppression Classes: NoiseSuppressionConfig, RecordingSettings, VoicemailDetection

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(default_texml_app_id: nil, disable_dtmf: nil, noise_suppression: nil, noise_suppression_config: nil, recording_settings: nil, send_message_history_updates: nil, supports_unauthenticated_web_calls: nil, time_limit_secs: nil, user_idle_reply_secs: nil, user_idle_timeout_secs: nil, voicemail_detection: nil) ⇒ Object

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

Parameters:

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

    Default Texml App used for voice calls with your assistant. This will be created

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

    Disable inbound DTMF for the entire call. Must be set to true if a 'pay' tool is

  • noise_suppression (Symbol, Telnyx::Models::AI::TelephonySettings::NoiseSuppression) (defaults to: nil) —

    The noise suppression engine to use. Use 'disabled' to turn off noise suppressio

  • noise_suppression_config (Telnyx::Models::AI::TelephonySettings::NoiseSuppressionConfig) (defaults to: nil) —

    Configuration for noise suppression. Only applicable when noise_suppression is '

  • recording_settings (Telnyx::Models::AI::TelephonySettings::RecordingSettings) (defaults to: nil) —

    Configuration for call recording format and channel settings.

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

    Whether the assistant sends a call.ai_gather.message_history_updated webhook w

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

    When enabled, allows users to interact with your AI assistant directly from your

  • time_limit_secs (Integer) (defaults to: nil) —

    Maximum duration in seconds for the AI assistant to participate on the call. Whe

  • user_idle_reply_secs (Integer) (defaults to: nil) —

    Duration in seconds of end user silence before the assistant checks in on the us

  • user_idle_timeout_secs (Integer) (defaults to: nil) —

    Maximum duration in seconds of end user silence on the call. When this limit is

  • voicemail_detection (Telnyx::Models::AI::TelephonySettings::VoicemailDetection) (defaults to: nil) —

    Configuration for voicemail detection (AMD - Answering Machine Detection) on out




# File 'lib/telnyx/models/ai/telephony_settings.rb', line 100

Instance Attribute Details

#default_texml_app_id ⇒ String?

Default Texml App used for voice calls with your assistant. This will be created automatically on assistant creation.

Parameters:

  • (String)

Returns:

  • (String, nil) 


12
 
# File 'lib/telnyx/models/ai/telephony_settings.rb', line 12

optional :default_texml_app_id, String

#disable_dtmf ⇒ Boolean?

Disable inbound DTMF for the entire call. Must be set to true if a 'pay' tool is configured anywhere on the assistant — on the main tool array or on any workflow node — enforced at write time.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


20
 
# File 'lib/telnyx/models/ai/telephony_settings.rb', line 20

optional :disable_dtmf, Telnyx::Internal::Type::Boolean

#noise_suppression ⇒ Symbol, ...

The noise suppression engine to use. Use 'disabled' to turn off noise suppression.

Returns:



27
 
# File 'lib/telnyx/models/ai/telephony_settings.rb', line 27

optional :noise_suppression, enum: -> { Telnyx::AI::TelephonySettings::NoiseSuppression }

#noise_suppression_config ⇒ Telnyx::Models::AI::TelephonySettings::NoiseSuppressionConfig?

Configuration for noise suppression. Only applicable when noise_suppression is 'deepfilternet'.

Returns:



34
 
# File 'lib/telnyx/models/ai/telephony_settings.rb', line 34

optional :noise_suppression_config, -> { Telnyx::AI::TelephonySettings::NoiseSuppressionConfig }

#recording_settings ⇒ Telnyx::Models::AI::TelephonySettings::RecordingSettings?

Configuration for call recording format and channel settings.

Returns:



40
 
# File 'lib/telnyx/models/ai/telephony_settings.rb', line 40

optional :recording_settings, -> { Telnyx::AI::TelephonySettings::RecordingSettings }

#send_message_history_updates ⇒ Boolean?

Whether the assistant sends a call.ai_gather.message_history_updated webhook with the full message history every time the conversation history changes. Leave unset to inherit the send_message_history_updates value from the ai_assistant_start or gather_using_ai command that started the conversation. Setting it here is authoritative: true turns the webhooks on even when the start command did not request them, and false turns them off even when it did. Messages exchanged during a private warm transfer acceptance phase are never included.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


53
 
# File 'lib/telnyx/models/ai/telephony_settings.rb', line 53

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

#supports_unauthenticated_web_calls ⇒ Boolean?

When enabled, allows users to interact with your AI assistant directly from your website without requiring authentication. This is required for FE widgets that work with assistants that have telephony enabled.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


61
 
# File 'lib/telnyx/models/ai/telephony_settings.rb', line 61

optional :supports_unauthenticated_web_calls, Telnyx::Internal::Type::Boolean

#time_limit_secs ⇒ Integer?

Maximum duration in seconds for the AI assistant to participate on the call. When this limit is reached the assistant will be stopped. This limit does not apply to portions of a call without an active assistant (for instance, a call transferred to a human representative).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :time_limit_secs, Integer

#user_idle_reply_secs ⇒ Integer?

Duration in seconds of end user silence before the assistant checks in on the user. When this limit is reached the assistant will prompt the user to respond. This is distinct from user_idle_timeout_secs which stops the assistant entirely.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :user_idle_reply_secs, Integer

#user_idle_timeout_secs ⇒ Integer?

Maximum duration in seconds of end user silence on the call. When this limit is reached the assistant will be stopped. This limit does not apply to portions of a call without an active assistant (for instance, a call transferred to a human representative).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :user_idle_timeout_secs, Integer

#voicemail_detection ⇒ Telnyx::Models::AI::TelephonySettings::VoicemailDetection?

Configuration for voicemail detection (AMD - Answering Machine Detection) on outgoing calls. These settings only apply if AMD is enabled on the Dial command. See TeXML Dial documentation for enabling AMD. Recommended settings: MachineDetection=Enable, AsyncAmd=true, DetectionMode=Premium.

Returns:



98
 
# File 'lib/telnyx/models/ai/telephony_settings.rb', line 98

optional :voicemail_detection, -> { Telnyx::AI::TelephonySettings::VoicemailDetection }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/ai/telephony_settings.rb', line 137

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


86
 
# File 'sig/telnyx/models/ai/telephony_settings.rbs', line 86

def to_hash: -> {