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

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

Instance Attribute 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(assistant_id:, scheduled_at_fixed_datetime:, telnyx_agent_target:, telnyx_conversation_channel:, telnyx_end_user_target:, call_attempts: nil, call_duration: nil, call_settings: nil, call_status: nil, conversation_id: nil, conversation_metadata: nil, created_at: nil, dispatched_at: nil, dynamic_variables: nil, errors: nil, max_retries_client_errors: nil, retry_attempts: nil, retry_count: nil, retry_interval_secs: nil, scheduled_event_id: nil, status: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse for more details.

Parameters:

  • assistant_id (String)
  • scheduled_at_fixed_datetime (Time)
  • telnyx_agent_target (String)
  • telnyx_conversation_channel (Symbol, Telnyx::Models::AI::Assistants::ConversationChannelType)
  • telnyx_end_user_target (String)
  • call_attempts (Array<Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallAttempt>) (defaults to: nil)
  • call_duration (Integer) (defaults to: nil) —

    Duration of the call in seconds

  • call_settings (Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallSettings) (defaults to: nil) —

    Per-call telephony overrides applied when a scheduled phone-call event

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

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

  • conversation_id (String) (defaults to: nil)
  • conversation_metadata (Hash{Symbol=>String, Integer, Boolean}) (defaults to: nil)
  • created_at (Time) (defaults to: nil)
  • dispatched_at (Time) (defaults to: nil) —

    Date time at which call was sent

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

    A map of dynamic variable names to values. These variables can be referenced in

  • errors (Array<String>) (defaults to: nil)
  • max_retries_client_errors (Integer) (defaults to: nil) —

    Configure number of retries on client errors: busy, no-answer, failed, canceled

  • retry_attempts (Integer) (defaults to: nil)
  • retry_count (Integer) (defaults to: nil)
  • retry_interval_secs (Integer) (defaults to: nil)
  • scheduled_event_id (String) (defaults to: nil)
  • status (Symbol, Telnyx::Models::AI::Assistants::EventStatus) (defaults to: nil) 


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb', line 172

class CallAttempt < Telnyx::Internal::Type::BaseModel
  # @!attribute attempt_number
  #
  #   @return [Integer]
  required :attempt_number, Integer

  # @!attribute attempted_at
  #
  #   @return [Time]
  required :attempted_at, Time

  # @!attribute call_status
  #   Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
  #
  #   @return [String]
  required :call_status, String

  # @!attribute call_duration
  #   Duration of the call in seconds
  #
  #   @return [Integer, nil]
  optional :call_duration, Integer

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

  # @!method initialize(attempt_number:, attempted_at:, call_status:, call_duration: nil, telnyx_call_control_id: nil)
  #   One row in `call_attempts` — captures the terminal outcome of a single dispatch.
  #
  #   @param attempt_number [Integer]
  #
  #   @param attempted_at [Time]
  #
  #   @param call_status [String] Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
  #
  #   @param call_duration [Integer] Duration of the call in seconds
  #
  #   @param telnyx_call_control_id [String]
end

Instance Attribute Details

#attempt_number ⇒ Integer

Returns:

  • (Integer) 


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

required :attempt_number, Integer

#attempted_at ⇒ Time

Returns:

  • (Time) 


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

required :attempted_at, Time

#call_duration ⇒ Integer?

Duration of the call in seconds

Returns:

  • (Integer, nil) 


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

optional :call_duration, Integer

#call_status ⇒ String

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

Returns:

  • (String) 


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

required :call_status, String

#telnyx_call_control_id ⇒ String?

Returns:

  • (String, nil) 


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

optional :telnyx_call_control_id, String