Class: Revox::Models::CallRetrieveResponse::Call::LastCallAttempt

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

Overview

See Also:

  • Revox::Models::CallRetrieveResponse::Call#last_call_attempt

Defined Under Namespace

Modules: DialError, EndReason, EndedBy, Result, Status Classes: PostCallTranscript, SMSLog, 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:, answered_at:, dial_error:, ended_at:, phone_number:, recording_url:, result:, started_at:, status:, assistants_used: nil, end_reason: nil, ended_by: nil, post_call_transcript: nil, sms_log: nil, structured_output: nil, transcript: nil) ⇒ Object

Some parameter documentations has been truncated, see Revox::Models::CallRetrieveResponse::Call::LastCallAttempt for more details.

This represent a single call attempt. A call attempt is a single call made to the phone number.

Parameters:



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

Instance Attribute Details

#answered_atObject

The time the call was answered.

Parameters:

  • value (top)

Returns:

  • (Object)


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

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

#assistants_usedArray<String>?

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

Parameters:

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

Returns:

  • (Array<String>, nil)


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

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

#dial_errorSymbol, ...

The SIP error that occurred.

Parameters:

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

Returns:



2494
2495
2496
# File 'lib/revox/models/call_retrieve_response.rb', line 2494

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

#end_reasonSymbol, ...

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::LastCallAttempt::end_reason, nil)

Returns:



2547
2548
2549
# File 'lib/revox/models/call_retrieve_response.rb', line 2547

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

#ended_atObject

The time the call ended.

Parameters:

  • value (top)

Returns:

  • (Object)


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

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

#ended_bySymbol, ...

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::LastCallAttempt::ended_by, nil)

Returns:



2556
2557
2558
# File 'lib/revox/models/call_retrieve_response.rb', line 2556

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

#idString

The ID of the call attempt.

Parameters:

  • value (String)

Returns:

  • (String)


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

required :id, String

#phone_numberString

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

Parameters:

  • value (String)

Returns:

  • (String)


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

required :phone_number, String

#post_call_transcriptArray<Revox::Models::CallRetrieveResponse::Call::LastCallAttempt::PostCallTranscript>?

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



2565
2566
2567
# File 'lib/revox/models/call_retrieve_response.rb', line 2565

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

#recording_urlString?

The URL of the audio recording of the call.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil)


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

required :recording_url, String, nil?: true

#resultSymbol, ...

Parameters:

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

Returns:



2520
2521
2522
# File 'lib/revox/models/call_retrieve_response.rb', line 2520

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

#sms_logArray<Revox::Models::CallRetrieveResponse::Call::LastCallAttempt::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.



2575
2576
2577
# File 'lib/revox/models/call_retrieve_response.rb', line 2575

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

#started_atObject

The time the call started.

Parameters:

  • value (top)

Returns:

  • (Object)


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

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

#statusSymbol, Revox::Models::CallRetrieveResponse::Call::LastCallAttempt::Status

The status of the call attempt.

Parameters:

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

Returns:



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

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

#structured_outputHash{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)


2584
2585
2586
# File 'lib/revox/models/call_retrieve_response.rb', line 2584

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

#transcriptArray<Revox::Models::CallRetrieveResponse::Call::LastCallAttempt::Transcript>?

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



2592
2593
2594
# File 'lib/revox/models/call_retrieve_response.rb', line 2592

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

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


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

Instance Method Details

#to_hash{

Returns:

  • ({)


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

def to_hash: -> {