Skip to content

[Docs] Update API reference for new call quality metrics fields in List Calls, Retrieve a Call, and List Logs #830

Description

@imfaruk

Summary

The following REST API endpoints now return additional call quality metrics fields as part of https://github.com/signalwire/prime-rails/pull/8653.

Affected Endpoints

  • List CallsGET /api/laml/2010-04-01/Accounts/{AccountSid}/Calls.json
  • Retrieve a CallGET /api/laml/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}.json
  • List Voice LogsGET /api/v1/Accounts/{AccountSid}/Logs/Voice

New Response Fields

Field Type Description
audio_in_mos decimal Mean Opinion Score for inbound audio quality (1.0–5.0)
audio_rtt_avg float Average round-trip time in milliseconds
audio_rtt_min float Minimum round-trip time in milliseconds
audio_rtt_max float Maximum round-trip time in milliseconds
audio_out_jitter_min float Minimum outbound jitter in milliseconds
audio_out_jitter_max float Maximum outbound jitter in milliseconds
audio_out_jitter_avg float Average outbound jitter in milliseconds
audio_out_lost integer Number of outbound packets lost

Action Required

  • Update the API reference pages for the affected endpoints to document the new fields
  • Fields will be null when call quality data is unavailable (e.g., non-RTP calls or calls that completed before metrics were collected)

Part of https://github.com/signalwire/prime-rails/pull/8653

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions