Class: Revox::Models::CallCreateResponse::Call::CallAttempt

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

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::CallCreateResponse::Call::CallAttempt 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_create_response.rb', line 1964

Instance Attribute Details

#answered_at ⇒ Object

The time the call was answered.

Parameters:

  • value (top)

Returns:

  • (Object) 


1860
 
# File 'lib/revox/models/call_create_response.rb', line 1860

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) 


1910
 
# File 'lib/revox/models/call_create_response.rb', line 1910

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

#dial_error ⇒ Symbol, ...

The SIP error that occurred.

Parameters:

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

Returns:



1866
1867
1868
 
# File 'lib/revox/models/call_create_response.rb', line 1866

required :dial_error,
enum: -> { Revox::Models::CallCreateResponse::Call::CallAttempt::DialError },
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::CallCreateResponse::Call::CallAttempt::end_reason, nil)

Returns:



1917
1918
1919
 
# File 'lib/revox/models/call_create_response.rb', line 1917

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

#ended_at ⇒ Object

The time the call ended.

Parameters:

  • value (top)

Returns:

  • (Object) 


1874
 
# File 'lib/revox/models/call_create_response.rb', line 1874

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::CallCreateResponse::Call::CallAttempt::ended_by, nil)

Returns:



1926
 
# File 'lib/revox/models/call_create_response.rb', line 1926

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

#id ⇒ String

The ID of the call attempt.

Parameters:

  • value (String)

Returns:

  • (String) 


1854
 
# File 'lib/revox/models/call_create_response.rb', line 1854

required :id, String

#phone_number ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


1881
 
# File 'lib/revox/models/call_create_response.rb', line 1881

required :phone_number, String

#post_call_transcript ⇒ Array<Revox::Models::CallCreateResponse::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:



1933
1934
1935
 
# File 'lib/revox/models/call_create_response.rb', line 1933

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

#recording_url ⇒ String?

The URL of the audio recording of the call.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


1887
 
# File 'lib/revox/models/call_create_response.rb', line 1887

required :recording_url, String, nil?: true

#result ⇒ Symbol, ...

Parameters:

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

Returns:



1892
 
# File 'lib/revox/models/call_create_response.rb', line 1892

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

#sms_log ⇒ Array<Revox::Models::CallCreateResponse::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:



1943
1944
1945
 
# File 'lib/revox/models/call_create_response.rb', line 1943

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

#started_at ⇒ Object

The time the call started.

Parameters:

  • value (top)

Returns:

  • (Object) 


1898
 
# File 'lib/revox/models/call_create_response.rb', line 1898

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

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

The status of the call attempt.

Parameters:

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

Returns:



1904
 
# File 'lib/revox/models/call_create_response.rb', line 1904

required :status, enum: -> { Revox::Models::CallCreateResponse::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) 


1952
1953
1954
 
# File 'lib/revox/models/call_create_response.rb', line 1952

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

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

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

Parameters:

Returns:



1960
1961
1962
 
# File 'lib/revox/models/call_create_response.rb', line 1960

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/revox/models/call_create_response.rb', line 2018

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1561
 
# File 'sig/revox/models/call_create_response.rbs', line 1561

def to_hash: -> {