Module: Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::AfterCallSMSOutcome

Extended by:

Internal::Type::Enum

Defined in:

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

Constant Summary

NOT_INTERESTED =

Returns:

• (:not_interested)

:not_interested

INTERESTED =

Returns:

• (:interested)

:interested

COMPLETED =

Returns:

• (:completed)

:completed

REQUESTED_CALLBACK_LATER =

Returns:

• (:requested_callback_later)

:requested_callback_later

REQUESTED_CALLBACK_NEW_NUMBER =

Returns:

• (:requested_callback_new_number)

:requested_callback_new_number

DO_NOT_CONTACT =

Returns:

• (:do_not_contact)

:do_not_contact

AI_AVERSE =

Returns:

• (:ai_averse)

:ai_averse

NONE =

Returns:

• (:none)

:none

Instance Method Summary

• #initialize(id:, after_call_sms_outcomes:, after_call_sms_prompt:, background_sound:, background_sound_volume:, calendly:, call_retry_config:, cartesia_dictionary_pronunciation_id:, created_at:, custom_tools:, email_notification_address:, email_notification_language:, email_notification_outcomes:, end_of_call_sentence:, first_sentence:, first_sentence_delay_ms:, first_sentence_mode:, from_phone_number:, human_transfer_mode:, ivr_navigation_enabled:, llm_model:, logo_url:, max_call_duration_secs:, max_duration_end_message:, name:, organization_id:, position:, prompt:, prompt_flow:, slack:, sms_enabled:, sms_template:, structured_output_config:, structured_output_prompt:, stt_context:, stt_model:, thinking_sound:, thinking_sound_probability:, thinking_sound_volume:, transfer_phone_number:, type:, updated_at:, voice:, voicemail_message:, voicemail_sms_prompt:, warm_transfer_summary_instructions:, webhook_url:, zoho:, created_by: nil, faq_items: nil, is_realestate_assistant: nil, pending_faq_count: nil) ⇒ Object

  Some parameter documentations has been truncated, see Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant for more details.

• #self?.values ⇒ ::Array[Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::after_call_sms_outcome]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(id:, after_call_sms_outcomes:, after_call_sms_prompt:, background_sound:, background_sound_volume:, calendly:, call_retry_config:, cartesia_dictionary_pronunciation_id:, created_at:, custom_tools:, email_notification_address:, email_notification_language:, email_notification_outcomes:, end_of_call_sentence:, first_sentence:, first_sentence_delay_ms:, first_sentence_mode:, from_phone_number:, human_transfer_mode:, ivr_navigation_enabled:, llm_model:, logo_url:, max_call_duration_secs:, max_duration_end_message:, name:, organization_id:, position:, prompt:, prompt_flow:, slack:, sms_enabled:, sms_template:, structured_output_config:, structured_output_prompt:, stt_context:, stt_model:, thinking_sound:, thinking_sound_probability:, thinking_sound_volume:, transfer_phone_number:, type:, updated_at:, voice:, voicemail_message:, voicemail_sms_prompt:, warm_transfer_summary_instructions:, webhook_url:, zoho:, created_by: nil, faq_items: nil, is_realestate_assistant: nil, pending_faq_count: nil) ⇒ Object

Some parameter documentations has been truncated, see Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant for more details.

Parameters:

• id (String)
• after_call_sms_outcomes (Array<Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::AfterCallSMSOutcome>, nil) —

  Which call outcomes trigger the after-call SMS. When empty or null, no after-cal

• after_call_sms_prompt (String, nil) —

  Prompt / instructions for the after-call SMS. Supports {variable} placeholders

• background_sound (Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::BackgroundSound, nil) —

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

• background_sound_volume (Float) —

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

• calendly (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Calendly, nil)
• call_retry_config (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::CallRetryConfig, nil) —

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

• cartesia_dictionary_pronunciation_id (String, nil) —

  Optional Cartesia pronunciation dictionary ID linked to this assistant.

• created_at (Object)
• custom_tools (Array<Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::CustomTool>, nil)
• email_notification_address (String, nil) —

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

• email_notification_language (Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::EmailNotificationLanguage) —

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

• email_notification_outcomes (Array<Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::EmailNotificationOutcome>, nil) —

  Which call outcomes trigger an email notification. E.g. ["interested", "complete

• end_of_call_sentence (String, nil)
• first_sentence (String, nil)
• first_sentence_delay_ms (Integer) —

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

• first_sentence_mode (Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::FirstSentenceMode)
• from_phone_number (String, nil) —

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

• human_transfer_mode (Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::HumanTransferMode, nil) —

  Warm or cold transfer when transfer_phone_number is set; null when transfer is n

• ivr_navigation_enabled (Boolean) —

  Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and

• llm_model (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::LlmModel::UnionMember0, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::LlmModel::UnionMember1, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::LlmModel::UnionMember2, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::LlmModel::UnionMember3)
• logo_url (String, nil) —

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

• max_call_duration_secs (Float) —

  The maximum duration of the call in seconds. This is the maximum time the call w

• max_duration_end_message (String, nil) —

  Optional message the agent will say, without being interruptible, when the call

• name (String)
• organization_id (String)
• position (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Position, nil)
• prompt (String)
• prompt_flow (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::PromptFlow, nil)
• slack (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Slack, nil)
• sms_enabled (Boolean) —

  Enable SMS tool during calls. When enabled, the agent can send SMS messages to t

• sms_template (String, nil) —

  Hardcoded SMS template to send during calls. When set, this exact text is sent i

• structured_output_config (Array<Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::StructuredOutputConfig>, nil) —

  The structured output config to use for the call. This is used to extract the da

• structured_output_prompt (String, nil) —

  Custom prompt for structured data extraction. If not provided, a default prompt

• stt_context (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::SttContext, nil) —

  Assistant-level speech-to-text context: structured general key/value pairs plu

• stt_model (Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::SttModel) —

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

• thinking_sound (Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::ThinkingSound, nil) —

  Audio clip to play while the agent is processing a response. One of the built-in

• thinking_sound_probability (Float) —

  Probability [0..1] that the thinking sound plays on any given turn; otherwise th

• thinking_sound_volume (Float) —

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

• transfer_phone_number (String, nil) —

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

• type (Symbol, Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Type)
• updated_at (Object)
• voice (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Voice, nil)
• voicemail_message (String, nil) —

  If set, when voicemail is detected the agent will speak this message then hang u

• voicemail_sms_prompt (String, nil) —

  Prompt / instructions for the voicemail SMS. Supports {variable} placeholders.

• warm_transfer_summary_instructions (String, nil) —

  Warm transfer only: instructions for the supervisor handoff summary; null when n

• webhook_url (String, nil) —

  The webhook URL to call when the call is completed.

• zoho (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::Zoho, nil)
• created_by (Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::CreatedBy, nil) (defaults to: nil) —

  The user who created the assistant.

• faq_items (Array<Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::FaqItem>) (defaults to: nil)
• is_realestate_assistant (Boolean) (defaults to: nil)
• pending_faq_count (Float) (defaults to: nil)

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

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

#self?.values ⇒ ::Array[Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::after_call_sms_outcome]

Returns:

• (::Array[Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::after_call_sms_outcome])

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

def self?.values: -> ::Array[Revox::Models::CampaignGetRowsResponse::Row::Call::Assistant::after_call_sms_outcome]