在你的音视频应用中，你可能会需要获取一个 AppId 下所有的房间信息或指定的某个房间的信息，你可以使用 ListRooms。

接口行为

你可以调用 ListRooms 接口，指定所属的 AppId，获取特定数量的房间信息。

你也可以调用 ListRooms 接口，指定所属的 AppId 和 RoomId，获取指定房间的信息。

当前调用 ListRooms 接口时，若该 RoomId 下有除录制和转码之外进行后处理任务的静默用户，在计算房间内用户总数时也会计入对应的静默用户。

接口限制

你只能查询 8 小时内创建的房间信息。

调用接口

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

请求方式

使用 Get 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数，参看请求参数。

Query

参数名	类型	必填	示例值	描述
Action	String	是	`ListRooms`
Version	String	是	`2020-12-01`	OpenAPI 版本
AppId	String	是		指定进行查询的应用的 `AppId`
RoomId	String	否		如果你指定了 `RoomId` ，则查询该房间的信息。如果不指定，则查询该 AppId 下房间的信息。
Reverse	Int32	否	`1`	默认按照房间创建时间升序返回设置为 `1` 时，降序返回。
Offset	int	否	`50`	偏移量，单位为条。因单次查询返回结果数量有限，如果您需要大量查询，需要借助偏移量实现分页查询。
Limit	Int32	否	`100`	返回条目数的限制，默认为 `50`，最大为 `100`。

请求示例代码

Query

https://rtc.volcengineapi.com?Action=ListRooms&Version=2020-12-01&AppId=yourAppId
postscript

返回调用结果

返回参数说明

参数名	类型	描述
Total	Int	房间总数
ActiveNum	Int	活跃的房间数
InactiveNum	Int	不活跃的房间数。不活跃的房间指：空房间，或已被解散的房间。
Offset	Int	偏移量，单位为条。
Limit	Int	返回条目数的限制
Rooms	Array of Room	房间信息

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

正常返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "ListRooms",
    "Version": "2020-12-01",
    "Service": "rtc",
    "Region": "cn-north-1"
  },
  "Result": {
    "Total": 100,
    "ActiveNum": 20,
    "InactiveNum": 80,
    "Offset": 2,
    "Limit": 10,
    "Rooms": [
      {
        "RoomId": "lufei",
        "AppId": "test",
        "UserNum": 4,
        "StreamNum": 2,
        "State": 1,
        "CreatedAt": "2021-03-16T11:35:25+08:00",
        "UpdatedAt": "2021-03-16T11:35:27+08:00"
      }
    ]
  }
}
json