Class: Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant

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

Overview

See Also:

  • Revox::Models::CampaignLaunchResponse::Session::InFlightCall#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_launch_response.rb', line 943

Instance Attribute Details

#after_call_sms_outcomes ⇒ Array<Symbol, Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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::CampaignLaunchResponse::Session::InFlightCall::Assistant::after_call_sms_outcome], nil)

Returns:



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

required :after_call_sms_outcomes,
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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) 


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

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::CampaignLaunchResponse::Session::InFlightCall::Assistant::background_sound, nil)

Returns:



455
456
457
 
# File 'lib/revox/models/campaign_launch_response.rb', line 455

required :background_sound,
enum: -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::BackgroundSound },
nil?: true

#background_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :background_sound_volume, Float

#calendly ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::Calendly?

Parameters:

Returns:



468
469
470
 
# File 'lib/revox/models/campaign_launch_response.rb', line 468

required :calendly,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::Calendly },
nil?: true

#call_retry_config ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::CallRetryConfig?

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

Parameters:

Returns:



477
478
479
 
# File 'lib/revox/models/campaign_launch_response.rb', line 477

required :call_retry_config,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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) 


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

required :cartesia_dictionary_pronunciation_id, String, nil?: true

#created_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


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

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

#created_by ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::CreatedBy?

The user who created the assistant.

Parameters:

Returns:



767
768
769
 
# File 'lib/revox/models/campaign_launch_response.rb', line 767

optional :created_by,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::CreatedBy },
nil?: true

#custom_tools ⇒ Array<Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::CustomTool>?

Parameters:

Returns:



495
496
497
 
# File 'lib/revox/models/campaign_launch_response.rb', line 495

required :custom_tools,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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) 


505
 
# File 'lib/revox/models/campaign_launch_response.rb', line 505

required :email_notification_address, String, nil?: true

#email_notification_outcomes ⇒ Array<Symbol, Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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::CampaignLaunchResponse::Session::InFlightCall::Assistant::email_notification_outcome], nil)

Returns:



512
513
514
 
# File 'lib/revox/models/campaign_launch_response.rb', line 512

required :email_notification_outcomes,
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::EmailNotificationOutcome] },
nil?: true

#end_of_call_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :end_of_call_sentence, String, nil?: true

#faq_items ⇒ Array<Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::FaqItem>?

Returns:



774
775
 
# File 'lib/revox/models/campaign_launch_response.rb', line 774

optional :faq_items,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::FaqItem] }

#first_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


524
 
# File 'lib/revox/models/campaign_launch_response.rb', line 524

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) 


530
 
# File 'lib/revox/models/campaign_launch_response.rb', line 530

required :first_sentence_delay_ms, Integer

#first_sentence_mode ⇒ Symbol, Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::FirstSentenceMode

Parameters:

  • value (Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::first_sentence_mode)

Returns:



535
536
 
# File 'lib/revox/models/campaign_launch_response.rb', line 535

required :first_sentence_mode,
enum: -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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) 


543
 
# File 'lib/revox/models/campaign_launch_response.rb', line 543

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::CampaignLaunchResponse::Session::InFlightCall::Assistant::human_transfer_mode, nil)

Returns:



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

required :human_transfer_mode,
enum: -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::HumanTransferMode },
nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#is_inbound_receptionist ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


780
 
# File 'lib/revox/models/campaign_launch_response.rb', line 780

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

#is_realestate_assistant ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


785
 
# File 'lib/revox/models/campaign_launch_response.rb', line 785

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) 


559
 
# File 'lib/revox/models/campaign_launch_response.rb', line 559

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

#llm_model ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::LlmModel::UnionMember0, ...

Parameters:

  • value (Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::llm_model)

Returns:



564
565
 
# File 'lib/revox/models/campaign_launch_response.rb', line 564

required :llm_model,
union: -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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) 


572
 
# File 'lib/revox/models/campaign_launch_response.rb', line 572

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) 


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

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) 


587
 
# File 'lib/revox/models/campaign_launch_response.rb', line 587

required :max_duration_end_message, String, nil?: true

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


592
 
# File 'lib/revox/models/campaign_launch_response.rb', line 592

required :name, String

#organization_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


597
 
# File 'lib/revox/models/campaign_launch_response.rb', line 597

required :organization_id, String

#pending_faq_count ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


790
 
# File 'lib/revox/models/campaign_launch_response.rb', line 790

optional :pending_faq_count, Float

#position ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::Position?

Parameters:

Returns:



602
603
604
 
# File 'lib/revox/models/campaign_launch_response.rb', line 602

required :position,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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) 


611
 
# File 'lib/revox/models/campaign_launch_response.rb', line 611

required :precall_lookup_url, String, nil?: true

#prompt ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


616
 
# File 'lib/revox/models/campaign_launch_response.rb', line 616

required :prompt, String

#prompt_flow ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::PromptFlow?

Parameters:

Returns:



621
622
623
 
# File 'lib/revox/models/campaign_launch_response.rb', line 621

required :prompt_flow,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::PromptFlow },
nil?: true

#slack ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::Slack?

Parameters:

Returns:



628
629
630
 
# File 'lib/revox/models/campaign_launch_response.rb', line 628

required :slack,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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) 


637
 
# File 'lib/revox/models/campaign_launch_response.rb', line 637

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) 


645
 
# File 'lib/revox/models/campaign_launch_response.rb', line 645

required :sms_template, String, nil?: true

#structured_output_config ⇒ Array<Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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:



652
653
654
 
# File 'lib/revox/models/campaign_launch_response.rb', line 652

required :structured_output_config,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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) 


662
 
# File 'lib/revox/models/campaign_launch_response.rb', line 662

required :structured_output_prompt, String, nil?: true

#stt_context ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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:



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

required :stt_context,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::SttContext },
nil?: true

#stt_model ⇒ Symbol, Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::SttModel

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

Parameters:

  • value (Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::stt_model)

Returns:



678
679
 
# File 'lib/revox/models/campaign_launch_response.rb', line 678

required :stt_model,
enum: -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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::CampaignLaunchResponse::Session::InFlightCall::Assistant::thinking_sound, nil)

Returns:



686
687
688
 
# File 'lib/revox/models/campaign_launch_response.rb', line 686

required :thinking_sound,
enum: -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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) 


695
 
# File 'lib/revox/models/campaign_launch_response.rb', line 695

required :thinking_sound_probability, Float

#thinking_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


701
 
# File 'lib/revox/models/campaign_launch_response.rb', line 701

required :thinking_sound_volume, Float

#transfer_destinations ⇒ Array<Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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:



708
709
710
 
# File 'lib/revox/models/campaign_launch_response.rb', line 708

required :transfer_destinations,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::TransferDestination] },
nil?: true

#type ⇒ Symbol, Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::Type

Parameters:

  • value (Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::type_)

Returns:



715
 
# File 'lib/revox/models/campaign_launch_response.rb', line 715

required :type, enum: -> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::Type }

#updated_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


720
 
# File 'lib/revox/models/campaign_launch_response.rb', line 720

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

#voice ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::Voice?

Parameters:

Returns:



725
726
727
 
# File 'lib/revox/models/campaign_launch_response.rb', line 725

required :voice,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::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) 


734
 
# File 'lib/revox/models/campaign_launch_response.rb', line 734

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) 


741
 
# File 'lib/revox/models/campaign_launch_response.rb', line 741

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) 


748
 
# File 'lib/revox/models/campaign_launch_response.rb', line 748

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) 


754
 
# File 'lib/revox/models/campaign_launch_response.rb', line 754

required :webhook_url, String, nil?: true

#zoho ⇒ Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::Zoho?

Parameters:

Returns:



759
760
761
 
# File 'lib/revox/models/campaign_launch_response.rb', line 759

required :zoho,
-> { Revox::Models::CampaignLaunchResponse::Session::InFlightCall::Assistant::Zoho },
nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


546
 
# File 'sig/revox/models/campaign_launch_response.rbs', line 546

def to_hash: -> {