Class: Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb

Defined Under Namespace

Modules: ConversationMetadata Classes: CallAttempt, CallSettings

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(attempt_number:, attempted_at:, call_status:, call_duration: nil, telnyx_call_control_id: nil) ⇒ Object

One row in ‘call_attempts` — captures the terminal outcome of a single dispatch.

Parameters:

  • attempt_number (Integer)
  • attempted_at (Time)
  • call_status (String) —

    Values: busy, canceled, no-answer, ringing, completed, failed, in-progress

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

    Duration of the call in seconds

  • telnyx_call_control_id (String) (defaults to: nil) 



# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 200

Instance Attribute Details

#assistant_id ⇒ String

Returns:

  • (String) 


11
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 11

required :assistant_id, String

#call_attempts ⇒ Array<Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallAttempt>?

Returns:



36
37
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 36

optional :call_attempts,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::CallAttempt] }

#call_duration ⇒ Integer?

Duration of the call in seconds

Returns:

  • (Integer, nil) 


43
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 43

optional :call_duration, Integer

#call_settings ⇒ Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallSettings?

Per-call telephony overrides applied when a scheduled phone-call event dispatches. Phone-call events only. New per-call dispatch options should be added here rather than as top-level event fields.

Returns:



51
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 51

optional :call_settings, -> { Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::CallSettings }

#call_status ⇒ String?

Values: busy, canceled, no-answer, ringing, completed, failed, in-progress

Returns:

  • (String, nil) 


57
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 57

optional :call_status, String

#conversation_id ⇒ String?

Returns:

  • (String, nil) 


62
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 62

optional :conversation_id, String

#conversation_metadata ⇒ Hash{Symbol=>String, Integer, Boolean}?

Returns:

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


67
68
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 67

optional :conversation_metadata,
-> { Telnyx::Internal::Type::HashOf[union: Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::ConversationMetadata] }

#created_at ⇒ Time?

Returns:

  • (Time, nil) 


73
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 73

optional :created_at, Time

#dispatched_at ⇒ Time?

Date time at which call was sent

Returns:

  • (Time, nil) 


79
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 79

optional :dispatched_at, Time

#dynamic_variables ⇒ Hash{Symbol=>String}?

A map of dynamic variable names to values. These variables can be referenced in the assistant’s instructions and messages using {variable_name} syntax.

Returns:

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


86
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 86

optional :dynamic_variables, Telnyx::Internal::Type::HashOf[String]

#errors ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


91
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 91

optional :errors, Telnyx::Internal::Type::ArrayOf[String]

#max_retries_client_errors ⇒ Integer?

Configure number of retries on client errors: busy, no-answer, failed, canceled (caller hung up before the callee answered)

Returns:

  • (Integer, nil) 


98
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 98

optional :max_retries_client_errors, Integer

#retry_attempts ⇒ Integer?

Returns:

  • (Integer, nil) 


103
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 103

optional :retry_attempts, Integer

#retry_count ⇒ Integer?

Returns:

  • (Integer, nil) 


108
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 108

optional :retry_count, Integer

#retry_interval_secs ⇒ Integer?

Returns:

  • (Integer, nil) 


113
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 113

optional :retry_interval_secs, Integer

#scheduled_at_fixed_datetime ⇒ Time

Returns:

  • (Time) 


16
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 16

required :scheduled_at_fixed_datetime, Time

#scheduled_event_id ⇒ String?

Returns:

  • (String, nil) 


118
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 118

optional :scheduled_event_id, String

#status ⇒ Symbol, ...

Returns:



123
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 123

optional :status, enum: -> { Telnyx::AI::Assistants::EventStatus }

#telnyx_agent_target ⇒ String

Returns:

  • (String) 


21
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 21

required :telnyx_agent_target, String

#telnyx_conversation_channel ⇒ Symbol, Telnyx::Models::AI::Assistants::ConversationChannelType

Returns:



26
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 26

required :telnyx_conversation_channel, enum: -> { Telnyx::AI::Assistants::ConversationChannelType }

#telnyx_end_user_target ⇒ String

Returns:

  • (String) 


31
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 31

required :telnyx_end_user_target, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 250