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

接口行为

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

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用OpenAPI。

接口限制

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

请求方式

使用 GET 方式发起请求。

请求参数

参数名	类型	必填	示例值	描述
Action	String	是	`ListCallDetail`	接口名称，本接口取值：`ListCallDetail`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`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`。不传时自动调整为默认值。

请求示例

http://rtc.volcengineapi.com?Action=ListCallDetail&AppId=Your_AppId&StartTime=2022-05-22T12:00:00+08:00&EndTime=2022-05-22T12:59:00 08:00&RoomId=Your_RoomId&UserId=user1,user2&Version=2020-12-01
postscript

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名	类型	描述
UserCallDetail	Array of UserCall	用户通话质量指标信息

返回值Result仅在请求成功时返回以上参数，失败时为空

UserCall

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	查询房间 Id
UserId	String	`Your_UserId`	查询用户 Id
PeerId	String	`Your_Peer_Id`	对端用户 Id，只有UserId用户处于下行时存在
Direction	String	`up`	获取数据的传输方向。
CallDetail	Array of Detail		通话质量指标数据详情。本接口支持的通话质量指标参看指标列表

Detail

参数名	类型	示例值	描述
Desc	String	`音频发送码率`	该指标中文名称
Name	String	`bandwidth`	该项指标字段名称
Unit	String	`%`	该项指标单位。
Data	Array of DataItem		指标数据详情

DataItem

参数名	类型	示例值	描述
Time	Int	`1652702700000`	该指标数据点的 Unix 时间戳，单位为毫秒。
Value	Float	`1`	该指标数据点的数据值

指标名称	单位
App 的 CPU 使用率	%
系统 CPU 使用率	%
音频采集音量	——
音频播放音量	——
音频发送码率	Kbps
音频接收码率	Kbps
音频上行网络延时	ms
音频上行丢包率	%
音频下行网络延时	ms
音频下行丢包率	%
音频卡顿时长	ms
视频发送分辨率的宽	——
视频发送分辨率的高	——
视频接收分辨率的宽	——
视频接收分辨率的高	——
视频采集帧率	fps
视频大流发送帧率	fps
视频小流发送帧率	fps
视频接收帧率	fps
视频大流发送码率	Kbps
视频小流发送码率	Kbps
视频接收码率	Kbps
视频上行网络延时	ms
视频上行丢包率	%
视频下行网络延时	ms
视频下行丢包率	%
视频卡顿时长	ms

正常返回示例

{
  "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":"%",
           "Data":[
              {"Time": 1652702700000,
                "Value": 1},
              {"Time": 16527027002000,
                "Value": 2}]
          }
        ]
      }
    ]
  }
}
json