实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频服务端 API 参考历史数据查询获取离线通话房间列表 ListRoomInfo
复制全文
下载 pdf获取离线通话房间列表 ListRoomInfo
文档反馈
问问助手调用 ListRoomInfo 接口，获取指定应用在特定时间段内创建的房间列表及其详细信息，如通话 ID、创建与销毁时间、当前在线人数等。
注意事项
- 最大请求次数：10 次/秒
- 最远可查询时间：14 天
- 最大单次查询时间跨度：24 小时（若查询时间超过 24 小时，结束时间自动调整为开始时间 + 24 小时）
- 数据延迟：60 秒
- 该接口请求接入地址仅支持 rtc.volcengineapi.com。
请求说明
- 请求方式：GET
- 请求地址：https://rtc.volcengineapi.com?Action=ListRoomInfo&Version=2023-11-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Query
Action String 必选 示例值：ListRoomInfo
接口名称。当前 API 的名称为 ListRoomInfo。
Version String 必选 示例值：2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
AppId String 必选 示例值：66****3cf
RoomId String 可选 示例值：Your_RoomId
目标房间 ID。
StartTime String 必选 示例值：2022-09-09T12:06:16+08:00
查询起始时间戳，格式为 RFC3339，单位为秒。
EndTime String 必选 示例值：2022-09-09T12:06:16+08:00
查询结束时间戳，格式为 RFC3339，单位为秒。
PageNum Long 可选 示例值：1
分页序号，默认值为1
PageSize Long 可选 示例值：20
每页房间数，最大不能超过 100。默认为 20。如果指定值超过 100，每页的房间数为 100。
返回参数
Total Long 示例值：2
查询到的房间总数。若同一 RoomId 下有多次通话，记为多个房间。
HasMore Boolean 示例值：false
是否还有房间未列出。若为true，表示符合条件房间过多。若要查询房间未列出，请修改查询条件。
PageNum Long 示例值：1
分页序号。
PageSize Long 示例值：20
每页房间数。
RoomList Object[]
房间信息。
CallId String 示例值：test_call1
通话 ID。
RoomId String 示例值：Room1
返回房间 ID
IsFinished Boolean 示例值：true
通话是否结束。
CreatedTime String 示例值：2022-04-17T22:38:13+08:00
通话创建时间，格式为 RFC3339，单位秒。
DestroyTime String 示例值：2022-04-17T22:38:13+08:00
通话结束时间，格式为 RFC3339，单位秒，若查询时还未结束，则返回空值。
ActiveUserNum Long 示例值：0
当前仍在房间用户数。
请求示例
GET https://rtc.volcengineapi.com?Action=ListRoomInfo&Version=2023-11-01&AppId=66****3cf&StartTime=2022-09-09T10:30:25+08:00&EndTime=2022-09-09T12:06:16+08:00&RoomId=Room1&PageNum=1&PageSize=20
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420",
"Action": "ListRoomInfo",
"Version": "2023-11-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": {
"Total": 2,
"PageNum": 1,
"PageSize": 20,
"HasMore": false,
"RoomList": [
{
"CallId": "test_call1",
"RoomId": "test_room1",
"CreateTime": "2022-10-31T19:17:47+08:00",
"DestroyTime": "2022-10-31T19:18:05+08:00",
"ActiveUserNum": 0,
"IsFinished": true
},
{
"CallId": "test_call2",
"RoomId": "test_room1",
"CreateTime": "2022-10-31T19:18:09+08:00",
"DestroyTime": "2022-10-31T19:18:25+08:00",
"ActiveUserNum": 0,
"IsFinished": true
}
]
}
}
错误码
最近更新时间：2026.07.18 23:50:57
这个页面对您有帮助吗？
有用
有用
无用
无用