You need to enable JavaScript to run this app.
导航
获取实时质量数据 ListRealTimeQuality
最近更新时间:2024.07.01 17:49:07首次发布时间:2024.02.27 14:52:18

本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本

在实时音视频通话场景中,你可以通过调用此接口获取特定应用在指定时间段内的音视频通话质量指标数据。

若要查询地域分布、设备平台、网络类型等维度的实时质量数据,建议调用 ListRealTimeQualityDistribution 接口。

注意事项

  • 最大请求次数:2 次/秒

  • 最远可查询时间:60 分钟

  • 最大单次查询时间跨度:60 分钟

  • 数据延迟:1 分钟

请求说明

  • 请求方式:POST
  • 请求地址:https://rtc.volcengineapi.com?Action=ListRealTimeQuality&Version=2023-11-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数
类型
是否必选
示例值
描述
Action
String
ListRealTimeQuality
接口名称。当前 API 的名称为 ListRealTimeQuality
Version
String
2023-11-01
接口版本。当前 API 的版本为 2023-11-01

Body

参数
类型
是否必选
示例值
描述
AppId
String
661e****543cf
你的音视频应用的唯一标志,参看获取 AppId
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"]
查询的指标名称。可同时查询多个指标。Indicator 可选值,参看质量数据相关 indicator
RoomId
String
Room1
房间 ID,是房间的唯一标志。如果不填,代表查询该 AppId 的整体实时指标。
UserId
String[]
["user1","user2"]
查询的用户 ID 列表,最多可以指定 20 个。值不合法时默认剔除。此字段仅在 RoomId 不为空时生效。
ProductType
String
native

要查询的数据所属设备端,支持取值及含义如下:

  • native:Android、iOS、Linux、Mac 或 Windows 端。
  • web:指 Web 端。

    默认值为 native

返回参数

下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构

参数
类型
示例值
描述
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 规范。指标聚合时间,即指标值对应时间段的开始时刻(每 30s 一聚合)。格式为 RFC3339 规范。
Name
String
5s_join_room_success_rate
指标名称
Unit
String
%
指标单位

请求示例

POST https://rtc.volcengineapi.com?Action=ListRealTimeQuality&Version=2023-11-01
{
    "AppId" : "661e****543cf",
    "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": "20230****10420",
        "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
                    }
                ]
            }
        ]
    }
}