Class: Revox::Models::CallCreateParams::Assistant

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Revox::Models::CallCreateParams::Assistant

Defined in:

lib/revox/models/call_create_params.rb,
sig/revox/models/call_create_params.rbs

Defined Under Namespace

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

Instance Attribute Summary

• #after_call_sms_outcomes ⇒ Array<Symbol, Revox::Models::CallCreateParams::Assistant::AfterCallSMSOutcome>^?

  Which call outcomes trigger the after-call SMS.

• #after_call_sms_prompt ⇒ String^?

  Prompt / instructions for the after-call SMS.

• #background_sound ⇒ Symbol, ...

  Ambient background sound to play during the call.

• #background_sound_volume ⇒ Float^?

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

• #calendly ⇒ Revox::Models::CallCreateParams::Assistant::Calendly^?
• #call_retry_config ⇒ Revox::Models::CallCreateParams::Assistant::CallRetryConfig^?

  Configuration for call retry behavior including time windows, delays, and max iterations.

• #cartesia_dictionary_pronunciation_id ⇒ String^?

  Optional Cartesia pronunciation dictionary ID to use for this assistant's calls.

• #custom_tools ⇒ Array<Revox::Models::CallCreateParams::Assistant::CustomTool>^?

  Custom API tools the assistant can call during conversations.

• #email_notification_address ⇒ String^?

  Email address(es) to receive notifications when a call ends with a matching outcome.

• #email_notification_language ⇒ Symbol, ...

  The language used for the notification email content.

• #email_notification_outcomes ⇒ Array<Symbol, Revox::Models::CallCreateParams::Assistant::EmailNotificationOutcome>^?

  Which call outcomes trigger an email notification.

• #end_of_call_sentence ⇒ String^?

  Optional message to say when the agent decides to end the call.

• #faq_items ⇒ Array<Revox::Models::CallCreateParams::Assistant::FaqItem>^?

  FAQ items to associate with this assistant.

• #first_sentence ⇒ String^?

  The first sentence to use for the call.

• #first_sentence_delay_ms ⇒ Integer^?

  Delay in milliseconds before speaking the first sentence.

• #first_sentence_mode ⇒ Symbol, ...

  How the first sentence should be handled.

• #from_phone_number ⇒ String^?

  Override the default outbound phone number for calls placed with this assistant.

• #human_transfer_mode ⇒ Symbol, ...

  When transfer_phone_number is set: "warm" (AI bridges) or "cold" (SIP REFER; trunk must allow REFER/PSTN).

• #ivr_navigation_enabled ⇒ Boolean^?

  Enable IVR navigation tools.

• #llm_model ⇒ Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0, ...
• #logo_url ⇒ String^?

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

• #max_call_duration_secs ⇒ Float^?

  The maximum duration of the call in seconds.

• #max_duration_end_message ⇒ String^?

  Optional message the agent will say, without being interruptible, when the call reaches its max duration.

• #position ⇒ Revox::Models::CallCreateParams::Assistant::Position^?

  Canvas position of this assistant's node in its multi-step flow editor.

• #prompt ⇒ String

  The prompt to use for the call.

• #prompt_flow ⇒ Revox::Models::CallCreateParams::Assistant::PromptFlow^?

  Visual prompt constructor data (nodes, edges, positions).

• #slack ⇒ Revox::Models::CallCreateParams::Assistant::Slack^?

  Slack notification config.

• #sms_enabled ⇒ Boolean^?

  Enable SMS tool during calls.

• #sms_template ⇒ String^?

  Hardcoded SMS template to send during calls.

• #structured_output_config ⇒ Array<Revox::Models::CallCreateParams::Assistant::StructuredOutputConfig>^?

  The structured output config to use for the call.

• #structured_output_prompt ⇒ String^?

  Custom prompt for structured data extraction.

• #stt_context ⇒ Revox::Models::CallCreateParams::Assistant::SttContext^?

  Assistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms.

• #stt_model ⇒ Symbol, ...

  Transcriber (speech-to-text) model.

• #thinking_sound ⇒ Symbol, ...

  Audio clip to play while the agent is processing a response.

• #thinking_sound_probability ⇒ Float^?

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

• #thinking_sound_volume ⇒ Float^?

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

• #transfer_phone_number ⇒ String^?

  Phone number to transfer calls to when users request to speak to a human agent in E.164 format (e.g. +1234567890).

• #type ⇒ Symbol, ...

  Assistant kind.

• #voice ⇒ Revox::Models::CallCreateParams::Assistant::Voice^?

  The voice to use for the call.

• #voicemail_message ⇒ String^?

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

• #voicemail_sms_prompt ⇒ String^?

  SMS message to send when the call reaches voicemail.

• #warm_transfer_summary_instructions ⇒ String^?

  When using warm transfer: extra instructions for the supervisor handoff summary.

• #webhook_url ⇒ String^?

  The webhook URL to call when the call is completed.

• #zoho ⇒ Revox::Models::CallCreateParams::Assistant::Zoho^?

  Zoho CRM integration config.

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ Array(Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember1, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember2, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember3)

Instance Method Summary

• #initialize(key:, value:) ⇒ Object constructor
• #to_hash ⇒ {

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(key:, value:) ⇒ Object

Parameters:

• key (String)
• value (String)

# File 'lib/revox/models/call_create_params.rb', line 93

class Assistant < Revox::Internal::Type::BaseModel
  # @!attribute prompt
  #   The prompt to use for the call. This will be given to the LLM (gpt-4.1)
  #
  #   @return [String]
  required :prompt, String

  # @!attribute after_call_sms_outcomes
  #   Which call outcomes trigger the after-call SMS. When empty or null, no
  #   after-call SMS is sent. E.g. ["interested", "completed", "none"]. Use "none"
  #   when outcome is null.
  #
  #   @return [Array<Symbol, Revox::Models::CallCreateParams::Assistant::AfterCallSMSOutcome>, nil]
  optional :after_call_sms_outcomes,
           -> {
             Revox::Internal::Type::ArrayOf[enum: Revox::CallCreateParams::Assistant::AfterCallSMSOutcome]
           },
           nil?: true

  # @!attribute after_call_sms_prompt
  #   Prompt / instructions for the after-call SMS. Supports {{variable}}
  #   placeholders. When null, no after-call SMS is sent.
  #
  #   @return [String, nil]
  optional :after_call_sms_prompt, String, nil?: true

  # @!attribute background_sound
  #   Ambient background sound to play during the call. null/omitted disables it.
  #
  #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::BackgroundSound, nil]
  optional :background_sound,
           enum: -> {
             Revox::CallCreateParams::Assistant::BackgroundSound
           },
           nil?: true

  # @!attribute background_sound_volume
  #   Volume of the ambient background sound (0 = silent, 1 = max).
  #
  #   @return [Float, nil]
  optional :background_sound_volume, Float

  # @!attribute calendly
  #
  #   @return [Revox::Models::CallCreateParams::Assistant::Calendly, nil]
  optional :calendly, -> { Revox::CallCreateParams::Assistant::Calendly }, nil?: true

  # @!attribute call_retry_config
  #   Configuration for call retry behavior including time windows, delays, and max
  #   iterations. If not provided, defaults will be used.
  #
  #   @return [Revox::Models::CallCreateParams::Assistant::CallRetryConfig, nil]
  optional :call_retry_config, -> { Revox::CallCreateParams::Assistant::CallRetryConfig }

  # @!attribute cartesia_dictionary_pronunciation_id
  #   Optional Cartesia pronunciation dictionary ID to use for this assistant's calls.
  #   Set null to unlink it.
  #
  #   @return [String, nil]
  optional :cartesia_dictionary_pronunciation_id, String, nil?: true

  # @!attribute custom_tools
  #   Custom API tools the assistant can call during conversations. Each tool defines
  #   an HTTP endpoint with variable substitution.
  #
  #   @return [Array<Revox::Models::CallCreateParams::Assistant::CustomTool>, nil]
  optional :custom_tools,
           -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::CustomTool] },
           nil?: true

  # @!attribute email_notification_address
  #   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").
  #
  #   @return [String, nil]
  optional :email_notification_address, String, nil?: true

  # @!attribute email_notification_language
  #   The language used for the notification email content. One of "en" or "fr".
  #   Defaults to "en".
  #
  #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::EmailNotificationLanguage, nil]
  optional :email_notification_language,
           enum: -> { Revox::CallCreateParams::Assistant::EmailNotificationLanguage }

  # @!attribute email_notification_outcomes
  #   Which call outcomes trigger an email notification. E.g. ["interested",
  #   "completed", "none"]. Use "none" when outcome is null.
  #
  #   @return [Array<Symbol, Revox::Models::CallCreateParams::Assistant::EmailNotificationOutcome>, nil]
  optional :email_notification_outcomes,
           -> {
             Revox::Internal::Type::ArrayOf[enum: Revox::CallCreateParams::Assistant::EmailNotificationOutcome]
           },
           nil?: true

  # @!attribute end_of_call_sentence
  #   Optional message to say when the agent decides to end the call.
  #
  #   @return [String, nil]
  optional :end_of_call_sentence, String

  # @!attribute faq_items
  #   FAQ items to associate with this assistant. When provided, replaces all existing
  #   FAQ items.
  #
  #   @return [Array<Revox::Models::CallCreateParams::Assistant::FaqItem>, nil]
  optional :faq_items, -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::FaqItem] }

  # @!attribute first_sentence
  #   The first sentence to use for the call. This will be given to the LLM
  #
  #   @return [String, nil]
  optional :first_sentence, String

  # @!attribute first_sentence_delay_ms
  #   Delay in milliseconds before speaking the first sentence. Default: 400.
  #
  #   @return [Integer, nil]
  optional :first_sentence_delay_ms, Integer

  # @!attribute first_sentence_mode
  #   How the first sentence should be handled. "generated" means the LLM will
  #   generate a response based on the first_sentence instruction. "static" means the
  #   first_sentence will be spoken exactly as provided. "none" means the agent will
  #   not speak first and will wait for the user.
  #
  #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::FirstSentenceMode, nil]
  optional :first_sentence_mode, enum: -> { Revox::CallCreateParams::Assistant::FirstSentenceMode }

  # @!attribute from_phone_number
  #   Override the default outbound phone number for calls placed with this assistant.
  #   Must be a phone number owned by the organization in E.164 format (e.g.
  #   +1234567890). When null, the organization's default phone number is used.
  #
  #   @return [String, nil]
  optional :from_phone_number, String, nil?: true

  # @!attribute human_transfer_mode
  #   When transfer_phone_number is set: "warm" (AI bridges) or "cold" (SIP REFER;
  #   trunk must allow REFER/PSTN). Omit or null when transfer is disabled.
  #
  #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::HumanTransferMode, nil]
  optional :human_transfer_mode,
           enum: -> { Revox::CallCreateParams::Assistant::HumanTransferMode },
           nil?: true

  # @!attribute ivr_navigation_enabled
  #   Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
  #   skip turns to navigate phone menus.
  #
  #   @return [Boolean, nil]
  optional :ivr_navigation_enabled, Revox::Internal::Type::Boolean

  # @!attribute llm_model
  #
  #   @return [Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember1, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember2, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember3, nil]
  optional :llm_model, union: -> { Revox::CallCreateParams::Assistant::LlmModel }

  # @!attribute logo_url
  #   Public URL of the brand logo shown on the assistant's demo page. Upload a new
  #   logo via POST /assistants/:id/logo. Set explicitly to null to clear it.
  #
  #   @return [String, nil]
  optional :logo_url, String, nil?: true

  # @!attribute max_call_duration_secs
  #   The maximum duration of the call in seconds. This is the maximum time the call
  #   will be allowed to run.
  #
  #   @return [Float, nil]
  optional :max_call_duration_secs, Float

  # @!attribute max_duration_end_message
  #   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
  #   not set, the call ends silently.
  #
  #   @return [String, nil]
  optional :max_duration_end_message, String, nil?: true

  # @!attribute position
  #   Canvas position of this assistant's node in its multi-step flow editor.
  #
  #   @return [Revox::Models::CallCreateParams::Assistant::Position, nil]
  optional :position, -> { Revox::CallCreateParams::Assistant::Position }, nil?: true

  # @!attribute prompt_flow
  #   Visual prompt constructor data (nodes, edges, positions). Used by the UI to
  #   re-open the visual editor. Does not affect call behavior — the flattened prompt
  #   field is what the LLM receives.
  #
  #   @return [Revox::Models::CallCreateParams::Assistant::PromptFlow, nil]
  optional :prompt_flow, -> { Revox::CallCreateParams::Assistant::PromptFlow }, nil?: true

  # @!attribute slack
  #   Slack notification config. When set, posts a message to the chosen channel after
  #   a call ends with one of the configured outcomes.
  #
  #   @return [Revox::Models::CallCreateParams::Assistant::Slack, nil]
  optional :slack, -> { Revox::CallCreateParams::Assistant::Slack }, nil?: true

  # @!attribute sms_enabled
  #   Enable SMS tool during calls. When enabled, the agent can send SMS messages to
  #   the user on the call.
  #
  #   @return [Boolean, nil]
  optional :sms_enabled, Revox::Internal::Type::Boolean

  # @!attribute sms_template
  #   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.
  #
  #   @return [String, nil]
  optional :sms_template, String, nil?: true

  # @!attribute structured_output_config
  #   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.).
  #
  #   @return [Array<Revox::Models::CallCreateParams::Assistant::StructuredOutputConfig>, nil]
  optional :structured_output_config,
           -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::StructuredOutputConfig] }

  # @!attribute structured_output_prompt
  #   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}}.
  #
  #   @return [String, nil]
  optional :structured_output_prompt, String, nil?: true

  # @!attribute stt_context
  #   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.
  #
  #   @return [Revox::Models::CallCreateParams::Assistant::SttContext, nil]
  optional :stt_context, -> { Revox::CallCreateParams::Assistant::SttContext }, nil?: true

  # @!attribute stt_model
  #   Transcriber (speech-to-text) model. Defaults to the newest Soniox realtime model
  #   when omitted.
  #
  #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::SttModel, nil]
  optional :stt_model, enum: -> { Revox::CallCreateParams::Assistant::SttModel }

  # @!attribute thinking_sound
  #   Audio clip to play while the agent is processing a response. One of the built-in
  #   LiveKit audio clips; null/omitted disables it.
  #
  #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::ThinkingSound, nil]
  optional :thinking_sound, enum: -> { Revox::CallCreateParams::Assistant::ThinkingSound }, nil?: true

  # @!attribute thinking_sound_probability
  #   Probability [0..1] that the thinking sound plays on any given turn; otherwise
  #   the agent is silent while thinking.
  #
  #   @return [Float, nil]
  optional :thinking_sound_probability, Float

  # @!attribute thinking_sound_volume
  #   Volume of the thinking sound (0 = silent, 1 = max).
  #
  #   @return [Float, nil]
  optional :thinking_sound_volume, Float

  # @!attribute transfer_phone_number
  #   Phone number to transfer calls to when users request to speak to a human agent
  #   in E.164 format (e.g. +1234567890).
  #
  #   @return [String, nil]
  optional :transfer_phone_number, String, nil?: true

  # @!attribute type
  #   Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step'
  #   orchestrates a flow of sub-assistants, 'sub-assistant' is a step inside a
  #   multi-step flow (hidden from the assistants list). Flow transitions are managed
  #   via the /assistants/:id/edges endpoints, not on the assistant itself.
  #
  #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::Type, nil]
  optional :type, enum: -> { Revox::CallCreateParams::Assistant::Type }

  # @!attribute voice
  #   The voice to use for the call. You can get the list of voices using the /voices
  #   endpoint
  #
  #   @return [Revox::Models::CallCreateParams::Assistant::Voice, nil]
  optional :voice, -> { Revox::CallCreateParams::Assistant::Voice }

  # @!attribute voicemail_message
  #   If set, when voicemail is detected the agent will speak this message then hang
  #   up; if null, hang up immediately.
  #
  #   @return [String, nil]
  optional :voicemail_message, String, nil?: true

  # @!attribute voicemail_sms_prompt
  #   SMS message to send when the call reaches voicemail. Supports {{variable}}
  #   placeholders. When null, no SMS is sent on voicemail.
  #
  #   @return [String, nil]
  optional :voicemail_sms_prompt, String, nil?: true

  # @!attribute warm_transfer_summary_instructions
  #   When using warm transfer: extra instructions for the supervisor handoff summary.
  #   If null or empty, the API uses the product default briefing when the call is
  #   loaded for the agent.
  #
  #   @return [String, nil]
  optional :warm_transfer_summary_instructions, String, nil?: true

  # @!attribute webhook_url
  #   The webhook URL to call when the call is completed.
  #
  #   @return [String, nil]
  optional :webhook_url, String

  # @!attribute zoho
  #   Zoho CRM integration config. When set, upserts the prospect (keyed on phone)
  #   into the chosen module and attaches a Note with the call summary after a call
  #   ends with one of the configured outcomes.
  #
  #   @return [Revox::Models::CallCreateParams::Assistant::Zoho, nil]
  optional :zoho, -> { Revox::CallCreateParams::Assistant::Zoho }, nil?: true

  # @!method initialize(prompt:, after_call_sms_outcomes: nil, after_call_sms_prompt: nil, background_sound: nil, background_sound_volume: nil, calendly: nil, call_retry_config: nil, cartesia_dictionary_pronunciation_id: nil, custom_tools: nil, email_notification_address: nil, email_notification_language: nil, email_notification_outcomes: nil, end_of_call_sentence: nil, faq_items: nil, first_sentence: nil, first_sentence_delay_ms: nil, first_sentence_mode: nil, from_phone_number: nil, human_transfer_mode: nil, ivr_navigation_enabled: nil, llm_model: nil, logo_url: nil, max_call_duration_secs: nil, max_duration_end_message: nil, position: nil, prompt_flow: nil, slack: nil, sms_enabled: nil, sms_template: nil, structured_output_config: nil, structured_output_prompt: nil, stt_context: nil, stt_model: nil, thinking_sound: nil, thinking_sound_probability: nil, thinking_sound_volume: nil, transfer_phone_number: nil, type: nil, voice: nil, voicemail_message: nil, voicemail_sms_prompt: nil, warm_transfer_summary_instructions: nil, webhook_url: nil, zoho: nil)
  #   Some parameter documentations has been truncated, see
  #   {Revox::Models::CallCreateParams::Assistant} for more details.
  #
  #   You can provide a custom assistant configuration here. If you don't provide an
  #   assistant_id, this assistant object will be used for this call.
  #
  #   @param prompt [String] The prompt to use for the call. This will be given to the LLM (gpt-4.1)
  #
  #   @param after_call_sms_outcomes [Array<Symbol, Revox::Models::CallCreateParams::Assistant::AfterCallSMSOutcome>, nil] Which call outcomes trigger the after-call SMS. When empty or null, no after-cal
  #
  #   @param after_call_sms_prompt [String, nil] Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders
  #
  #   @param background_sound [Symbol, Revox::Models::CallCreateParams::Assistant::BackgroundSound, nil] Ambient background sound to play during the call. null/omitted disables it.
  #
  #   @param background_sound_volume [Float] Volume of the ambient background sound (0 = silent, 1 = max).
  #
  #   @param calendly [Revox::Models::CallCreateParams::Assistant::Calendly, nil]
  #
  #   @param call_retry_config [Revox::Models::CallCreateParams::Assistant::CallRetryConfig] Configuration for call retry behavior including time windows, delays, and max it
  #
  #   @param cartesia_dictionary_pronunciation_id [String, nil] Optional Cartesia pronunciation dictionary ID to use for this assistant's calls.
  #
  #   @param custom_tools [Array<Revox::Models::CallCreateParams::Assistant::CustomTool>, nil] Custom API tools the assistant can call during conversations. Each tool defines
  #
  #   @param email_notification_address [String, nil] Email address(es) to receive notifications when a call ends with a matching outc
  #
  #   @param email_notification_language [Symbol, Revox::Models::CallCreateParams::Assistant::EmailNotificationLanguage] The language used for the notification email content. One of "en" or "fr". Defau
  #
  #   @param email_notification_outcomes [Array<Symbol, Revox::Models::CallCreateParams::Assistant::EmailNotificationOutcome>, nil] Which call outcomes trigger an email notification. E.g. ["interested", "complete
  #
  #   @param end_of_call_sentence [String] Optional message to say when the agent decides to end the call.
  #
  #   @param faq_items [Array<Revox::Models::CallCreateParams::Assistant::FaqItem>] FAQ items to associate with this assistant. When provided, replaces all existing
  #
  #   @param first_sentence [String] The first sentence to use for the call. This will be given to the LLM
  #
  #   @param first_sentence_delay_ms [Integer] Delay in milliseconds before speaking the first sentence. Default: 400.
  #
  #   @param first_sentence_mode [Symbol, Revox::Models::CallCreateParams::Assistant::FirstSentenceMode] How the first sentence should be handled. "generated" means the LLM will generat
  #
  #   @param from_phone_number [String, nil] Override the default outbound phone number for calls placed with this assistant.
  #
  #   @param human_transfer_mode [Symbol, Revox::Models::CallCreateParams::Assistant::HumanTransferMode, nil] When transfer_phone_number is set: "warm" (AI bridges) or "cold" (SIP REFER; tru
  #
  #   @param ivr_navigation_enabled [Boolean] Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
  #
  #   @param llm_model [Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember1, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember2, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember3]
  #
  #   @param logo_url [String, nil] Public URL of the brand logo shown on the assistant's demo page. Upload a new lo
  #
  #   @param max_call_duration_secs [Float] The maximum duration of the call in seconds. This is the maximum time the call w
  #
  #   @param max_duration_end_message [String, nil] Optional message the agent will say, without being interruptible, when the call
  #
  #   @param position [Revox::Models::CallCreateParams::Assistant::Position, nil] Canvas position of this assistant's node in its multi-step flow editor.
  #
  #   @param prompt_flow [Revox::Models::CallCreateParams::Assistant::PromptFlow, nil] Visual prompt constructor data (nodes, edges, positions). Used by the UI to re-o
  #
  #   @param slack [Revox::Models::CallCreateParams::Assistant::Slack, nil] Slack notification config. When set, posts a message to the chosen channel after
  #
  #   @param sms_enabled [Boolean] Enable SMS tool during calls. When enabled, the agent can send SMS messages to t
  #
  #   @param sms_template [String, nil] Hardcoded SMS template to send during calls. When set, this exact text is sent i
  #
  #   @param structured_output_config [Array<Revox::Models::CallCreateParams::Assistant::StructuredOutputConfig>] The structured output config to use for the call. This is used to extract the da
  #
  #   @param structured_output_prompt [String, nil] Custom prompt for structured data extraction. If not provided, a default prompt
  #
  #   @param stt_context [Revox::Models::CallCreateParams::Assistant::SttContext, nil] Assistant-level speech-to-text context: structured `general` key/value pairs plu
  #
  #   @param stt_model [Symbol, Revox::Models::CallCreateParams::Assistant::SttModel] Transcriber (speech-to-text) model. Defaults to the newest Soniox realtime model
  #
  #   @param thinking_sound [Symbol, Revox::Models::CallCreateParams::Assistant::ThinkingSound, nil] Audio clip to play while the agent is processing a response. One of the built-in
  #
  #   @param thinking_sound_probability [Float] Probability [0..1] that the thinking sound plays on any given turn; otherwise th
  #
  #   @param thinking_sound_volume [Float] Volume of the thinking sound (0 = silent, 1 = max).
  #
  #   @param transfer_phone_number [String, nil] Phone number to transfer calls to when users request to speak to a human agent i
  #
  #   @param type [Symbol, Revox::Models::CallCreateParams::Assistant::Type] Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step' orche
  #
  #   @param voice [Revox::Models::CallCreateParams::Assistant::Voice] The voice to use for the call. You can get the list of voices using the /voices
  #
  #   @param voicemail_message [String, nil] If set, when voicemail is detected the agent will speak this message then hang u
  #
  #   @param voicemail_sms_prompt [String, nil] SMS message to send when the call reaches voicemail. Supports {{variable}} place
  #
  #   @param warm_transfer_summary_instructions [String, nil] When using warm transfer: extra instructions for the supervisor handoff summary.
  #
  #   @param webhook_url [String] The webhook URL to call when the call is completed.
  #
  #   @param zoho [Revox::Models::CallCreateParams::Assistant::Zoho, nil] Zoho CRM integration config. When set, upserts the prospect (keyed on phone) int

  module AfterCallSMSOutcome
    extend Revox::Internal::Type::Enum

    NOT_INTERESTED = :not_interested
    INTERESTED = :interested
    COMPLETED = :completed
    REQUESTED_CALLBACK_LATER = :requested_callback_later
    REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
    DO_NOT_CONTACT = :do_not_contact
    AI_AVERSE = :ai_averse
    NONE = :none

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # Ambient background sound to play during the call. null/omitted disables it.
  #
  # @see Revox::Models::CallCreateParams::Assistant#background_sound
  module BackgroundSound
    extend Revox::Internal::Type::Enum

    AUDIO_OFFICE_OGG = :"audio/office.ogg"

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Revox::Models::CallCreateParams::Assistant#calendly
  class Calendly < Revox::Internal::Type::BaseModel
    # @!attribute connection_id
    #   The connection ID representing the link between your Calendly account and Revox.
    #
    #   @return [String]
    required :connection_id, String

    # @!attribute event_type_id
    #   The event type ID representing the event type to schedule. (eg:
    #   https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)
    #
    #   @return [String]
    required :event_type_id, String

    # @!method initialize(connection_id:, event_type_id:)
    #   Some parameter documentations has been truncated, see
    #   {Revox::Models::CallCreateParams::Assistant::Calendly} for more details.
    #
    #   @param connection_id [String] The connection ID representing the link between your Calendly account and Revox.
    #
    #   @param event_type_id [String] The event type ID representing the event type to schedule. (eg: https://api.cale
  end

  # @see Revox::Models::CallCreateParams::Assistant#call_retry_config
  class CallRetryConfig < Revox::Internal::Type::BaseModel
    # @!attribute allowed_days
    #   Days of the week when calls are allowed, in the recipient's timezone. Default:
    #   Monday through Friday.
    #
    #   @return [Array<Symbol, Revox::Models::CallCreateParams::Assistant::CallRetryConfig::AllowedDay>]
    required :allowed_days,
             -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallCreateParams::Assistant::CallRetryConfig::AllowedDay] }

    # @!attribute call_twice_in_a_row
    #   If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping
    #   retry_delay_seconds) when attempt #1 didn't reach a human.
    #   Calling-window/allowed-days checks still apply. Only affects the 1→2 transition.
    #   Default: false.
    #
    #   @return [Boolean]
    required :call_twice_in_a_row, Revox::Internal::Type::Boolean

    # @!attribute calling_windows
    #
    #   @return [Array<Revox::Models::CallCreateParams::Assistant::CallRetryConfig::CallingWindow>]
    required :calling_windows,
             -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::CallRetryConfig::CallingWindow] }

    # @!attribute max_retry_attempts
    #   Maximum number of call retry attempts. Default: 3.
    #
    #   @return [Integer]
    required :max_retry_attempts, Integer

    # @!attribute timezone
    #   Optional IANA timezone identifier to override the automatic timezone detection
    #   from phone number. If not provided, timezone is determined from the recipient's
    #   phone number country code. Examples: 'America/New_York', 'Europe/Paris'.
    #
    #   @return [String, nil]
    optional :timezone, String, nil?: true

    # @!method initialize(allowed_days:, call_twice_in_a_row:, calling_windows:, max_retry_attempts:, timezone: nil)
    #   Some parameter documentations has been truncated, see
    #   {Revox::Models::CallCreateParams::Assistant::CallRetryConfig} for more details.
    #
    #   Configuration for call retry behavior including time windows, delays, and max
    #   iterations. If not provided, defaults will be used.
    #
    #   @param allowed_days [Array<Symbol, Revox::Models::CallCreateParams::Assistant::CallRetryConfig::AllowedDay>] Days of the week when calls are allowed, in the recipient's timezone. Default: M
    #
    #   @param call_twice_in_a_row [Boolean] If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retr
    #
    #   @param calling_windows [Array<Revox::Models::CallCreateParams::Assistant::CallRetryConfig::CallingWindow>]
    #
    #   @param max_retry_attempts [Integer] Maximum number of call retry attempts. Default: 3.
    #
    #   @param timezone [String, nil] Optional IANA timezone identifier to override the automatic timezone detection f

    module AllowedDay
      extend Revox::Internal::Type::Enum

      MONDAY = :monday
      TUESDAY = :tuesday
      WEDNESDAY = :wednesday
      THURSDAY = :thursday
      FRIDAY = :friday
      SATURDAY = :saturday
      SUNDAY = :sunday

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    class CallingWindow < Revox::Internal::Type::BaseModel
      # @!attribute calling_window_end_time
      #   End time for the calling window in the recipient's timezone (or
      #   timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour).
      #   Examples: '17:00', '6pm'. Default: '18:00'.
      #
      #   @return [String]
      required :calling_window_end_time, String

      # @!attribute calling_window_start_time
      #   Start time for the calling window in the recipient's timezone (or
      #   timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour).
      #   Examples: '09:00', '10am'. Default: '10:00'.
      #
      #   @return [String]
      required :calling_window_start_time, String

      # @!attribute retry_delay_seconds
      #   Delay between retry attempts in seconds. Default: 7200 (2 hours).
      #
      #   @return [Integer]
      required :retry_delay_seconds, Integer

      # @!method initialize(calling_window_end_time:, calling_window_start_time:, retry_delay_seconds:)
      #   Some parameter documentations has been truncated, see
      #   {Revox::Models::CallCreateParams::Assistant::CallRetryConfig::CallingWindow} for
      #   more details.
      #
      #   @param calling_window_end_time [String] End time for the calling window in the recipient's timezone (or timezone_overrid
      #
      #   @param calling_window_start_time [String] Start time for the calling window in the recipient's timezone (or timezone_overr
      #
      #   @param retry_delay_seconds [Integer] Delay between retry attempts in seconds. Default: 7200 (2 hours).
    end
  end

  class CustomTool < Revox::Internal::Type::BaseModel
    # @!attribute body_template
    #   JSON body template for the request. Use quoted {{variable}} placeholders (e.g.
    #   "{{name}}") for dynamic values
    #
    #   @return [String, nil]
    required :body_template, String, nil?: true

    # @!attribute description
    #   Human-readable description of what the tool does, used by the LLM to decide when
    #   to call it
    #
    #   @return [String]
    required :description, String

    # @!attribute headers
    #   HTTP headers to include in the request. Values support {{variable}} placeholders
    #
    #   @return [Array<Revox::Models::CallCreateParams::Assistant::CustomTool::Header>]
    required :headers,
             -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::CustomTool::Header] }

    # @!attribute input_schema
    #   Schema defining the parameters the LLM should extract from the conversation to
    #   pass to this tool
    #
    #   @return [Array<Revox::Models::CallCreateParams::Assistant::CustomTool::InputSchema>]
    required :input_schema,
             -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::CustomTool::InputSchema] }

    # @!attribute method_
    #   HTTP method to use when calling the API endpoint
    #
    #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::CustomTool::Method]
    required :method_,
             enum: -> {
               Revox::CallCreateParams::Assistant::CustomTool::Method
             },
             api_name: :method

    # @!attribute name
    #   Unique tool name in lowercase_snake_case (e.g. check_inventory)
    #
    #   @return [String]
    required :name, String

    # @!attribute query_params
    #   Query string parameters appended to the URL. Values support {{variable}}
    #   placeholders
    #
    #   @return [Array<Revox::Models::CallCreateParams::Assistant::CustomTool::QueryParam>]
    required :query_params,
             -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::CustomTool::QueryParam] }

    # @!attribute url
    #   Full URL of the API endpoint. Supports {{variable}} placeholders for dynamic
    #   values
    #
    #   @return [String]
    required :url, String

    # @!method initialize(body_template:, description:, headers:, input_schema:, method_:, name:, query_params:, url:)
    #   Some parameter documentations has been truncated, see
    #   {Revox::Models::CallCreateParams::Assistant::CustomTool} for more details.
    #
    #   @param body_template [String, nil] JSON body template for the request. Use quoted {{variable}} placeholders (e.g. "
    #
    #   @param description [String] Human-readable description of what the tool does, used by the LLM to decide when
    #
    #   @param headers [Array<Revox::Models::CallCreateParams::Assistant::CustomTool::Header>] HTTP headers to include in the request. Values support {{variable}} placeholders
    #
    #   @param input_schema [Array<Revox::Models::CallCreateParams::Assistant::CustomTool::InputSchema>] Schema defining the parameters the LLM should extract from the conversation to p
    #
    #   @param method_ [Symbol, Revox::Models::CallCreateParams::Assistant::CustomTool::Method] HTTP method to use when calling the API endpoint
    #
    #   @param name [String] Unique tool name in lowercase_snake_case (e.g. check_inventory)
    #
    #   @param query_params [Array<Revox::Models::CallCreateParams::Assistant::CustomTool::QueryParam>] Query string parameters appended to the URL. Values support {{variable}} placeho
    #
    #   @param url [String] Full URL of the API endpoint. Supports {{variable}} placeholders for dynamic val

    class Header < Revox::Internal::Type::BaseModel
      # @!attribute key
      #
      #   @return [String]
      required :key, String

      # @!attribute value
      #
      #   @return [String]
      required :value, String

      # @!method initialize(key:, value:)
      #   @param key [String]
      #   @param value [String]
    end

    class InputSchema < Revox::Internal::Type::BaseModel
      # @!attribute name
      #
      #   @return [String]
      required :name, String

      # @!attribute required
      #
      #   @return [Boolean]
      required :required, Revox::Internal::Type::Boolean

      # @!attribute type
      #
      #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::CustomTool::InputSchema::Type]
      required :type, enum: -> { Revox::CallCreateParams::Assistant::CustomTool::InputSchema::Type }

      # @!attribute description
      #
      #   @return [String, nil]
      optional :description, String

      # @!attribute enum_options
      #
      #   @return [Array<String>, nil]
      optional :enum_options, Revox::Internal::Type::ArrayOf[String]

      # @!method initialize(name:, required:, type:, description: nil, enum_options: nil)
      #   @param name [String]
      #   @param required [Boolean]
      #   @param type [Symbol, Revox::Models::CallCreateParams::Assistant::CustomTool::InputSchema::Type]
      #   @param description [String]
      #   @param enum_options [Array<String>]

      # @see Revox::Models::CallCreateParams::Assistant::CustomTool::InputSchema#type
      module Type
        extend Revox::Internal::Type::Enum

        STRING = :string
        NUMBER = :number
        BOOLEAN = :boolean
        ENUM = :enum
        DATE = :date
        DATETIME = :datetime

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    # HTTP method to use when calling the API endpoint
    #
    # @see Revox::Models::CallCreateParams::Assistant::CustomTool#method_
    module Method
      extend Revox::Internal::Type::Enum

      GET = :GET
      POST = :POST
      PUT = :PUT
      PATCH = :PATCH
      DELETE = :DELETE

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    class QueryParam < Revox::Internal::Type::BaseModel
      # @!attribute key
      #
      #   @return [String]
      required :key, String

      # @!attribute value
      #
      #   @return [String]
      required :value, String

      # @!method initialize(key:, value:)
      #   @param key [String]
      #   @param value [String]
    end
  end

  # The language used for the notification email content. One of "en" or "fr".
  # Defaults to "en".
  #
  # @see Revox::Models::CallCreateParams::Assistant#email_notification_language
  module EmailNotificationLanguage
    extend Revox::Internal::Type::Enum

    EN = :en
    FR = :fr

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  module EmailNotificationOutcome
    extend Revox::Internal::Type::Enum

    NOT_INTERESTED = :not_interested
    INTERESTED = :interested
    COMPLETED = :completed
    REQUESTED_CALLBACK_LATER = :requested_callback_later
    REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
    DO_NOT_CONTACT = :do_not_contact
    AI_AVERSE = :ai_averse
    NONE = :none

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  class FaqItem < Revox::Internal::Type::BaseModel
    # @!attribute answer
    #
    #   @return [String]
    required :answer, String

    # @!attribute question
    #
    #   @return [String]
    required :question, String

    # @!method initialize(answer:, question:)
    #   @param answer [String]
    #   @param question [String]
  end

  # How the first sentence should be handled. "generated" means the LLM will
  # generate a response based on the first_sentence instruction. "static" means the
  # first_sentence will be spoken exactly as provided. "none" means the agent will
  # not speak first and will wait for the user.
  #
  # @see Revox::Models::CallCreateParams::Assistant#first_sentence_mode
  module FirstSentenceMode
    extend Revox::Internal::Type::Enum

    GENERATED = :generated
    STATIC = :static
    NONE = :none

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # When transfer_phone_number is set: "warm" (AI bridges) or "cold" (SIP REFER;
  # trunk must allow REFER/PSTN). Omit or null when transfer is disabled.
  #
  # @see Revox::Models::CallCreateParams::Assistant#human_transfer_mode
  module HumanTransferMode
    extend Revox::Internal::Type::Enum

    WARM = :warm
    COLD = :cold

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Revox::Models::CallCreateParams::Assistant#llm_model
  module LlmModel
    extend Revox::Internal::Type::Union

    variant -> { Revox::CallCreateParams::Assistant::LlmModel::UnionMember0 }

    variant -> { Revox::CallCreateParams::Assistant::LlmModel::UnionMember1 }

    variant -> { Revox::CallCreateParams::Assistant::LlmModel::UnionMember2 }

    variant -> { Revox::CallCreateParams::Assistant::LlmModel::UnionMember3 }

    class UnionMember0 < Revox::Internal::Type::BaseModel
      # @!attribute name
      #
      #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0::Name]
      required :name, enum: -> { Revox::CallCreateParams::Assistant::LlmModel::UnionMember0::Name }

      # @!attribute type
      #
      #   @return [Symbol, :"dedicated-instance"]
      required :type, const: :"dedicated-instance"

      # @!method initialize(name:, type: :"dedicated-instance")
      #   @param name [Symbol, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0::Name]
      #   @param type [Symbol, :"dedicated-instance"]

      # @see Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0#name
      module Name
        extend Revox::Internal::Type::Enum

        GPT_4_1 = :"gpt-4.1"
        MINISTRAL_3_8B_INSTRUCT = :"ministral-3-8b-instruct"

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class UnionMember1 < Revox::Internal::Type::BaseModel
      # @!attribute openrouter_model_id
      #   The model ID to use from OpenRouter. eg: openai/gpt-4.1
      #
      #   @return [String]
      required :openrouter_model_id, String

      # @!attribute openrouter_provider
      #   The provider to use from OpenRouter. eg: nebius, openai, azure, etc.
      #
      #   @return [String]
      required :openrouter_provider, String

      # @!attribute type
      #   Use a model from OpenRouter.
      #
      #   @return [Symbol, :openrouter]
      required :type, const: :openrouter

      # @!method initialize(openrouter_model_id:, openrouter_provider:, type: :openrouter)
      #   @param openrouter_model_id [String] The model ID to use from OpenRouter. eg: openai/gpt-4.1
      #
      #   @param openrouter_provider [String] The provider to use from OpenRouter. eg: nebius, openai, azure, etc.
      #
      #   @param type [Symbol, :openrouter] Use a model from OpenRouter.
    end

    class UnionMember2 < Revox::Internal::Type::BaseModel
      # @!attribute api_key
      #   API key sent as Bearer token to the custom endpoint.
      #
      #   @return [String]
      required :api_key, String

      # @!attribute api_url
      #   Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1
      #
      #   @return [String]
      required :api_url, String

      # @!attribute model_name
      #   Model name as expected by the provider, e.g. meta-llama/llama-3-70b
      #
      #   @return [String]
      required :model_name, String

      # @!attribute type
      #   OpenAI-compatible chat completions API (bring your own endpoint and key).
      #
      #   @return [Symbol, :custom]
      required :type, const: :custom

      # @!method initialize(api_key:, api_url:, model_name:, type: :custom)
      #   @param api_key [String] API key sent as Bearer token to the custom endpoint.
      #
      #   @param api_url [String] Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1
      #
      #   @param model_name [String] Model name as expected by the provider, e.g. meta-llama/llama-3-70b
      #
      #   @param type [Symbol, :custom] OpenAI-compatible chat completions API (bring your own endpoint and key).
    end

    class UnionMember3 < Revox::Internal::Type::BaseModel
      # @!attribute provider
      #   The provider to use from Realtime. eg: openai, google.
      #
      #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember3::Provider]
      required :provider, enum: -> { Revox::CallCreateParams::Assistant::LlmModel::UnionMember3::Provider }

      # @!attribute realtime_model_id
      #   The model ID to use from Realtime. eg: gpt-4.1
      #
      #   @return [String]
      required :realtime_model_id, String

      # @!attribute type
      #   Use a model from Realtime.
      #
      #   @return [Symbol, :realtime]
      required :type, const: :realtime

      # @!attribute realtime_voice_id
      #   Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).
      #
      #   @return [String, nil]
      optional :realtime_voice_id, String

      # @!method initialize(provider:, realtime_model_id:, realtime_voice_id: nil, type: :realtime)
      #   @param provider [Symbol, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember3::Provider] The provider to use from Realtime. eg: openai, google.
      #
      #   @param realtime_model_id [String] The model ID to use from Realtime. eg: gpt-4.1
      #
      #   @param realtime_voice_id [String] Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).
      #
      #   @param type [Symbol, :realtime] Use a model from Realtime.

      # The provider to use from Realtime. eg: openai, google.
      #
      # @see Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember3#provider
      module Provider
        extend Revox::Internal::Type::Enum

        OPENAI = :openai
        GOOGLE = :google

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    # @!method self.variants
    #   @return [Array(Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember1, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember2, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember3)]
  end

  # @see Revox::Models::CallCreateParams::Assistant#position
  class Position < Revox::Internal::Type::BaseModel
    # @!attribute x
    #
    #   @return [Float]
    required :x, Float

    # @!attribute y_
    #
    #   @return [Float]
    required :y_, Float, api_name: :y

    # @!method initialize(x:, y_:)
    #   Canvas position of this assistant's node in its multi-step flow editor.
    #
    #   @param x [Float]
    #   @param y_ [Float]
  end

  # @see Revox::Models::CallCreateParams::Assistant#prompt_flow
  class PromptFlow < Revox::Internal::Type::BaseModel
    # @!attribute edges
    #
    #   @return [Array<Revox::Models::CallCreateParams::Assistant::PromptFlow::Edge>]
    required :edges,
             -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::PromptFlow::Edge] }

    # @!attribute nodes
    #
    #   @return [Array<Revox::Models::CallCreateParams::Assistant::PromptFlow::Node>]
    required :nodes,
             -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::PromptFlow::Node] }

    # @!method initialize(edges:, nodes:)
    #   Visual prompt constructor data (nodes, edges, positions). Used by the UI to
    #   re-open the visual editor. Does not affect call behavior — the flattened prompt
    #   field is what the LLM receives.
    #
    #   @param edges [Array<Revox::Models::CallCreateParams::Assistant::PromptFlow::Edge>]
    #   @param nodes [Array<Revox::Models::CallCreateParams::Assistant::PromptFlow::Node>]

    class Edge < Revox::Internal::Type::BaseModel
      # @!attribute id
      #
      #   @return [String]
      required :id, String

      # @!attribute source
      #
      #   @return [String]
      required :source, String

      # @!attribute target
      #
      #   @return [String]
      required :target, String

      # @!method initialize(id:, source:, target:)
      #   @param id [String]
      #   @param source [String]
      #   @param target [String]
    end

    class Node < Revox::Internal::Type::BaseModel
      # @!attribute id
      #
      #   @return [String]
      required :id, String

      # @!attribute data
      #
      #   @return [Revox::Models::CallCreateParams::Assistant::PromptFlow::Node::Data]
      required :data, -> { Revox::CallCreateParams::Assistant::PromptFlow::Node::Data }

      # @!attribute position
      #
      #   @return [Revox::Models::CallCreateParams::Assistant::PromptFlow::Node::Position]
      required :position, -> { Revox::CallCreateParams::Assistant::PromptFlow::Node::Position }

      # @!attribute type
      #
      #   @return [Symbol, :promptBlock]
      required :type, const: :promptBlock

      # @!method initialize(id:, data:, position:, type: :promptBlock)
      #   @param id [String]
      #   @param data [Revox::Models::CallCreateParams::Assistant::PromptFlow::Node::Data]
      #   @param position [Revox::Models::CallCreateParams::Assistant::PromptFlow::Node::Position]
      #   @param type [Symbol, :promptBlock]

      # @see Revox::Models::CallCreateParams::Assistant::PromptFlow::Node#data
      class Data < Revox::Internal::Type::BaseModel
        # @!attribute body
        #
        #   @return [String]
        required :body, String

        # @!attribute title
        #
        #   @return [String]
        required :title, String

        # @!method initialize(body:, title:)
        #   @param body [String]
        #   @param title [String]
      end

      # @see Revox::Models::CallCreateParams::Assistant::PromptFlow::Node#position
      class Position < Revox::Internal::Type::BaseModel
        # @!attribute x
        #
        #   @return [Float]
        required :x, Float

        # @!attribute y_
        #
        #   @return [Float]
        required :y_, Float, api_name: :y

        # @!method initialize(x:, y_:)
        #   @param x [Float]
        #   @param y_ [Float]
      end
    end
  end

  # @see Revox::Models::CallCreateParams::Assistant#slack
  class Slack < Revox::Internal::Type::BaseModel
    # @!attribute channel_id
    #   The Slack channel ID where the notification will be posted.
    #
    #   @return [String]
    required :channel_id, String

    # @!attribute connection_id
    #   The Nango connection ID linking the org's Slack workspace to Revox.
    #
    #   @return [String]
    required :connection_id, String

    # @!attribute outcomes
    #   Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']).
    #   Use 'none' to notify when outcome is null.
    #
    #   @return [Array<Symbol, Revox::Models::CallCreateParams::Assistant::Slack::Outcome>]
    required :outcomes,
             -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallCreateParams::Assistant::Slack::Outcome] }

    # @!attribute channel_name
    #   Human-readable Slack channel name, cached for display in the UI.
    #
    #   @return [String, nil]
    optional :channel_name, String, nil?: true

    # @!attribute template
    #   Optional message template. Supports {{summary}}, {{outcome}}, {{phone}},
    #   {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}},
    #   {{last_name}}, {{email}}, {{company}}, {{contact_name}}, {{contact_line}}, plus
    #   prompt_variables and structured_output keys. When null/empty a default template
    #   is used.
    #
    #   @return [String, nil]
    optional :template, String, nil?: true

    # @!method initialize(channel_id:, connection_id:, outcomes:, channel_name: nil, template: nil)
    #   Some parameter documentations has been truncated, see
    #   {Revox::Models::CallCreateParams::Assistant::Slack} for more details.
    #
    #   Slack notification config. When set, posts a message to the chosen channel after
    #   a call ends with one of the configured outcomes.
    #
    #   @param channel_id [String] The Slack channel ID where the notification will be posted.
    #
    #   @param connection_id [String] The Nango connection ID linking the org's Slack workspace to Revox.
    #
    #   @param outcomes [Array<Symbol, Revox::Models::CallCreateParams::Assistant::Slack::Outcome>] Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']).
    #
    #   @param channel_name [String, nil] Human-readable Slack channel name, cached for display in the UI.
    #
    #   @param template [String, nil] Optional message template. Supports {{summary}}, {{outcome}}, {{phone}},
    #   {{call\_

    module Outcome
      extend Revox::Internal::Type::Enum

      NOT_INTERESTED = :not_interested
      INTERESTED = :interested
      COMPLETED = :completed
      REQUESTED_CALLBACK_LATER = :requested_callback_later
      REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
      DO_NOT_CONTACT = :do_not_contact
      AI_AVERSE = :ai_averse
      NONE = :none

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  class StructuredOutputConfig < Revox::Internal::Type::BaseModel
    # @!attribute name
    #
    #   @return [String]
    required :name, String

    # @!attribute required
    #
    #   @return [Boolean]
    required :required, Revox::Internal::Type::Boolean

    # @!attribute type
    #
    #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::StructuredOutputConfig::Type]
    required :type, enum: -> { Revox::CallCreateParams::Assistant::StructuredOutputConfig::Type }

    # @!attribute description
    #
    #   @return [String, nil]
    optional :description, String

    # @!attribute enum_options
    #
    #   @return [Array<String>, nil]
    optional :enum_options, Revox::Internal::Type::ArrayOf[String]

    # @!method initialize(name:, required:, type:, description: nil, enum_options: nil)
    #   @param name [String]
    #   @param required [Boolean]
    #   @param type [Symbol, Revox::Models::CallCreateParams::Assistant::StructuredOutputConfig::Type]
    #   @param description [String]
    #   @param enum_options [Array<String>]

    # @see Revox::Models::CallCreateParams::Assistant::StructuredOutputConfig#type
    module Type
      extend Revox::Internal::Type::Enum

      STRING = :string
      NUMBER = :number
      BOOLEAN = :boolean
      ENUM = :enum
      DATE = :date
      DATETIME = :datetime

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  # @see Revox::Models::CallCreateParams::Assistant#stt_context
  class SttContext < Revox::Internal::Type::BaseModel
    # @!attribute general
    #
    #   @return [Array<Revox::Models::CallCreateParams::Assistant::SttContext::General>]
    required :general,
             -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::SttContext::General] }

    # @!attribute terms
    #
    #   @return [Array<String>]
    required :terms, Revox::Internal::Type::ArrayOf[String]

    # @!method initialize(general:, terms:)
    #   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.
    #
    #   @param general [Array<Revox::Models::CallCreateParams::Assistant::SttContext::General>]
    #   @param terms [Array<String>]

    class General < Revox::Internal::Type::BaseModel
      # @!attribute key
      #
      #   @return [String]
      required :key, String

      # @!attribute value
      #
      #   @return [String]
      required :value, String

      # @!method initialize(key:, value:)
      #   @param key [String]
      #   @param value [String]
    end
  end

  # Transcriber (speech-to-text) model. Defaults to the newest Soniox realtime model
  # when omitted.
  #
  # @see Revox::Models::CallCreateParams::Assistant#stt_model
  module SttModel
    extend Revox::Internal::Type::Enum

    STT_RT_V4 = :"stt-rt-v4"
    STT_RT_V5 = :"stt-rt-v5"

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # Audio clip to play while the agent is processing a response. One of the built-in
  # LiveKit audio clips; null/omitted disables it.
  #
  # @see Revox::Models::CallCreateParams::Assistant#thinking_sound
  module ThinkingSound
    extend Revox::Internal::Type::Enum

    CITY_AMBIENCE_OGG = :"city-ambience.ogg"
    FOREST_AMBIENCE_OGG = :"forest-ambience.ogg"
    OFFICE_AMBIENCE_OGG = :"office-ambience.ogg"
    CROWDED_ROOM_OGG = :"crowded-room.ogg"
    KEYBOARD_TYPING_OGG = :"keyboard-typing.ogg"
    KEYBOARD_TYPING2_OGG = :"keyboard-typing2.ogg"
    HOLD_MUSIC_OGG = :"hold_music.ogg"

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step'
  # orchestrates a flow of sub-assistants, 'sub-assistant' is a step inside a
  # multi-step flow (hidden from the assistants list). Flow transitions are managed
  # via the /assistants/:id/edges endpoints, not on the assistant itself.
  #
  # @see Revox::Models::CallCreateParams::Assistant#type
  module Type
    extend Revox::Internal::Type::Enum

    STANDALONE = :standalone
    MULTI_STEP = :"multi-step"
    SUB_ASSISTANT = :"sub-assistant"

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Revox::Models::CallCreateParams::Assistant#voice
  class Voice < Revox::Internal::Type::BaseModel
    # @!attribute id
    #   The ID of the voice.
    #
    #   @return [String]
    required :id, String

    # @!attribute provider
    #   The provider of the voice.
    #
    #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::Voice::Provider]
    required :provider, enum: -> { Revox::CallCreateParams::Assistant::Voice::Provider }

    # @!attribute model
    #   Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored
    #   for other providers.
    #
    #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::Voice::Model, nil]
    optional :model, enum: -> { Revox::CallCreateParams::Assistant::Voice::Model }

    # @!attribute speed
    #   The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs
    #   0.7–1.2. Default is 1.0.
    #
    #   @return [Float, nil]
    optional :speed, Float

    # @!attribute volume
    #   Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other
    #   providers.
    #
    #   @return [Float, nil]
    optional :volume, Float

    # @!method initialize(id:, provider:, model: nil, speed: nil, volume: nil)
    #   Some parameter documentations has been truncated, see
    #   {Revox::Models::CallCreateParams::Assistant::Voice} for more details.
    #
    #   The voice to use for the call. You can get the list of voices using the /voices
    #   endpoint
    #
    #   @param id [String] The ID of the voice.
    #
    #   @param provider [Symbol, Revox::Models::CallCreateParams::Assistant::Voice::Provider] The provider of the voice.
    #
    #   @param model [Symbol, Revox::Models::CallCreateParams::Assistant::Voice::Model] Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored fo
    #
    #   @param speed [Float] The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs
    #
    #   @param volume [Float] Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other pro

    # The provider of the voice.
    #
    # @see Revox::Models::CallCreateParams::Assistant::Voice#provider
    module Provider
      extend Revox::Internal::Type::Enum

      CARTESIA = :cartesia
      ELEVENLABS = :elevenlabs

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    # Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored
    # for other providers.
    #
    # @see Revox::Models::CallCreateParams::Assistant::Voice#model
    module Model
      extend Revox::Internal::Type::Enum

      SONIC_3 = :"sonic-3"
      SONIC_3_5 = :"sonic-3.5"

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  # @see Revox::Models::CallCreateParams::Assistant#zoho
  class Zoho < Revox::Internal::Type::BaseModel
    # @!attribute connection_id
    #   The Nango connection ID linking the org's Zoho CRM account to Revox.
    #
    #   @return [String]
    required :connection_id, String

    # @!attribute field_mapping
    #   Maps extracted call fields (structured_output / prompt variables) onto Zoho
    #   field API names on the upserted record.
    #
    #   @return [Array<Revox::Models::CallCreateParams::Assistant::Zoho::FieldMapping>]
    required :field_mapping,
             -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::Zoho::FieldMapping] }

    # @!attribute log_call_activity
    #   When true, also log the call as a record in Zoho's Calls module (related to the
    #   upserted prospect via Who_Id).
    #
    #   @return [Boolean]
    required :log_call_activity, Revox::Internal::Type::Boolean

    # @!attribute module_
    #   Zoho module the prospect record is upserted into (e.g. 'Leads' or 'Contacts').
    #
    #   @return [String]
    required :module_, String, api_name: :module

    # @!attribute outcomes
    #   Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use
    #   'none' to push when outcome is null.
    #
    #   @return [Array<Symbol, Revox::Models::CallCreateParams::Assistant::Zoho::Outcome>]
    required :outcomes,
             -> { Revox::Internal::Type::ArrayOf[enum: Revox::CallCreateParams::Assistant::Zoho::Outcome] }

    # @!attribute template
    #   Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}},
    #   {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus
    #   prompt_variables and structured_output keys. When null/empty a default note
    #   (outcome + summary + auto-listed extracted fields) is used.
    #
    #   @return [String, nil]
    optional :template, String, nil?: true

    # @!method initialize(connection_id:, field_mapping:, log_call_activity:, module_:, outcomes:, template: nil)
    #   Some parameter documentations has been truncated, see
    #   {Revox::Models::CallCreateParams::Assistant::Zoho} for more details.
    #
    #   Zoho CRM integration config. When set, upserts the prospect (keyed on phone)
    #   into the chosen module and attaches a Note with the call summary after a call
    #   ends with one of the configured outcomes.
    #
    #   @param connection_id [String] The Nango connection ID linking the org's Zoho CRM account to Revox.
    #
    #   @param field_mapping [Array<Revox::Models::CallCreateParams::Assistant::Zoho::FieldMapping>] Maps extracted call fields (structured_output / prompt variables) onto Zoho fiel
    #
    #   @param log_call_activity [Boolean] When true, also log the call as a record in Zoho's Calls module (related to the
    #
    #   @param module_ [String] Zoho module the prospect record is upserted into (e.g. 'Leads' or 'Contacts').
    #
    #   @param outcomes [Array<Symbol, Revox::Models::CallCreateParams::Assistant::Zoho::Outcome>] Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use 'no
    #
    #   @param template [String, nil] Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{cal

    class FieldMapping < Revox::Internal::Type::BaseModel
      # @!attribute source
      #   Source key to read from the call: a structured_output field name, falling back
      #   to a prompt variable of the same name.
      #
      #   @return [String]
      required :source, String

      # @!attribute zoho_field
      #   Destination Zoho field API name on the upserted record (e.g. 'Email', 'Company',
      #   or a custom 'Budget\_\_c').
      #
      #   @return [String]
      required :zoho_field, String

      # @!method initialize(source:, zoho_field:)
      #   Some parameter documentations has been truncated, see
      #   {Revox::Models::CallCreateParams::Assistant::Zoho::FieldMapping} for more
      #   details.
      #
      #   @param source [String] Source key to read from the call: a structured_output field name, falling back t
      #
      #   @param zoho_field [String] Destination Zoho field API name on the upserted record (e.g. 'Email', 'Company',
    end

    module Outcome
      extend Revox::Internal::Type::Enum

      NOT_INTERESTED = :not_interested
      INTERESTED = :interested
      COMPLETED = :completed
      REQUESTED_CALLBACK_LATER = :requested_callback_later
      REQUESTED_CALLBACK_NEW_NUMBER = :requested_callback_new_number
      DO_NOT_CONTACT = :do_not_contact
      AI_AVERSE = :ai_averse
      NONE = :none

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end
end

Instance Attribute Details

#after_call_sms_outcomes ⇒ Array<Symbol, Revox::Models::CallCreateParams::Assistant::AfterCallSMSOutcome>^?

Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. E.g. ["interested", "completed", "none"]. Use "none" when outcome is null.

Parameters:

• value (::Array[Revox::Models::CallCreateParams::Assistant::after_call_sms_outcome], nil)

Returns:

• (Array<Symbol, Revox::Models::CallCreateParams::Assistant::AfterCallSMSOutcome>, nil)

# File 'lib/revox/models/call_create_params.rb', line 106

optional :after_call_sms_outcomes,
-> {
  Revox::Internal::Type::ArrayOf[enum: Revox::CallCreateParams::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)

# File 'lib/revox/models/call_create_params.rb', line 117

optional :after_call_sms_prompt, String, nil?: true

#background_sound ⇒ Symbol, ...

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

Parameters:

• value (Revox::Models::CallCreateParams::Assistant::background_sound, nil)

Returns:

• (Symbol, Revox::Models::CallCreateParams::Assistant::BackgroundSound, nil)

# File 'lib/revox/models/call_create_params.rb', line 123

optional :background_sound,
enum: -> {
  Revox::CallCreateParams::Assistant::BackgroundSound
},
nil?: true

#background_sound_volume ⇒ Float^?

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

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/revox/models/call_create_params.rb', line 133

optional :background_sound_volume, Float

#calendly ⇒ Revox::Models::CallCreateParams::Assistant::Calendly^?

Parameters:

• value (Revox::CallCreateParams::Assistant::Calendly, nil)

Returns:

• (Revox::Models::CallCreateParams::Assistant::Calendly, nil)

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

optional :calendly, -> { Revox::CallCreateParams::Assistant::Calendly }, nil?: true

#call_retry_config ⇒ Revox::Models::CallCreateParams::Assistant::CallRetryConfig^?

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

Returns:

• (Revox::Models::CallCreateParams::Assistant::CallRetryConfig, nil)

# File 'lib/revox/models/call_create_params.rb', line 145

optional :call_retry_config, -> { Revox::CallCreateParams::Assistant::CallRetryConfig }

#cartesia_dictionary_pronunciation_id ⇒ String^?

Optional Cartesia pronunciation dictionary ID to use for this assistant's calls. Set null to unlink it.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/revox/models/call_create_params.rb', line 152

optional :cartesia_dictionary_pronunciation_id, String, nil?: true

#custom_tools ⇒ Array<Revox::Models::CallCreateParams::Assistant::CustomTool>^?

Custom API tools the assistant can call during conversations. Each tool defines an HTTP endpoint with variable substitution.

Parameters:

• value (::Array[Revox::CallCreateParams::Assistant::CustomTool], nil)

Returns:

• (Array<Revox::Models::CallCreateParams::Assistant::CustomTool>, nil)

# File 'lib/revox/models/call_create_params.rb', line 159

optional :custom_tools,
-> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::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)

# File 'lib/revox/models/call_create_params.rb', line 169

optional :email_notification_address, String, nil?: true

#email_notification_language ⇒ Symbol, ...

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

Returns:

• (Symbol, Revox::Models::CallCreateParams::Assistant::EmailNotificationLanguage, nil)

# File 'lib/revox/models/call_create_params.rb', line 176

optional :email_notification_language,
enum: -> { Revox::CallCreateParams::Assistant::EmailNotificationLanguage }

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

Returns:

• (Array<Symbol, Revox::Models::CallCreateParams::Assistant::EmailNotificationOutcome>, nil)

# File 'lib/revox/models/call_create_params.rb', line 184

optional :email_notification_outcomes,
-> {
  Revox::Internal::Type::ArrayOf[enum: Revox::CallCreateParams::Assistant::EmailNotificationOutcome]
},
nil?: true

#end_of_call_sentence ⇒ String^?

Optional message to say when the agent decides to end the call.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/revox/models/call_create_params.rb', line 194

optional :end_of_call_sentence, String

#faq_items ⇒ Array<Revox::Models::CallCreateParams::Assistant::FaqItem>^?

FAQ items to associate with this assistant. When provided, replaces all existing FAQ items.

Returns:

• (Array<Revox::Models::CallCreateParams::Assistant::FaqItem>, nil)

# File 'lib/revox/models/call_create_params.rb', line 201

optional :faq_items, -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::FaqItem] }

#first_sentence ⇒ String^?

The first sentence to use for the call. This will be given to the LLM

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/revox/models/call_create_params.rb', line 207

optional :first_sentence, String

#first_sentence_delay_ms ⇒ Integer^?

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

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/revox/models/call_create_params.rb', line 213

optional :first_sentence_delay_ms, Integer

#first_sentence_mode ⇒ Symbol, ...

How the first sentence should be handled. "generated" means the LLM will generate a response based on the first_sentence instruction. "static" means the first_sentence will be spoken exactly as provided. "none" means the agent will not speak first and will wait for the user.

Returns:

• (Symbol, Revox::Models::CallCreateParams::Assistant::FirstSentenceMode, nil)

# File 'lib/revox/models/call_create_params.rb', line 222

optional :first_sentence_mode, enum: -> { Revox::CallCreateParams::Assistant::FirstSentenceMode }

#from_phone_number ⇒ String^?

Override the default outbound phone number for calls placed with this assistant. Must be a phone number owned by the organization in E.164 format (e.g. +1234567890). When null, the organization's default phone number is used.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/revox/models/call_create_params.rb', line 230

optional :from_phone_number, String, nil?: true

#human_transfer_mode ⇒ Symbol, ...

When transfer_phone_number is set: "warm" (AI bridges) or "cold" (SIP REFER; trunk must allow REFER/PSTN). Omit or null when transfer is disabled.

Parameters:

• value (Revox::Models::CallCreateParams::Assistant::human_transfer_mode, nil)

Returns:

• (Symbol, Revox::Models::CallCreateParams::Assistant::HumanTransferMode, nil)

# File 'lib/revox/models/call_create_params.rb', line 237

optional :human_transfer_mode,
enum: -> { Revox::CallCreateParams::Assistant::HumanTransferMode },
nil?: true

#ivr_navigation_enabled ⇒ Boolean^?

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

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/revox/models/call_create_params.rb', line 246

optional :ivr_navigation_enabled, Revox::Internal::Type::Boolean

#llm_model ⇒ Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0, ...

Returns:

• (Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember1, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember2, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember3, nil)

# File 'lib/revox/models/call_create_params.rb', line 251

optional :llm_model, union: -> { Revox::CallCreateParams::Assistant::LlmModel }

#logo_url ⇒ String^?

Public URL of the brand logo shown on the assistant's demo page. Upload a new logo via POST /assistants/:id/logo. Set explicitly to null to clear it.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/revox/models/call_create_params.rb', line 258

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

• (Float)

Returns:

• (Float, nil)

# File 'lib/revox/models/call_create_params.rb', line 265

optional :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 not set, the call ends silently.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/revox/models/call_create_params.rb', line 273

optional :max_duration_end_message, String, nil?: true

#position ⇒ Revox::Models::CallCreateParams::Assistant::Position^?

Canvas position of this assistant's node in its multi-step flow editor.

Parameters:

• value (Revox::CallCreateParams::Assistant::Position, nil)

Returns:

• (Revox::Models::CallCreateParams::Assistant::Position, nil)

# File 'lib/revox/models/call_create_params.rb', line 279

optional :position, -> { Revox::CallCreateParams::Assistant::Position }, nil?: true

#prompt ⇒ String

The prompt to use for the call. This will be given to the LLM (gpt-4.1)

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/revox/models/call_create_params.rb', line 98

required :prompt, String

#prompt_flow ⇒ Revox::Models::CallCreateParams::Assistant::PromptFlow^?

Visual prompt constructor data (nodes, edges, positions). Used by the UI to re-open the visual editor. Does not affect call behavior — the flattened prompt field is what the LLM receives.

Parameters:

• value (Revox::CallCreateParams::Assistant::PromptFlow, nil)

Returns:

• (Revox::Models::CallCreateParams::Assistant::PromptFlow, nil)

# File 'lib/revox/models/call_create_params.rb', line 287

optional :prompt_flow, -> { Revox::CallCreateParams::Assistant::PromptFlow }, nil?: true

#slack ⇒ Revox::Models::CallCreateParams::Assistant::Slack^?

Slack notification config. When set, posts a message to the chosen channel after a call ends with one of the configured outcomes.

Parameters:

• value (Revox::CallCreateParams::Assistant::Slack, nil)

Returns:

• (Revox::Models::CallCreateParams::Assistant::Slack, nil)

# File 'lib/revox/models/call_create_params.rb', line 294

optional :slack, -> { Revox::CallCreateParams::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:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/revox/models/call_create_params.rb', line 301

optional :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)

# File 'lib/revox/models/call_create_params.rb', line 309

optional :sms_template, String, nil?: true

#structured_output_config ⇒ Array<Revox::Models::CallCreateParams::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.).

Returns:

• (Array<Revox::Models::CallCreateParams::Assistant::StructuredOutputConfig>, nil)

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

optional :structured_output_config,
-> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::StructuredOutputConfig] }

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

# File 'lib/revox/models/call_create_params.rb', line 325

optional :structured_output_prompt, String, nil?: true

#stt_context ⇒ Revox::Models::CallCreateParams::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:

• value (Revox::CallCreateParams::Assistant::SttContext, nil)

Returns:

• (Revox::Models::CallCreateParams::Assistant::SttContext, nil)

# File 'lib/revox/models/call_create_params.rb', line 333

optional :stt_context, -> { Revox::CallCreateParams::Assistant::SttContext }, nil?: true

#stt_model ⇒ Symbol, ...

Transcriber (speech-to-text) model. Defaults to the newest Soniox realtime model when omitted.

Returns:

• (Symbol, Revox::Models::CallCreateParams::Assistant::SttModel, nil)

# File 'lib/revox/models/call_create_params.rb', line 340

optional :stt_model, enum: -> { Revox::CallCreateParams::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/omitted disables it.

Parameters:

• value (Revox::Models::CallCreateParams::Assistant::thinking_sound, nil)

Returns:

• (Symbol, Revox::Models::CallCreateParams::Assistant::ThinkingSound, nil)

# File 'lib/revox/models/call_create_params.rb', line 347

optional :thinking_sound, enum: -> { Revox::CallCreateParams::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:

• (Float)

Returns:

• (Float, nil)

# File 'lib/revox/models/call_create_params.rb', line 354

optional :thinking_sound_probability, Float

#thinking_sound_volume ⇒ Float^?

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

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/revox/models/call_create_params.rb', line 360

optional :thinking_sound_volume, Float

#transfer_phone_number ⇒ String^?

Phone number to transfer calls to when users request to speak to a human agent in E.164 format (e.g. +1234567890).

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :transfer_phone_number, String, nil?: true

#type ⇒ Symbol, ...

Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step' orchestrates a flow of sub-assistants, 'sub-assistant' is a step inside a multi-step flow (hidden from the assistants list). Flow transitions are managed via the /assistants/:id/edges endpoints, not on the assistant itself.

Returns:

• (Symbol, Revox::Models::CallCreateParams::Assistant::Type, nil)

# File 'lib/revox/models/call_create_params.rb', line 376

optional :type, enum: -> { Revox::CallCreateParams::Assistant::Type }

#voice ⇒ Revox::Models::CallCreateParams::Assistant::Voice^?

The voice to use for the call. You can get the list of voices using the /voices endpoint

Returns:

• (Revox::Models::CallCreateParams::Assistant::Voice, nil)

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

optional :voice, -> { Revox::CallCreateParams::Assistant::Voice }

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

# File 'lib/revox/models/call_create_params.rb', line 390

optional :voicemail_message, String, nil?: true

#voicemail_sms_prompt ⇒ String^?

SMS message to send when the call reaches voicemail. Supports {variable} placeholders. When null, no SMS is sent on voicemail.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/revox/models/call_create_params.rb', line 397

optional :voicemail_sms_prompt, String, nil?: true

#warm_transfer_summary_instructions ⇒ String^?

When using warm transfer: extra instructions for the supervisor handoff summary. If null or empty, the API uses the product default briefing when the call is loaded for the agent.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/revox/models/call_create_params.rb', line 405

optional :warm_transfer_summary_instructions, String, nil?: true

#webhook_url ⇒ String^?

The webhook URL to call when the call is completed.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/revox/models/call_create_params.rb', line 411

optional :webhook_url, String

#zoho ⇒ Revox::Models::CallCreateParams::Assistant::Zoho^?

Zoho CRM integration config. When set, upserts the prospect (keyed on phone) into the chosen module and attaches a Note with the call summary after a call ends with one of the configured outcomes.

Parameters:

• value (Revox::CallCreateParams::Assistant::Zoho, nil)

Returns:

• (Revox::Models::CallCreateParams::Assistant::Zoho, nil)

# File 'lib/revox/models/call_create_params.rb', line 419

optional :zoho, -> { Revox::CallCreateParams::Assistant::Zoho }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/revox/models/call_create_params.rb', line 528

.variants ⇒ Array(Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember1, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember2, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember3)

Returns:

• (Array(Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember1, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember2, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember3))

# File 'lib/revox/models/call_create_params.rb', line 1080

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/revox/models/call_create_params.rbs', line 327

def to_hash: -> {