You need to enable JavaScript to run this app.
导航
获取通话质量指标 ListCallDetail
最近更新时间:2024.07.16 15:31:21首次发布时间:2023.12.27 19:58:10

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

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

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 最远可查询时间:6 天
  • 最大单次查询时间跨度:1 小时
  • 数据延迟:100 秒

请求说明

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

调试

请求参数

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

Query

参数
类型
是否必选
示例值
描述
Action
String
ListCallDetail
接口名称。当前 API 的名称为 ListCallDetail
Version
String
2023-11-01
接口版本。当前 API 的版本为 2023-11-01
AppId
String
You****pId
应用的唯一标志应用的唯一标志
StartTime
String
2022-05-22T12:00:00+08:00
查询起始时间戳,格式为 RFC3339,单位为秒
EndTime
String
2022-05-22T12:59:00+08:00
查询结束时间戳,格式为 RFC3339,单位为秒
RoomId
String
Your_RoomId
房间 ID,是房间的唯一标志
UserId
String
user1,user2
查询的用户ID列表,多个用户ID用逗号隔开,最多可以指定 20 个。值不合法时默认剔除。
Direction
String
0

获取数据的传输方向。枚举值为 0,1,2。

  • 0 :上下行
  • 1 :上行
  • 2: 下行
    默认值为 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=661e****543cf&StartTime=2022-05-22T12:00:00+08:00&EndTime=2022-05-22T12:59:00+08:00&RoomId=Room1&UserId=user1,user2&Direction=0

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420",
    "Service": "rtc",
    "Region": "cn-north-1",
    "Version": "2023-11-01"
  },
  "Result": {
    "UserCallDetail": [
      {
        "RoomId": "Room1",
        "UserId": "user1",
        "PeerId": "PeerUser2",
        "Direction": "up",
        "CallDetail": [
          {"Desc":"音频发送码率",
           "Name":"bandwidth", 
           "Unit":"kbps",
           "Data":[
              {"Time": 1652702700000,
                "Value": 1},
              {"Time": 16527027002000,
                "Value": 2}]
          },
          {"Desc":"音频上行丢包率",
           "Name":"fraction_lost",
           "Unit":"kbps",
           "Data":[
              {"Time": 1652702700000,
                "Value": 1},
              {"Time": 16527027002000,
                "Value": 2}]
          }
        ]
      }
    ]
  }
}

错误码

您可访问公共错误码,获取更多错误码信息。