获取通话质量指标 ListCallDetail--实时音视频-火山引擎

文档中心

实时音视频

请输入

获取数据指标

获取通话质量指标 ListCallDetail

你可以使用此接口查询一段时间内，某个应用下进行音视频通话的指定房间内某个用户的上下行数据。

使用说明

接口行为

你可以调用 ListCallDetail 接口，指定你所属的 AppId，RoomId、UserId 和查询时间段，查询该时间段内的指定房间内指定用户的上下行数据。

注意事项

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

请求说明

请求方式：GET
请求地址：https://rtc.volcengineapi.com?Action=ListCallDetail&Version=2020-12-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListCallDetail`	接口名称。当前 API 的名称为 `ListCallDetail`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。
AppId	String	是	`Your_AppId`	应用的唯一标志
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[]		用户通话质量指标信息，仅在请求成功时返回。
RoomId	String	`Your_RoomId`	查询房间 Id
UserId	String	`Your_UserId`	查询用户 Id
PeerId	String	`Your_Peer_Id`	对端用户 Id，只有UserId用户处于下行时存在
Direction	String	`up`	获取数据的传输方向。
CallDetail	Object[]		通话质量指标数据详情。本接口支持的通话质量指标参看指标列表。
Desc	String	`音频发送码率`	该指标中文名称
Data	Object[]		指标数据详情
Time	Long	`1652702700000`	该指标数据点的 Unix 时间戳，单位为毫秒。
Value	Float	`1`	该指标数据点的数据值
Unit	String	`kbps`	指标单位
Name	String	`bandwidth`	该项指标字段名称

请求示例

GET https://rtc.volcengineapi.com?Action=ListCallDetail&Version=2020-12-01&AppId=Your_AppId&StartTime=2022-05-22T12%3A00%3A00+08%3A00&EndTime=2022-05-22T12%3A59%3A00+08%3A00&RoomId=Your_RoomId&UserId=user1%2Cuser2&Direction=0

返回示例

{
  "ResponseMetadata": {
    "RequestId": "Your_RequestId",
    "Service": "rtc",
    "Region": "cn-north-1",
    "Version": "2020-12-01"
  },
  "Result": {
    "UserCallDetail": [
      {
        "RoomId": "Your_RoomId",
        "UserId": "Your_UserId",
        "PeerId": "Your_PeerId",
        "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}]
          }
        ]
      }
    ]
  }
}

错误码

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

最近更新时间：2025.07.03 20:05:44

这个页面对您有帮助吗？

有用

无用

实时音视频

使用说明 #

接口行为 #

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

返回参数 #

请求示例 #

返回示例 #

错误码 #