实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频服务端 API 参考实时数据监控获取实时通话质量指标 ListRealTimeQuality
复制全文
下载 pdf获取实时通话质量指标 ListRealTimeQuality
文档反馈
问问助手获取指定 AppId 在特定时间段内的实时音视频通话质量指标（如卡顿率、进房成功率等），以实时监控通话质量。
- 若要查询地域分布、设备平台、网络类型等维度的实时质量数据，建议调用 ListRealTimeQualityDistribution 接口。
- 可查询指标数据可参看质量数据相关 indicator。
注意事项
- 最大请求次数：2 次/秒
- 最远可查询时间：60 分钟
- 最大单次查询时间跨度：60 分钟
- 数据延迟：1 分钟
请求说明
- 请求方式：POST
- 请求地址：https://rtc.volcengineapi.com?Action=ListRealTimeQuality&Version=2023-11-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Query
Action String 必选 示例值：ListRealTimeQuality
接口名称。当前 API 的名称为 ListRealTimeQuality。
Version String 必选 示例值：2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
Body
AppId String 必选 示例值：66****3cf
StartTime String 必选 示例值：2021-07-24T00:00:00+08:00
查询起始时间戳，格式为 RFC3339。
EndTime String 必选 示例值：2021-07-24T00:10:00+08:00
查询结束时间戳，格式为 RFC3339。
Indicator String[] 必选 示例值：["stall_rate","join_room_success_rate"]
RoomId String 可选 示例值：Room1
房间 ID。不填，表示查询该 AppId 的整体实时指标。
UserId String[] 可选 示例值：["user1","user2"]
用户 ID 列表，最多可以指定 20 个。值不合法时默认剔除。此字段仅在 RoomId 不为空时生效。
ProductType String 可选 示例值：native
要查询的数据所属设备端，支持取值及含义如下：
- native（默认值）：Android、iOS、Linux、Mac 或 Windows 端。
- web：Web 端。
返回参数
RoomId String 示例值：Room1
房间 ID。
UserId String[] 示例值：["user1","user2"]
用户 ID。
Indicators Object[] 示例值：-
指标信息。
Data Object[] 示例值：-
指标详细数据。
Value Double 示例值：99.99
指标值，浮点数，保留两位小数。
TimeStamp String 示例值：2021-07-24T00:00:00+08:00
指标聚合时间，即指标值对应时间段的开始时刻（每 30s 一聚合）。格式为 RFC3339 规范。
StreamId String 示例值：stream1
流 ID。
Name String 示例值：pull_num
指标名称。
Unit String 示例值：-
指标单位。
请求示例
POST https://rtc.volcengineapi.com?Action=ListRealTimeQuality&Version=2023-11-01
{
"AppId" : "66****3cf",
"StartTime" : "2021-07-24T00:00:00+08:00",
"EndTime" : "2021-07-24T00:10:00+08:00",
"Indicator":["stall_rate","join_room_success_rate"],
"RoomId":"Room1",
"UserId":["user1","user2"]
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420",
"Action": "ListRealTimeQuality",
"Version": "2023-11-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": {
"RoomId": "Room1",
"UserId": [
"user1",
"user2"
],
"Indicators": [
{
"Name": "5s_join_room_success_rate",
"Unit": "%",
"Data": [
{
"TimeStamp": "2021-07-24T00:00:00+08:00",
"Value": 98.68
},
{
"TimeStamp": "2021-07-24T00:00:30+08:00",
"Value": 98.20
},
{
"TimeStamp": "2021-07-24T00:01:00+08:00",
"Value": 98.30
}
]
},
{
"Name": "10s_join_room_success_rate",
"Unit": "%",
"Data": [
{
"TimeStamp": "2021-07-24T00:00:00+08:00",
"Value": 99.68
},
{
"TimeStamp": "2021-07-24T00:00:30+08:00",
"Value": 99.20
},
{
"TimeStamp": "2021-07-24T00:01:00+08:00",
"Value": 99.40
}
]
}
]
}
}
错误码
最近更新时间：2026.08.19 17:31:31
这个页面对您有帮助吗？
有用
有用
无用
无用