最近更新时间:2024.04.11 11:50:49
首次发布时间:2023.12.27 19:58:10
你可以使用此接口查询一段时间内,某个应用下进行音视频通话的指定房间内某个用户的上下行数据。
你可以调用 ListCallDetail
接口,指定你所属的 AppId
,RoomId
、UserId
和查询时间段,查询该时间段内的指定房间内指定用户的上下行数据。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用OpenAPI。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数名称 | 数据类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListCallDetail | 接口名称。当前 API 的名称为 ListCallDetail 。 |
Version | String | 是 | 2023-11-01 | 接口版本。当前 API 的版本为 2023-11-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。
|
下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
UserCallDetail | Object[] | 用户通话质量指标信息 | |
PeerId | String | Your_Peer_Id | 对端用户 Id,只有UserId用户处于下行时存在 |
RoomId | String | Your_RoomId | 查询房间 Id |
UserId | String | Your_UserId | 查询用户 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=Your_AppId&StartTime=2022-05-22T12:00:00+08:00&EndTime=2022-05-22T12:59:00+08:00&RoomId=Your_RoomId&UserId=user1,user2&Direction=0
{ "ResponseMetadata": { "RequestId": "Your_RequestId", "Service": "rtc", "Region": "cn-north-1", "Version": "2023-11-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}] } ] } ] } }
您可访问公共错误码,获取更多错误码信息。