Class: Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb

Defined Under Namespace

Modules: Logs, Stats

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(call_id: nil, call_report_id: nil, created_at: nil, flush_reason: nil, logs: nil, organization_id: nil, segment: nil, stats: nil, stored_at: nil, summary: nil, telnyx_leg_id: nil, telnyx_session_id: nil, user_agent: nil, user_id: nil, version: nil, voice_sdk_id: nil, voice_sdk_id_decoded: nil, voice_sdk_session_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem for more details.

A raw call report stats JSON payload. The schema is intentionally permissive because Voice SDK clients can add fields over time.

Parameters:

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

    Unique call identifier.

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

    User-scoped storage grouping identifier derived from the authenticated user. Thi

  • created_at (Time) (defaults to: nil) —

    Creation timestamp when present.

  • flush_reason (Hash{Symbol=>Object}) (defaults to: nil) —

    Reason the SDK flushed this stats report segment, for example an intermediate so

  • logs (Array<Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::UnionMember0>, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::Entries) (defaults to: nil) —

    Raw logs payload emitted by the Voice SDK and stored without normalization. Live

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

    Organization associated with the stored call report when provided by the Voice S

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

    Zero-based stats segment index when the SDK sends segmented or intermediate repo

  • stats (Array<Hash{Symbol=>Object}>, Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Stats::UnionMember1) (defaults to: nil) —

    Raw stats payload emitted by the Voice SDK and stored without normalization. The

  • stored_at (Time) (defaults to: nil) —

    Time when the call report was stored.

  • summary (Hash{Symbol=>Object}) (defaults to: nil) —

    High-level call metadata.

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

    Telnyx call leg identifier for correlating the report with call-control, SIP, an

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

    Telnyx RTC session identifier for correlating the report with Voice SDK signalin

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

    Voice SDK user agent string reported by the client. This is the preferred SDK/pl

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

    Authenticated user that owns the call report.

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

    Legacy SDK version value when the client reports one separately from the user ag

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

    Voice SDK instance identifier.

  • voice_sdk_id_decoded (Hash{Symbol=>Object}) (defaults to: nil) —

    Decoded Voice SDK identifier metadata emitted by voice-sdk-proxy when available.

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

    Voice SDK session correlation identifier used to group stats segments for the sa




# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 131

Instance Attribute Details

#call_id ⇒ String?

Unique call identifier.

Returns:

  • (String, nil) 


10
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 10

optional :call_id, String

#call_report_id ⇒ String?

User-scoped storage grouping identifier derived from the authenticated user. This is not a unique per-call report identifier and may be shared by multiple calls for the same user.

Returns:

  • (String, nil) 


18
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 18

optional :call_report_id, String

#created_at ⇒ Time?

Creation timestamp when present.

Returns:

  • (Time, nil) 


24
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 24

optional :created_at, Time

#flush_reason ⇒ Hash{Symbol=>Object}?

Reason the SDK flushed this stats report segment, for example an intermediate socket-close flush.

Returns:

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


31
32
33
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 31

optional :flush_reason,
Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
api_name: :flushReason

#logs ⇒ Array<Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs::UnionMember0>, ...

Raw logs payload emitted by the Voice SDK and stored without normalization. Live responses commonly return an array of log entries, but object-shaped log payloads are also allowed for compatibility.

Returns:



41
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 41

optional :logs, union: -> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Logs }

#organization_id ⇒ String?

Organization associated with the stored call report when provided by the Voice SDK reporting path.

Returns:

  • (String, nil) 


48
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 48

optional :organization_id, String

#segment ⇒ Integer?

Zero-based stats segment index when the SDK sends segmented or intermediate reports.

Returns:

  • (Integer, nil) 


55
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 55

optional :segment, Integer

#stats ⇒ Array<Hash{Symbol=>Object}>, ...

Raw stats payload emitted by the Voice SDK and stored without normalization. The exact shape can vary by SDK platform and version. Live responses commonly return an array of interval snapshots, but object-shaped stats payloads are also allowed for compatibility.

Returns:



64
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 64

optional :stats, union: -> { Telnyx::Models::VoiceSDKCallReportRetrieveResponseItem::Stats }

#stored_at ⇒ Time?

Time when the call report was stored.

Returns:

  • (Time, nil) 


70
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 70

optional :stored_at, Time

#summary ⇒ Hash{Symbol=>Object}?

High-level call metadata.

Returns:

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


76
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 76

optional :summary, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#telnyx_leg_id ⇒ String?

Telnyx call leg identifier for correlating the report with call-control, SIP, and media troubleshooting data.

Returns:

  • (String, nil) 


83
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 83

optional :telnyx_leg_id, String

#telnyx_session_id ⇒ String?

Telnyx RTC session identifier for correlating the report with Voice SDK signaling and media-session logs.

Returns:

  • (String, nil) 


90
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 90

optional :telnyx_session_id, String

#user_agent ⇒ String?

Voice SDK user agent string reported by the client. This is the preferred SDK/platform/version dimension when present.

Returns:

  • (String, nil) 


97
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 97

optional :user_agent, String

#user_id ⇒ String?

Authenticated user that owns the call report.

Returns:

  • (String, nil) 


103
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 103

optional :user_id, String

#version ⇒ String?

Legacy SDK version value when the client reports one separately from the user agent.

Returns:

  • (String, nil) 


110
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 110

optional :version, String

#voice_sdk_id ⇒ String?

Voice SDK instance identifier.

Returns:

  • (String, nil) 


116
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 116

optional :voice_sdk_id, String

#voice_sdk_id_decoded ⇒ Hash{Symbol=>Object}?

Decoded Voice SDK identifier metadata emitted by voice-sdk-proxy when available.

Returns:

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


122
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 122

optional :voice_sdk_id_decoded, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#voice_sdk_session_id ⇒ String?

Voice SDK session correlation identifier used to group stats segments for the same SDK session.

Returns:

  • (String, nil) 


129
 
# File 'lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb', line 129

optional :voice_sdk_session_id, String