查询活跃房间列表

更新时间: 2024/03/25 11:00:43

查看应用当前活跃的房间列表。

若要使用该接口,需联系技术支持人员开通

URL

  • 请求方法:GET

  • URL:

    https://logic-dev.netease.im/v2/api/activerooms?pageNum={pageNum}&pageSize={pageSize}&platform={platform}
    
  • Content-Type:application/json

URL 中参数说明:

参数名称 类型 示例 描述

platform

Number

0

  • 设置为-1,则返回全部房间
  • 设置为0,表示查询音视频RTC房间。
  • 设置为1,表示查询低延迟直播房间。
pageNum Number 1 默认值为1,即第一页。pageNum的取值不能大于(房间总数/每页显示的房间数 - 1)。否则,指定的页面将不包含任何房间
pageSize Number 10000 默认值为10000。每个页面显示的房间数量,取值范围为 [1,10000]

接口请求频率

默认上限为 5 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考如何处理调用服务端 RESTful API 超出频率限制

请求参数

  • 请求中 Header 的设置请参考请求结构描述。

  • 该 API 的 Body 中无需指定任何请求参数。

返回参数

参数名称 类型 示例 描述
number Number 123 当前活跃房间总数
data Array of JSON -- 具体见下表参数说明

data 中的参数说明

参数名称 类型 示例 描述
cid Long 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。
cname String abc 房间名称。
user_count Number 15 房间内的在线成员数。

platform

Number

0

  • 若为0,表示查询音视频RTC房间。
  • 若为1,表示查询低延迟直播房间。
appid Number 15237434 appkey与appid具有唯一对应关系

示例

请求示例

GET https://logic-dev.netease.im/v2/api/activerooms?pageNum=1&pageSize=100&platform=0

正常返回示例

{
    "number": 2,
    "data": [
        {
            "cid": 1145395853651680,
            "cname": "testi41",
            "user_count": 1,
            "appid": 132989080,
            "platform": 0
        },
        {
            "cid": 13453253495079,
            "cname": "testtest",
            "user_count": 2,
            "appid": 132989080,
            "platform": 0
        }
    ]
}

错误码

该接口仅在 HTTP header 中返回状态码,状态码列表请参考 header 中的 HTTP 状态码

此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 接口请求频率
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 正常返回示例
  • 错误码