Class: Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Target

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Target

Defined in:

lib/telnyx/models/ai/assistant_tool.rb

Instance Attribute Summary

• #name ⇒ String^?

  The name of the target.

• #to ⇒ String^?

  The destination number or SIP URI of the call.

Instance Method Summary

• #initialize(from:, targets:, custom_headers: nil, voicemail_detection: nil, warm_message_delay_ms: nil, warm_transfer_instructions: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Telnyx::Models::AI::AssistantTool::Transfer::Transfer 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(from:, targets:, custom_headers: nil, voicemail_detection: nil, warm_message_delay_ms: nil, warm_transfer_instructions: nil) ⇒ Object

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

Parameters:

• from (String) —

  Number or SIP URI placing the call.

• targets (Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Target>) —

  The different possible targets of the transfer. The assistant will be able to ch

• custom_headers (Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::CustomHeader>) (defaults to: nil) —

  Custom headers to be added to the SIP INVITE for the transfer command.

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

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

• warm_message_delay_ms (Integer, nil) (defaults to: nil) —

  Optional delay in milliseconds before playing the warm message audio when the tr

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

  Natural language instructions for your agent for how to provide context for the

# File 'lib/telnyx/models/ai/assistant_tool.rb', line 196

class Target < Telnyx::Internal::Type::BaseModel
  # @!attribute name
  #   The name of the target.
  #
  #   @return [String, nil]
  optional :name, String

  # @!attribute to
  #   The destination number or SIP URI of the call.
  #
  #   @return [String, nil]
  optional :to, String

  # @!method initialize(name: nil, to: nil)
  #   @param name [String] The name of the target.
  #
  #   @param to [String] The destination number or SIP URI of the call.
end

Instance Attribute Details

#name ⇒ String^?

The name of the target.

Returns:

• (String, nil)

# File 'lib/telnyx/models/ai/assistant_tool.rb', line 201

optional :name, String

#to ⇒ String^?

The destination number or SIP URI of the call.

Returns:

• (String, nil)

# File 'lib/telnyx/models/ai/assistant_tool.rb', line 207

optional :to, String