- 文档首页
实时音视频
实时音视频
服务端 API 参考
实时数据监控
获取通话质量指标 ListCallDetail
实时数据监控
获取通话质量指标 ListCallDetail
获取通话质量指标 ListCallDetail
本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本。 调用 ListCallDetail 接口,获取特定用户在指定房间和时间范围内的详细音视频通话质量数据(如码率、帧率、丢包率等),实现对用户通话异常的深度故障诊断。
注意事项
- 该接口请求接入地址仅支持 rtc.volcengineapi.com。
请求说明
- 请求地址:https://rtc.volcengineapi.com?Action=ListCallDetail&Version=2023-11-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。 Action String 必选 示例值:ListCallDetail
接口名称。当前 API 的名称为 ListCallDetail。
Version String 必选 示例值:2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
AppId String 必选 示例值:66****3cf
StartTime String 必选 示例值:2022-05-22T12:00:00+08:00
查询起始时间戳,格式为 RFC3339。
EndTime String 必选 示例值:2022-05-22T12:59:00+08:00
查询结束时间戳,格式为 RFC3339。
RoomId String 必选 示例值:Your_RoomId
RTC 房间 ID。
UserId String 必选 示例值:user1,user2
查询的用户 ID,多个用户 ID 用逗号隔开,最多可以指定 20 个。值不合法时默认剔除。
Direction String 可选 示例值:0
获取数据的传输方向:
返回参数
下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构。 UserCallDetail Object[] 示例值:-
用户通话质量指标信息.
PeerId String 示例值:PeerUser2
对端用户 ID,只有 UserId 用户处于下行时存在。
RoomId String 示例值:Room1
查询房间 ID。
UserId String 示例值:user1
查询用户 ID。
Direction String 示例值:up
获取数据的传输方向。
CallDetail Object[] 示例值:-
通话质量指标数据详情。
Data Object[] 示例值:-
指标数据详情。
Time Long 示例值:1652702700000
该指标数据点的 Unix 时间戳,单位为毫秒。
Value Double 示例值:1
该指标数据点的数据值。
Desc String 示例值:音频发送码率
指标中文名称。
Name String 示例值:bandwidth
指标字段名称。
Unit String 示例值:fps
指标单位。
请求示例
GET https://rtc.volcengineapi.com?Action=ListCallDetail&Version=2023-11-01&AppId=66****3cf&StartTime=2022-05-22T12:00:00+08:00&EndTime=2022-05-22T12:59:00+08:00&RoomId=Room1&UserId=user1,user2&Direction=0
返回示例
"RequestId": "202608191903244F232BDAB7B1EBC5FEF2",
"Action": "ListCallDetail",
"Version": "2023-11-01",
"Name": "audio_bandwidth",
"Name": "audio_fraction_lost",
"Name": "frame_size_width",
"Name": "frame_size_height",
"Name": "original_input_framerate",
"Name": "frame_rate_sent",
"Name": "video_bandwidth",
"Name": "video_fraction_lost",
错误码
最近更新时间:2026.08.19 19:12:45