Class: Revox::Models::CallCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/revox/models/call_create_params.rb,
sig/revox/models/call_create_params.rbs

Overview

See Also:

  • Revox::Resources::Call#create

Defined Under Namespace

Modules: ScheduledAt Classes: Assistant, Concurrency

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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:) ⇒ Object

Some parameter documentations has been truncated, see Concurrency for more details.

Limit the number of concurrent calls for a given concurrency key. The limit itself is set server-side; omit this to leave the call ungrouped (bounded only by your organization's limit).

Parameters:

  • key (String) —

    Groups this call with every other call sharing the same key, for concurrency pur




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

Instance Attribute Details

#assistant ⇒ Revox::Models::CallCreateParams::Assistant?

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.

Returns:



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

optional :assistant, -> { Revox::CallCreateParams::Assistant }

#assistant_id ⇒ String?

The ID of the assistant to use for this call.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :assistant_id, String

#concurrency ⇒ Revox::Models::CallCreateParams::Concurrency?

Limit the number of concurrent calls for a given concurrency key. The limit itself is set server-side; omit this to leave the call ungrouped (bounded only by your organization's limit).

Returns:



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

optional :concurrency, -> { Revox::CallCreateParams::Concurrency }

#from_phone_number ⇒ String?

The phone number to use for making the call (e.g., +1234567890). If not provided, uses the default trunk.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :from_phone_number, String

#metadata ⇒ Hash{Symbol=>String}?

Metadata to store with the call.

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


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

optional :metadata, Revox::Internal::Type::HashOf[String]

#phone_number ⇒ String

The phone number to call in the E.164 format. Example: +1234567890

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :phone_number, String

#prompt_variables ⇒ Hash{Symbol=>String}?

Variables to interpolate into the prompt. Wether you use an assistant_id or an assistant object, this will be used to interpolate the variables into the prompt.

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


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

optional :prompt_variables, Revox::Internal::Type::HashOf[String]

#scheduled_at ⇒ Time, ...

Schedule the call to start at a specific date and time (ISO 8601 format). If not provided, the call will start immediately.

Returns:

  • (Time, Object, nil) 


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

optional :scheduled_at, union: -> { Revox::CallCreateParams::ScheduledAt }

#skip_calling_window ⇒ Boolean?

Bypass the calling-window check for this call so it dials even outside the assistant's configured window. Use for immediate 'call now' dials.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :skip_calling_window, Revox::Internal::Type::Boolean

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {