Class: Zavudev::Models::CallCreateParams

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

Overview

See Also:

  • Zavudev::Resources::Calls#create

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(to:, greeting: nil, language: nil, max_duration_minutes: nil, metadata: nil, sender_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Zavudev::Models::CallCreateParams for more details.

Parameters:

  • to (String) —

    Recipient phone number in E.164 format.

  • greeting (String) (defaults to: nil) —

    Overrides the agent's configured greeting for this call only.

  • language (String) (defaults to: nil) —

    Language the agent speaks on this call only, as a BCP-47 tag (en, es, `es-ES

  • max_duration_minutes (Integer) (defaults to: nil) —

    Overrides the agent's maximum call duration for this call only.

  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

    Arbitrary metadata to associate with the call. Returned on the call object and i

  • sender_id (String) (defaults to: nil) —

    Sender profile that places the call. Uses the project's default sender if omitte

  • request_options (Zavudev::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/zavudev/models/call_create_params.rb', line 53

Instance Attribute Details

#greeting ⇒ String?

Overrides the agent's configured greeting for this call only.

Parameters:

  • (String)

Returns:

  • (String, nil) 


20
 
# File 'lib/zavudev/models/call_create_params.rb', line 20

optional :greeting, String

#language ⇒ String?

Language the agent speaks on this call only, as a BCP-47 tag (en, es, es-ES, pt-BR), or auto to detect the caller's language and follow it. Overrides the agent's configured language for speech recognition, the agent's replies, and the synthesized voice. If the agent uses a custom voice you supplied, that voice is kept and only the language changes. When omitted, the agent's configured language is used.

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/zavudev/models/call_create_params.rb', line 31

optional :language, String

#max_duration_minutes ⇒ Integer?

Overrides the agent's maximum call duration for this call only.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


37
 
# File 'lib/zavudev/models/call_create_params.rb', line 37

optional :max_duration_minutes, Integer, api_name: :maxDurationMinutes

#metadata ⇒ Hash{Symbol=>String}?

Arbitrary metadata to associate with the call. Returned on the call object and included in voice webhooks.

Parameters:

  • (::Hash[Symbol, String])

Returns:

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


44
 
# File 'lib/zavudev/models/call_create_params.rb', line 44

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

#sender_id ⇒ String?

Sender profile that places the call. Uses the project's default sender if omitted. The sender's agent must have voice enabled.

Parameters:

  • (String)

Returns:

  • (String, nil) 


51
 
# File 'lib/zavudev/models/call_create_params.rb', line 51

optional :sender_id, String, api_name: :senderId

#to ⇒ String

Recipient phone number in E.164 format.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :to, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


50
 
# File 'sig/zavudev/models/call_create_params.rbs', line 50

def to_hash: -> {