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, EmailNotificationLanguage, EmailNotificationOutcome, FirstSentenceMode, HumanTransferMode, LlmModel, SttModel, ThinkingSound, Type Classes: Calendly, CallRetryConfig, CreatedBy, CustomTool, FaqItem, Position, PromptFlow, Slack, StructuredOutputConfig, SttContext, 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 810

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:



323
324
325
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 323

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) 


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

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:



338
339
340
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 338

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) 


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

required :background_sound_volume, Float

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

Parameters:

Returns:



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

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:



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

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) 


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

required :cartesia_dictionary_pronunciation_id, String, nil?: true

#created_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


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

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

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

The user who created the assistant.

Parameters:

Returns:



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

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

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

Parameters:

Returns:



378
379
380
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 378

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) 


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

required :email_notification_address, String, nil?: true

#email_notification_language ⇒ Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::EmailNotificationLanguage

The language used for the notification email content. One of "en" or "fr".

Parameters:

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

Returns:



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

required :email_notification_language,
enum: -> { Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::EmailNotificationLanguage }

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



402
403
404
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 402

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) 


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

required :end_of_call_sentence, String, nil?: true

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

Returns:



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

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

#first_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

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) 


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

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:



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

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) 


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

required :from_phone_number, String, nil?: true

#human_transfer_mode ⇒ Symbol, ...

Warm or cold transfer when transfer_phone_number is set; null when transfer is not configured.

Parameters:

  • value (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::human_transfer_mode, nil)

Returns:



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

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

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#is_realestate_assistant ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

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) 


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

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:



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

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) 


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

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) 


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

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) 


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

required :max_duration_end_message, String, nil?: true

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :name, String

#organization_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :organization_id, String

#pending_faq_count ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


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

optional :pending_faq_count, Float

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

Parameters:

Returns:



491
492
493
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 491

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

#prompt ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :prompt, String

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

Parameters:

Returns:



503
504
505
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 503

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

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

Parameters:

Returns:



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

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) 


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

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) 


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

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:



532
533
534
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 532

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) 


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

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:



550
551
552
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 550

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:



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

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:



565
566
567
 
# File 'lib/revox/models/campaign_get_rows_response.rb', line 565

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) 


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

required :thinking_sound_probability, Float

#thinking_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :thinking_sound_volume, Float

#transfer_phone_number ⇒ String?

Phone number to transfer calls to when users request to speak to a human agent.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :transfer_phone_number, String, nil?: true

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

Parameters:

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

Returns:



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

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

#updated_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


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

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

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

Parameters:

Returns:



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

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) 


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

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) 


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

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) 


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

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) 


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

required :webhook_url, String, nil?: true

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

Parameters:

Returns:



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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {