Class: Revox::Models::CallRetrieveResponse::Call::CallAttempt

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/revox/models/call_retrieve_response.rb,
sig/revox/models/call_retrieve_response.rbs

Defined Under Namespace

Modules: DialError, EndReason, EndedBy, Result, Status Classes: EmailLog, HandledByUser, PostCallTranscript, SMSLog, SpeechEvent, Transcript

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(id:, created_at:, from_address:, resend_message_id:, subject:, to_emails:) ⇒ Object

Parameters:

  • id (String)
  • created_at (Object) —

    When the email was sent.

  • from_address (String)
  • resend_message_id (String, nil)
  • subject (String)
  • to_emails (Array<String>) 



# File 'lib/revox/models/call_retrieve_response.rb', line 2053

Instance Attribute Details

#answered_at ⇒ Object

The time the call was answered.

Parameters:

  • value (top)

Returns:

  • (Object) 


1905
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1905

required :answered_at, Revox::Internal::Type::Unknown

#assistants_used ⇒ Array<String>?

Assistant node ids entered during this attempt, in traversal order.

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


1978
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1978

optional :assistants_used, Revox::Internal::Type::ArrayOf[String], nil?: true

#dial_error ⇒ Symbol, ...

The SIP error that occurred.

Parameters:

  • value (Revox::Models::CallRetrieveResponse::Call::CallAttempt::dial_error, nil)

Returns:



1911
1912
1913
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1911

required :dial_error,
enum: -> { Revox::Models::CallRetrieveResponse::Call::CallAttempt::DialError },
nil?: true

#email_log ⇒ Array<Revox::Models::CallRetrieveResponse::Call::CallAttempt::EmailLog>?

Notification emails sent in connection with the call, ordered oldest first (from/to addresses, subject, sent time).

Parameters:

Returns:



1985
1986
1987
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1985

optional :email_log,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CallRetrieveResponse::Call::CallAttempt::EmailLog] },
nil?: true

#end_reason ⇒ Symbol, ...

Reason for ending the call when ended_by is 'agent'. E.g. 'tool_end_call', 'voicemail', 'transfer', 'ivr_no_navigate'.

Parameters:

  • value (Revox::Models::CallRetrieveResponse::Call::CallAttempt::end_reason, nil)

Returns:



1994
1995
1996
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1994

optional :end_reason,
enum: -> { Revox::Models::CallRetrieveResponse::Call::CallAttempt::EndReason },
nil?: true

#ended_at ⇒ Object

The time the call ended.

Parameters:

  • value (top)

Returns:

  • (Object) 


1919
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1919

required :ended_at, Revox::Internal::Type::Unknown

#ended_by ⇒ Symbol, ...

Who ended the call: 'agent' (AI agent), 'user' (caller/callee hung up), or 'system' (e.g. max duration limit).

Parameters:

  • value (Revox::Models::CallRetrieveResponse::Call::CallAttempt::ended_by, nil)

Returns:



2003
2004
2005
 
# File 'lib/revox/models/call_retrieve_response.rb', line 2003

optional :ended_by,
enum: -> { Revox::Models::CallRetrieveResponse::Call::CallAttempt::EndedBy },
nil?: true

#handled_by_ai ⇒ Boolean

Whether the AI agent conducted the conversation on this attempt. False for a silent speed-dial probe (whose agent only detects a human) and for attempts that were never answered.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


1927
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1927

required :handled_by_ai, Revox::Internal::Type::Boolean

#handled_by_human ⇒ Boolean

Whether a human operator conducted (part of) this attempt — a jump-in takeover or a speed-dial operator connection (both stamp human_takeover_at).

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


1934
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1934

required :handled_by_human, Revox::Internal::Type::Boolean

#handled_by_user ⇒ Revox::Models::CallRetrieveResponse::Call::CallAttempt::HandledByUser?

The team member responsible for following up on this call.

Parameters:

Returns:



1940
1941
1942
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1940

required :handled_by_user,
-> { Revox::Models::CallRetrieveResponse::Call::CallAttempt::HandledByUser },
nil?: true

#id ⇒ String

The ID of the call attempt.

Parameters:

  • value (String)

Returns:

  • (String) 


1899
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1899

required :id, String

#phone_number ⇒ String

The phone number that was called. Formatted in E.164 format. Example: +1234567890

Parameters:

  • value (String)

Returns:

  • (String) 


1949
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1949

required :phone_number, String

#post_call_transcript ⇒ Array<Revox::Models::CallRetrieveResponse::Call::CallAttempt::PostCallTranscript>?

Higher-quality transcript generated after the call via Soniox async STT. Null until generated or when no recording is available.

Parameters:

Returns:



2012
2013
2014
 
# File 'lib/revox/models/call_retrieve_response.rb', line 2012

optional :post_call_transcript,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CallRetrieveResponse::Call::CallAttempt::PostCallTranscript] },
nil?: true

#recording_url ⇒ String?

The URL of the audio recording of the call.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


1955
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1955

required :recording_url, String, nil?: true

#result ⇒ Symbol, ...

Parameters:

  • value (Revox::Models::CallRetrieveResponse::Call::CallAttempt::result, nil)

Returns:



1960
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1960

required :result, enum: -> { Revox::Models::CallRetrieveResponse::Call::CallAttempt::Result }, nil?: true

#sms_log ⇒ Array<Revox::Models::CallRetrieveResponse::Call::CallAttempt::SMSLog>?

Automatic SMS sent after the call (voicemail and after-call), ordered oldest first. The in-call send_sms is excluded — it already appears in the transcript as a tool call.

Parameters:

Returns:



2022
2023
2024
 
# File 'lib/revox/models/call_retrieve_response.rb', line 2022

optional :sms_log,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CallRetrieveResponse::Call::CallAttempt::SMSLog] },
nil?: true

#speech_events ⇒ Array<Revox::Models::CallRetrieveResponse::Call::CallAttempt::SpeechEvent>?

Per-turn speech segments (VAD-derived) with timing and pipeline latencies, ordered by started_speaking_at_ms. Empty for calls recorded before this was tracked or for realtime sessions that don't emit them.

Parameters:

Returns:



2032
2033
2034
 
# File 'lib/revox/models/call_retrieve_response.rb', line 2032

optional :speech_events,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CallRetrieveResponse::Call::CallAttempt::SpeechEvent] },
nil?: true

#started_at ⇒ Object

The time the call started.

Parameters:

  • value (top)

Returns:

  • (Object) 


1966
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1966

required :started_at, Revox::Internal::Type::Unknown

#status ⇒ Symbol, Revox::Models::CallRetrieveResponse::Call::CallAttempt::Status

The status of the call attempt.

Parameters:

  • value (Revox::Models::CallRetrieveResponse::Call::CallAttempt::status)

Returns:



1972
 
# File 'lib/revox/models/call_retrieve_response.rb', line 1972

required :status, enum: -> { Revox::Models::CallRetrieveResponse::Call::CallAttempt::Status }

#structured_output ⇒ Hash{Symbol=>Object}?

The data extracted from the call, using the structured output config from the parent call object.

Parameters:

  • value (::Hash[Symbol, top], nil)

Returns:

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


2041
2042
2043
 
# File 'lib/revox/models/call_retrieve_response.rb', line 2041

optional :structured_output,
Revox::Internal::Type::HashOf[Revox::Internal::Type::Unknown],
nil?: true

#transcript ⇒ Array<Revox::Models::CallRetrieveResponse::Call::CallAttempt::Transcript>?

The live transcript of the call, built in real time.

Parameters:

Returns:



2049
2050
2051
 
# File 'lib/revox/models/call_retrieve_response.rb', line 2049

optional :transcript,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CallRetrieveResponse::Call::CallAttempt::Transcript] },
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/revox/models/call_retrieve_response.rb', line 2117

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1583
 
# File 'sig/revox/models/call_retrieve_response.rbs', line 1583

def to_hash: -> {