你可以使用此接口查询一段时间内，某个应用下进行音视频通话的房间列表及房间相关信息。

接口行为

你可以调用 ListRoomInformation 接口，指定你所属的 AppId和查询时间段，查询该时间段内的房间列表及房间相关信息。

接口限制

限制类别	调用频率限制
最大请求次数	10 次/秒 10000 次/天
最远可查询时间	15 天
最大单次查询时间跨度	24 小时（若查询时间超过 24 小时，结束时间自动调整为开始时间 + 24 小时）
数据延迟	20 秒

调用接口

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

请求方式

使用 GET 方式发起请求。

请求参数

Query

参数名	类型	必填	示例值	描述
Action	String	是	`ListRoomInformation`	接口名称，本接口取值：`ListRoomInformation`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`
AppId	String	是	`Your_AppId`	应用的唯一标志
StartTime	String	是	`2022-09-09T10:30:25+08:00`	查询起始时间戳，格式为 RFC3339，单位秒
EndTime	String	是	`2022-09-09T12:06:16+08:00`	查询结束时间戳，格式为 RFC3339，单位秒
RoomId	String	否	`Your_RoomId`	房间 ID，是房间的唯一标志
PageNum	Int	否	`1`	分页序号，默认值为`1`
PageSize	Int	否	`20`	每页房间数，最大不能超过 100。默认为 `20`。如果指定值超过 100，每页的房间数为 100。

请求示例代码

http://rtc.volcengineapi.com?Action=ListRoomInformation&AppId=Your_AppId&StartTime=2022-05-22T12:00:00+08:00&EndTime=2022-05-22T12:59:00+08:00&Version=2020-12-01
postscript

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名	类型	示例值	描述
Total	Int	`2`	查询到的房间总数
PageNum	Int	`1`	分页序号
PageSize	Int	`20`	每页房间数
HasMore	Bool	`false`	是否有后续数据
RoomList	Array of Room		房间信息

Room

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	返回房间 Id
CreatedTime	String	`2022-04-17T22:38:13+08:00`	房间创建时间，格式为 RFC3339，单位秒
DestroyTime	String	`2022-04-17T22:38:13+08:00`	房间结束时间，格式为 RFC3339，单位秒
ActiveUserNum	Int	`0`	当前仍在房间用户数
IsFinished	bool	`true`	房间是否结束

正常返回示例

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

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "ListRoomInformation",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 1,
        "PageNum": 1,
        "PageSize": 20,
        "HasMore": false,
        "RoomList": [
            {
                "RoomId": "Your_RoomId",
                "CreatedTime": "2022-09-09T10:30:25+08:00",
                "DestroyTime": "2022-09-09T12:06:16+08:00",
                "ActiveUserNum": 0,
                "IsFinished": true
            }
        ]
    }
}
json