You need to enable JavaScript to run this app.
文档中心
实时音视频

实时音视频

复制全文
下载 pdf
实时数据监控
获取通话质量指标 ListCallDetail
复制全文
下载 pdf
获取通话质量指标 ListCallDetail
本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本。​
调用 ListCallDetail 接口,获取特定用户在指定房间和时间范围内的详细音视频通话质量数据(如码率、帧率、丢包率等),实现对用户通话异常的深度故障诊断。​
注意事项​
  • 请求频率:单用户请求频率限制为 10 次/秒。​
  • 最远可查询时间:6 天​
  • 最大单次查询时间跨度:1 小时​
  • 数据延迟:100 秒​
  • 该接口请求接入地址仅支持 rtc.volcengineapi.com。​
请求说明​
  • 请求方式:GET​
  • 请求地址:https://rtc.volcengineapi.com?Action=ListCallDetail&Version=2023-11-01​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Query​
Action String 必选 示例值:ListCallDetail​
接口名称。当前 API 的名称为 ListCallDetail。​
​
Version String 必选 示例值:2023-11-01​
接口版本。当前 API 的版本为 2023-11-01。​
​
AppId String 必选 示例值:66****3cf​
实时音视频应用的 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​
RTC 房间 ID。​
​
UserId String 必选 示例值:user1,user2​
查询的用户 ID,多个用户 ID 用逗号隔开,最多可以指定 20 个。值不合法时默认剔除。​
​
Direction String 可选 示例值:0​
获取数据的传输方向:​
  • 0(默认值) :上下行​
  • 1:上行​
  • 2:下行​
​
​
返回参数​
下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构。​
UserCallDetail Object[] 示例值:-​
用户通话质量指标信息.​
PeerId String 示例值:PeerUser2​
对端用户 ID,只有 UserId 用户处于下行时存在。​
​
RoomId String 示例值:Room1​
查询房间 ID。​
​
UserId String 示例值:user1​
查询用户 ID。​
​
Direction String 示例值:up​
获取数据的传输方向。​
  • up:上行​
  • down:下行​
​
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=66****3cf&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": "202608191903244F232BDAB7B1EBC5FEF2",​
"Action": "ListCallDetail",​
"Version": "2023-11-01",​
"Service": "rtc",​
"Region": "cn-beijing"​
},​
"Result": {​
"UserCallDetail": [​
{​
"RoomId": "ChatRoom01",​
"UserId": "Huoshan01",​
"PeerId": "",​
"Direction": "up",​
"CallDetail": [​
{​
"Desc": "音频采集音量",​
"Name": "audio_level",​
"Unit": "",​
"Data": [​
{​
"Time": 1787137342488,​
"Value": 39.04​
},​
{​
"Time": 1787137344490,​
"Value": 35.76​
},​
{​
"Time": 1787137346493,​
"Value": 37.66​
},​
{​
"Time": 1787137348495,​
"Value": 34.72​
},​
{​
"Time": 1787137351389,​
"Value": 36.65​
},​
{​
"Time": 1787137354387,​
"Value": 32.4​
},​
{​
"Time": 1787137356389,​
"Value": 41.37​
},​
{​
"Time": 1787137359390,​
"Value": 33.49​
},​
{​
"Time": 1787137362387,​
"Value": 35.64​
},​
{​
"Time": 1787137364390,​
"Value": 26.31​
},​
{​
"Time": 1787137367388,​
"Value": 0​
},​
{​
"Time": 1787137370388,​
"Value": 41.98​
},​
{​
"Time": 1787137373388,​
"Value": 39.83​
},​
{​
"Time": 1787137376388,​
"Value": 13.02​
},​
{​
"Time": 1787137378641,​
"Value": 26.55​
}​
]​
},​
{​
"Desc": "音频发送码率",​
"Name": "audio_bandwidth",​
"Unit": "Kbps",​
"Data": [​
{​
"Time": 1787137342488,​
"Value": 33​
},​
{​
"Time": 1787137344490,​
"Value": 29​
},​
{​
"Time": 1787137346493,​
"Value": 29​
},​
{​
"Time": 1787137348495,​
"Value": 28​
},​
{​
"Time": 1787137351389,​
"Value": 30​
},​
{​
"Time": 1787137354387,​
"Value": 29​
},​
{​
"Time": 1787137356389,​
"Value": 30​
},​
{​
"Time": 1787137359390,​
"Value": 29​
},​
{​
"Time": 1787137362387,​
"Value": 28​
},​
{​
"Time": 1787137364390,​
"Value": 32​
},​
{​
"Time": 1787137367388,​
"Value": 31​
},​
{​
"Time": 1787137370388,​
"Value": 31​
},​
{​
"Time": 1787137373388,​
"Value": 32​
},​
{​
"Time": 1787137376388,​
"Value": 32​
},​
{​
"Time": 1787137378641,​
"Value": 31​
}​
]​
},​
{​
"Desc": "视频上行丢包率",​
"Name": "audio_fraction_lost",​
"Unit": "%",​
"Data": [​
{​
"Time": 1787137342488,​
"Value": 0​
},​
{​
"Time": 1787137344490,​
"Value": 0​
},​
{​
"Time": 1787137346493,​
"Value": 0​
},​
{​
"Time": 1787137348495,​
"Value": 0​
},​
{​
"Time": 1787137351389,​
"Value": 0​
},​
{​
"Time": 1787137354387,​
"Value": 0​
},​
{​
"Time": 1787137356389,​
"Value": 0​
},​
{​
"Time": 1787137359390,​
"Value": 0​
},​
{​
"Time": 1787137362387,​
"Value": 0​
},​
{​
"Time": 1787137364390,​
"Value": 0​
},​
{​
"Time": 1787137367388,​
"Value": 0​
},​
{​
"Time": 1787137370388,​
"Value": 0​
},​
{​
"Time": 1787137373388,​
"Value": 0​
},​
{​
"Time": 1787137376388,​
"Value": 0​
},​
{​
"Time": 1787137378641,​
"Value": 0​
}​
]​
},​
{​
"Desc": "视频发送分辨率-宽",​
"Name": "frame_size_width",​
"Unit": "",​
"Data": [​
{​
"Time": 1787137342488,​
"Value": 0​
},​
{​
"Time": 1787137344490,​
"Value": 0​
},​
{​
"Time": 1787137346493,​
"Value": 0​
},​
{​
"Time": 1787137348495,​
"Value": 0​
},​
{​
"Time": 1787137351389,​
"Value": 0​
},​
{​
"Time": 1787137354387,​
"Value": 0​
},​
{​
"Time": 1787137356389,​
"Value": 0​
},​
{​
"Time": 1787137359390,​
"Value": 0​
},​
{​
"Time": 1787137362387,​
"Value": 0​
},​
{​
"Time": 1787137364390,​
"Value": 0​
},​
{​
"Time": 1787137367389,​
"Value": 0​
},​
{​
"Time": 1787137370388,​
"Value": 0​
},​
{​
"Time": 1787137373388,​
"Value": 0​
},​
{​
"Time": 1787137376388,​
"Value": 0​
},​
{​
"Time": 1787137378642,​
"Value": 0​
}​
]​
},​
{​
"Desc": "视频发送分辨率-高",​
"Name": "frame_size_height",​
"Unit": "",​
"Data": [​
{​
"Time": 1787137342488,​
"Value": 0​
},​
{​
"Time": 1787137344490,​
"Value": 0​
},​
{​
"Time": 1787137346493,​
"Value": 0​
},​
{​
"Time": 1787137348495,​
"Value": 0​
},​
{​
"Time": 1787137351389,​
"Value": 0​
},​
{​
"Time": 1787137354387,​
"Value": 0​
},​
{​
"Time": 1787137356389,​
"Value": 0​
},​
{​
"Time": 1787137359390,​
"Value": 0​
},​
{​
"Time": 1787137362387,​
"Value": 0​
},​
{​
"Time": 1787137364390,​
"Value": 0​
},​
{​
"Time": 1787137367389,​
"Value": 0​
},​
{​
"Time": 1787137370388,​
"Value": 0​
},​
{​
"Time": 1787137373388,​
"Value": 0​
},​
{​
"Time": 1787137376388,​
"Value": 0​
},​
{​
"Time": 1787137378642,​
"Value": 0​
}​
]​
},​
{​
"Desc": "视频采集帧率",​
"Name": "original_input_framerate",​
"Unit": "fps",​
"Data": [​
{​
"Time": 1787137342488,​
"Value": 0​
},​
{​
"Time": 1787137344490,​
"Value": 0​
},​
{​
"Time": 1787137346493,​
"Value": 0​
},​
{​
"Time": 1787137348495,​
"Value": 0​
},​
{​
"Time": 1787137351389,​
"Value": 0​
},​
{​
"Time": 1787137354387,​
"Value": 0​
},​
{​
"Time": 1787137356389,​
"Value": 0​
},​
{​
"Time": 1787137359390,​
"Value": 0​
},​
{​
"Time": 1787137362387,​
"Value": 0​
},​
{​
"Time": 1787137364390,​
"Value": 0​
},​
{​
"Time": 1787137367389,​
"Value": 0​
},​
{​
"Time": 1787137370388,​
"Value": 0​
},​
{​
"Time": 1787137373388,​
"Value": 0​
},​
{​
"Time": 1787137376388,​
"Value": 0​
},​
{​
"Time": 1787137378642,​
"Value": 0​
}​
]​
},​
{​
"Desc": "视频大流发送帧率",​
"Name": "frame_rate_sent",​
"Unit": "fps",​
"Data": [​
{​
"Time": 1787137342488,​
"Value": 0​
},​
{​
"Time": 1787137344490,​
"Value": 0​
},​
{​
"Time": 1787137346493,​
"Value": 0​
},​
{​
"Time": 1787137348495,​
"Value": 0​
},​
{​
"Time": 1787137351389,​
"Value": 0​
},​
{​
"Time": 1787137354387,​
"Value": 0​
},​
{​
"Time": 1787137356389,​
"Value": 0​
},​
{​
"Time": 1787137359390,​
"Value": 0​
},​
{​
"Time": 1787137362387,​
"Value": 0​
},​
{​
"Time": 1787137364390,​
"Value": 0​
},​
{​
"Time": 1787137367389,​
"Value": 0​
},​
{​
"Time": 1787137370388,​
"Value": 0​
},​
{​
"Time": 1787137373388,​
"Value": 0​
},​
{​
"Time": 1787137376388,​
"Value": 0​
},​
{​
"Time": 1787137378642,​
"Value": 0​
}​
]​
},​
{​
"Desc": "视频大流发送码率",​
"Name": "video_bandwidth",​
"Unit": "Kbps",​
"Data": [​
{​
"Time": 1787137342488,​
"Value": 390​
},​
{​
"Time": 1787137344490,​
"Value": 169​
},​
{​
"Time": 1787137346493,​
"Value": 228​
},​
{​
"Time": 1787137348495,​
"Value": 475​
},​
{​
"Time": 1787137351389,​
"Value": 589​
},​
{​
"Time": 1787137354387,​
"Value": 319​
},​
{​
"Time": 1787137356389,​
"Value": 499​
},​
{​
"Time": 1787137359390,​
"Value": 618​
},​
{​
"Time": 1787137362387,​
"Value": 506​
},​
{​
"Time": 1787137364390,​
"Value": 543​
},​
{​
"Time": 1787137367389,​
"Value": 247​
},​
{​
"Time": 1787137370388,​
"Value": 334​
},​
{​
"Time": 1787137373388,​
"Value": 533​
},​
{​
"Time": 1787137376388,​
"Value": 593​
},​
{​
"Time": 1787137378642,​
"Value": 587​
}​
]​
},​
{​
"Desc": "视频上行丢包率",​
"Name": "video_fraction_lost",​
"Unit": "%",​
"Data": [​
{​
"Time": 1787137342488,​
"Value": 0​
},​
{​
"Time": 1787137344490,​
"Value": 1.79​
},​
{​
"Time": 1787137346493,​
"Value": 0​
},​
{​
"Time": 1787137348495,​
"Value": 0​
},​
{​
"Time": 1787137351389,​
"Value": 0​
},​
{​
"Time": 1787137354387,​
"Value": 0​
},​
{​
"Time": 1787137356389,​
"Value": 0​
},​
{​
"Time": 1787137359390,​
"Value": 0​
},​
{​
"Time": 1787137362387,​
"Value": 0​
},​
{​
"Time": 1787137364390,​
"Value": 0​
},​
{​
"Time": 1787137367389,​
"Value": 0​
},​
{​
"Time": 1787137370388,​
"Value": 0​
},​
{​
"Time": 1787137373388,​
"Value": 0​
},​
{​
"Time": 1787137376388,​
"Value": 0​
},​
{​
"Time": 1787137378642,​
"Value": 0​
}​
]​
}​
]​
}​
]​
}​
}​
​
错误码​
您可访问公共错误码,获取更多错误码信息。​
最近更新时间:2026.08.19 19:12:45
这个页面对您有帮助吗?
有用
有用
无用
无用