Class: Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/revox/models/phone_number_list_response.rb,
sig/revox/models/phone_number_list_response.rbs

Overview

See Also:

  • Revox::Models::PhoneNumberListResponse::PhoneNumber#inbound_assistant

Defined Under Namespace

Modules: AfterCallSMSOutcome, BackgroundSound, EmailNotificationOutcome, FirstSentenceMode, HumanTransferMode, LlmModel, SttModel, ThinkingSound, Type Classes: Calendly, CallRetryConfig, CreatedBy, CustomTool, FaqItem, Position, PromptFlow, Slack, StructuredOutputConfig, SttContext, TransferDestination, Voice, Zoho

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(id:, email:, first_name:, last_name:) ⇒ Object

The user who created the assistant.

Parameters:

  • id (String) —

    The database user id of the creator.

  • email (String)
  • first_name (String, nil)
  • last_name (String, nil) 



# File 'lib/revox/models/phone_number_list_response.rb', line 648

Instance Attribute Details

#after_call_sms_outcomes ⇒ Array<Symbol, Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::AfterCallSMSOutcome>?

Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use "none" when outcome is null.

Parameters:

  • value (::Array[Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::after_call_sms_outcome], nil)

Returns:



145
146
147
 
# File 'lib/revox/models/phone_number_list_response.rb', line 145

required :after_call_sms_outcomes,
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::AfterCallSMSOutcome] },
nil?: true

#after_call_sms_prompt ⇒ String?

Prompt / instructions for the after-call SMS. Supports {variable} placeholders. When null, no after-call SMS is sent.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


154
 
# File 'lib/revox/models/phone_number_list_response.rb', line 154

required :after_call_sms_prompt, String, nil?: true

#background_sound ⇒ Symbol, ...

Ambient background sound to play during the call. null disables it.

Parameters:

  • value (Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::background_sound, nil)

Returns:



160
161
162
 
# File 'lib/revox/models/phone_number_list_response.rb', line 160

required :background_sound,
enum: -> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::BackgroundSound },
nil?: true

#background_sound_volume ⇒ Float

Volume of the ambient background sound (0 = silent, 1 = max).

Parameters:

  • value (Float)

Returns:

  • (Float) 


168
 
# File 'lib/revox/models/phone_number_list_response.rb', line 168

required :background_sound_volume, Float

#calendly ⇒ Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Calendly?

Parameters:

Returns:



173
174
175
 
# File 'lib/revox/models/phone_number_list_response.rb', line 173

required :calendly,
-> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Calendly },
nil?: true

#call_retry_config ⇒ Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::CallRetryConfig?

Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

Parameters:

Returns:



182
183
184
 
# File 'lib/revox/models/phone_number_list_response.rb', line 182

required :call_retry_config,
-> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::CallRetryConfig },
nil?: true

#cartesia_dictionary_pronunciation_id ⇒ String?

Optional Cartesia pronunciation dictionary ID linked to this assistant.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


190
 
# File 'lib/revox/models/phone_number_list_response.rb', line 190

required :cartesia_dictionary_pronunciation_id, String, nil?: true

#created_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


195
 
# File 'lib/revox/models/phone_number_list_response.rb', line 195

required :created_at, Revox::Internal::Type::Unknown

#created_by ⇒ Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::CreatedBy?

The user who created the assistant.

Parameters:

Returns:



472
473
474
 
# File 'lib/revox/models/phone_number_list_response.rb', line 472

optional :created_by,
-> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::CreatedBy },
nil?: true

#custom_tools ⇒ Array<Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::CustomTool>?

Parameters:

Returns:



200
201
202
 
# File 'lib/revox/models/phone_number_list_response.rb', line 200

required :custom_tools,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::CustomTool] },
nil?: true

#email_notification_address ⇒ String?

Email address(es) to receive notifications when a call ends with a matching outcome. Accepts a single email or a comma-separated list (e.g. "alice@x.com, bob@y.com").

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


210
 
# File 'lib/revox/models/phone_number_list_response.rb', line 210

required :email_notification_address, String, nil?: true

#email_notification_outcomes ⇒ Array<Symbol, Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::EmailNotificationOutcome>?

Which call outcomes trigger an email notification. E.g. ["interested", "completed", "none"]. Use "none" when outcome is null.

Parameters:

  • value (::Array[Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::email_notification_outcome], nil)

Returns:



217
218
219
 
# File 'lib/revox/models/phone_number_list_response.rb', line 217

required :email_notification_outcomes,
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::EmailNotificationOutcome] },
nil?: true

#end_of_call_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


224
 
# File 'lib/revox/models/phone_number_list_response.rb', line 224

required :end_of_call_sentence, String, nil?: true

#faq_items ⇒ Array<Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::FaqItem>?

Returns:



479
480
 
# File 'lib/revox/models/phone_number_list_response.rb', line 479

optional :faq_items,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::FaqItem] }

#first_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


229
 
# File 'lib/revox/models/phone_number_list_response.rb', line 229

required :first_sentence, String, nil?: true

#first_sentence_delay_ms ⇒ Integer

Delay in milliseconds before speaking the first sentence. Default: 400.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


235
 
# File 'lib/revox/models/phone_number_list_response.rb', line 235

required :first_sentence_delay_ms, Integer

#first_sentence_mode ⇒ Symbol, Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::FirstSentenceMode

Parameters:

  • value (Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::first_sentence_mode)

Returns:



240
241
 
# File 'lib/revox/models/phone_number_list_response.rb', line 240

required :first_sentence_mode,
enum: -> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::FirstSentenceMode }

#from_phone_number ⇒ String?

Override the default outbound phone number for calls placed with this assistant. When null, the organization's default phone number is used.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


248
 
# File 'lib/revox/models/phone_number_list_response.rb', line 248

required :from_phone_number, String, nil?: true

#human_transfer_mode ⇒ Symbol, ...

Warm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.

Parameters:

  • value (Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::human_transfer_mode, nil)

Returns:



255
256
257
 
# File 'lib/revox/models/phone_number_list_response.rb', line 255

required :human_transfer_mode,
enum: -> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::HumanTransferMode },
nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


138
 
# File 'lib/revox/models/phone_number_list_response.rb', line 138

required :id, String

#is_inbound_receptionist ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


485
 
# File 'lib/revox/models/phone_number_list_response.rb', line 485

optional :is_inbound_receptionist, Revox::Internal::Type::Boolean

#is_realestate_assistant ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


490
 
# File 'lib/revox/models/phone_number_list_response.rb', line 490

optional :is_realestate_assistant, Revox::Internal::Type::Boolean

#ivr_navigation_enabled ⇒ Boolean

Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


264
 
# File 'lib/revox/models/phone_number_list_response.rb', line 264

required :ivr_navigation_enabled, Revox::Internal::Type::Boolean

#llm_model ⇒ Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::LlmModel::UnionMember0, ...

Parameters:

  • value (Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::llm_model)

Returns:



269
270
 
# File 'lib/revox/models/phone_number_list_response.rb', line 269

required :llm_model,
union: -> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::LlmModel }

#logo_url ⇒ String?

Public URL of the brand logo shown on the assistant's demo page. Null when unset.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


277
 
# File 'lib/revox/models/phone_number_list_response.rb', line 277

required :logo_url, String, nil?: true

#max_call_duration_secs ⇒ Float

The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.

Parameters:

  • value (Float)

Returns:

  • (Float) 


284
 
# File 'lib/revox/models/phone_number_list_response.rb', line 284

required :max_call_duration_secs, Float

#max_duration_end_message ⇒ String?

Optional message the agent will say, without being interruptible, when the call reaches its max duration. Kept short so it fits inside the farewell buffer. If null, the call ends silently.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


292
 
# File 'lib/revox/models/phone_number_list_response.rb', line 292

required :max_duration_end_message, String, nil?: true

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


297
 
# File 'lib/revox/models/phone_number_list_response.rb', line 297

required :name, String

#organization_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


302
 
# File 'lib/revox/models/phone_number_list_response.rb', line 302

required :organization_id, String

#pending_faq_count ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


495
 
# File 'lib/revox/models/phone_number_list_response.rb', line 495

optional :pending_faq_count, Float

#position ⇒ Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Position?

Parameters:

Returns:



307
308
309
 
# File 'lib/revox/models/phone_number_list_response.rb', line 307

required :position,
-> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Position },
nil?: true

#precall_lookup_url ⇒ String?

URL fetched before an inbound call is answered to resolve the assistant's prompt variables. Null when no lookup is configured.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


316
 
# File 'lib/revox/models/phone_number_list_response.rb', line 316

required :precall_lookup_url, String, nil?: true

#prompt ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


321
 
# File 'lib/revox/models/phone_number_list_response.rb', line 321

required :prompt, String

#prompt_flow ⇒ Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::PromptFlow?

Parameters:

Returns:



326
327
328
 
# File 'lib/revox/models/phone_number_list_response.rb', line 326

required :prompt_flow,
-> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::PromptFlow },
nil?: true

#slack ⇒ Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Slack?

Parameters:

Returns:



333
334
335
 
# File 'lib/revox/models/phone_number_list_response.rb', line 333

required :slack,
-> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Slack },
nil?: true

#sms_enabled ⇒ Boolean

Enable SMS tool during calls. When enabled, the agent can send SMS messages to the user on the call.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


342
 
# File 'lib/revox/models/phone_number_list_response.rb', line 342

required :sms_enabled, Revox::Internal::Type::Boolean

#sms_template ⇒ String?

Hardcoded SMS template to send during calls. When set, this exact text is sent instead of letting the agent generate the message. Supports {variable} placeholders.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


350
 
# File 'lib/revox/models/phone_number_list_response.rb', line 350

required :sms_template, String, nil?: true

#structured_output_config ⇒ Array<Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::StructuredOutputConfig>?

The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).

Parameters:

Returns:



357
358
359
 
# File 'lib/revox/models/phone_number_list_response.rb', line 357

required :structured_output_config,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::StructuredOutputConfig] },
nil?: true

#structured_output_prompt ⇒ String?

Custom prompt for structured data extraction. If not provided, a default prompt is used. Available variables: {transcript}, {call_direction}, {user_phone_number}, {agent_phone_number}.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


367
 
# File 'lib/revox/models/phone_number_list_response.rb', line 367

required :structured_output_prompt, String, nil?: true

#stt_context ⇒ Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::SttContext?

Assistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.

Parameters:

Returns:



375
376
377
 
# File 'lib/revox/models/phone_number_list_response.rb', line 375

required :stt_context,
-> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::SttContext },
nil?: true

#stt_model ⇒ Symbol, Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::SttModel

Transcriber (speech-to-text) model used for the assistant.

Parameters:

  • value (Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::stt_model)

Returns:



383
384
 
# File 'lib/revox/models/phone_number_list_response.rb', line 383

required :stt_model,
enum: -> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::SttModel }

#thinking_sound ⇒ Symbol, ...

Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.

Parameters:

  • value (Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::thinking_sound, nil)

Returns:



391
392
393
 
# File 'lib/revox/models/phone_number_list_response.rb', line 391

required :thinking_sound,
enum: -> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::ThinkingSound },
nil?: true

#thinking_sound_probability ⇒ Float

Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.

Parameters:

  • value (Float)

Returns:

  • (Float) 


400
 
# File 'lib/revox/models/phone_number_list_response.rb', line 400

required :thinking_sound_probability, Float

#thinking_sound_volume ⇒ Float

Volume of the thinking sound (0 = silent, 1 = max).

Parameters:

  • value (Float)

Returns:

  • (Float) 


406
 
# File 'lib/revox/models/phone_number_list_response.rb', line 406

required :thinking_sound_volume, Float

#transfer_destinations ⇒ Array<Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::TransferDestination>?

Where calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.

Parameters:

Returns:



413
414
415
 
# File 'lib/revox/models/phone_number_list_response.rb', line 413

required :transfer_destinations,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::TransferDestination] },
nil?: true

#type ⇒ Symbol, Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Type

Parameters:

  • value (Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::type_)

Returns:



420
 
# File 'lib/revox/models/phone_number_list_response.rb', line 420

required :type, enum: -> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Type }

#updated_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


425
 
# File 'lib/revox/models/phone_number_list_response.rb', line 425

required :updated_at, Revox::Internal::Type::Unknown

#voice ⇒ Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Voice?

Parameters:

Returns:



430
431
432
 
# File 'lib/revox/models/phone_number_list_response.rb', line 430

required :voice,
-> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Voice },
nil?: true

#voicemail_message ⇒ String?

If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


439
 
# File 'lib/revox/models/phone_number_list_response.rb', line 439

required :voicemail_message, String, nil?: true

#voicemail_sms_prompt ⇒ String?

Prompt / instructions for the voicemail SMS. Supports {variable} placeholders. When null, no SMS is sent on voicemail.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


446
 
# File 'lib/revox/models/phone_number_list_response.rb', line 446

required :voicemail_sms_prompt, String, nil?: true

#warm_transfer_summary_instructions ⇒ String?

Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


453
 
# File 'lib/revox/models/phone_number_list_response.rb', line 453

required :warm_transfer_summary_instructions, String, nil?: true

#webhook_url ⇒ String?

The webhook URL to call when the call is completed.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


459
 
# File 'lib/revox/models/phone_number_list_response.rb', line 459

required :webhook_url, String, nil?: true

#zoho ⇒ Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Zoho?

Parameters:

Returns:



464
465
466
 
# File 'lib/revox/models/phone_number_list_response.rb', line 464

required :zoho,
-> { Revox::Models::PhoneNumberListResponse::PhoneNumber::InboundAssistant::Zoho },
nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


342
 
# File 'sig/revox/models/phone_number_list_response.rbs', line 342

def to_hash: -> {