Class: Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant

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

Overview

See Also:

  • Revox::Models::CampaignGetRowsResponse::Row::Call#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/campaign_get_rows_response.rb', line 838

Instance Attribute Details

#after_call_sms_outcomes ⇒ Array<Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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::CampaignGetRowsResponse::Row::Call::Assistant::after_call_sms_outcome], nil)

Returns:



344
345
346
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 344

required :after_call_sms_outcomes,
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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) 


353
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 353

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::CampaignGetRowsResponse::Row::Call::Assistant::background_sound, nil)

Returns:



359
360
361
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 359

required :background_sound,
enum: -> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::BackgroundSound },
nil?: true

#background_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :background_sound_volume, Float

#calendly ⇒ Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Calendly?

Parameters:

Returns:



372
373
374
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 372

required :calendly,
-> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Calendly },
nil?: true

#call_retry_config ⇒ Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::CallRetryConfig?

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

Parameters:

Returns:



381
382
383
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 381

required :call_retry_config,
-> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::CallRetryConfig },
nil?: true

#cartesia_dictionary_pronunciation_id ⇒ String?

Optional Cartesia pronunciation dictionary ID linked to this assistant.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


389
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 389

required :cartesia_dictionary_pronunciation_id, String, nil?: true

#created_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


394
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 394

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

#created_by ⇒ Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::CreatedBy?

The user who created the assistant.

Parameters:

Returns:



663
664
665
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 663

optional :created_by,
-> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::CreatedBy },
nil?: true

#custom_tools ⇒ Array<Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::CustomTool>?

Parameters:

Returns:



399
400
401
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 399

required :custom_tools,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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) 


409
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 409

required :email_notification_address, String, nil?: true

#email_notification_outcomes ⇒ Array<Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::EmailNotificationOutcome>?

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

Parameters:

  • value (::Array[Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::email_notification_outcome], nil)

Returns:



416
417
418
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 416

required :email_notification_outcomes,
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::EmailNotificationOutcome] },
nil?: true

#end_of_call_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


423
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 423

required :end_of_call_sentence, String, nil?: true

#faq_items ⇒ Array<Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::FaqItem>?

Returns:



670
671
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 670

optional :faq_items,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::FaqItem] }

#first_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


428
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 428

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) 


434
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 434

required :first_sentence_delay_ms, Integer

#first_sentence_mode ⇒ Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::FirstSentenceMode

Parameters:

  • value (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::first_sentence_mode)

Returns:



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

required :first_sentence_mode,
enum: -> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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) 


447
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 447

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::CampaignGetRowsResponse::Row::Call::Assistant::human_transfer_mode, nil)

Returns:



454
455
456
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 454

required :human_transfer_mode,
enum: -> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::HumanTransferMode },
nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


337
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 337

required :id, String

#is_inbound_receptionist ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


676
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 676

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

#is_realestate_assistant ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


681
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 681

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) 


463
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 463

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

#llm_model ⇒ Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::LlmModel::UnionMember0, ...

Parameters:

  • value (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::llm_model)

Returns:



468
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 468

required :llm_model, union: -> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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) 


475
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 475

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) 


482
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 482

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) 


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

required :max_duration_end_message, String, nil?: true

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :name, String

#organization_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


500
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 500

required :organization_id, String

#pending_faq_count ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


686
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 686

optional :pending_faq_count, Float

#position ⇒ Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Position?

Parameters:

Returns:



505
506
507
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 505

required :position,
-> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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) 


514
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 514

required :precall_lookup_url, String, nil?: true

#prompt ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


519
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 519

required :prompt, String

#prompt_flow ⇒ Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::PromptFlow?

Parameters:

Returns:



524
525
526
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 524

required :prompt_flow,
-> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::PromptFlow },
nil?: true

#slack ⇒ Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Slack?

Parameters:

Returns:



531
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 531

required :slack, -> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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) 


538
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 538

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) 


546
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 546

required :sms_template, String, nil?: true

#structured_output_config ⇒ Array<Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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:



553
554
555
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 553

required :structured_output_config,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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) 


563
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 563

required :structured_output_prompt, String, nil?: true

#stt_context ⇒ Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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:



571
572
573
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 571

required :stt_context,
-> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::SttContext },
nil?: true

#stt_model ⇒ Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::SttModel

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

Parameters:

  • value (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::stt_model)

Returns:



579
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 579

required :stt_model, enum: -> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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::CampaignGetRowsResponse::Row::Call::Assistant::thinking_sound, nil)

Returns:



586
587
588
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 586

required :thinking_sound,
enum: -> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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) 


595
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 595

required :thinking_sound_probability, Float

#thinking_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


601
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 601

required :thinking_sound_volume, Float

#transfer_destinations ⇒ Array<Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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:



608
609
610
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 608

required :transfer_destinations,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::TransferDestination] },
nil?: true

#type ⇒ Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Type

Parameters:

  • value (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::type_)

Returns:



615
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 615

required :type, enum: -> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Type }

#updated_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


620
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 620

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

#voice ⇒ Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Voice?

Parameters:

Returns:



625
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 625

required :voice, -> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::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) 


632
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 632

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) 


639
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 639

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) 


646
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 646

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) 


652
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 652

required :webhook_url, String, nil?: true

#zoho ⇒ Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Zoho?

Parameters:

Returns:



657
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 657

required :zoho, -> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Zoho }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


465
 
# File 'sig/revox/models/campaign_get_rows_response.rbs', line 465

def to_hash: -> {