查询未结束房间列表

更新时间: 2023/09/12 12:25:18

查询用户最近创建的房间相关信息,包括未开始与正在进行中的房间,按照房间 ID 倒序。

使用场景:如果您的业务系统中需要呈现本 App 最近创建并且还未结束的房间的详细情况,您可以调用该接口。

接口请求地址

  • 请求方法:GET
  • URL:https://roomkit.netease.im/apps/v2/active-room-list?pageNumber={pageNumber}&pageSize={pageSize}

URL 中参数说明

  • 请求中 Header 的设置请参见调用方式中的请求结构
参数名称 类型 是否必选 示例 描述
pageNumber Integer 1 查询页码,从 1 开始。如果参数为空,默认查询第 1 页。
pageSize Integer 10 每页显示个数,最大支持50。如果参数为空,默认显示个数为 10。

返回参数

参数名称 类型 示例 描述
code int 0 状态码,0 表示成功,具体请参见错误码
msg String Success 业务结果描述,Success 表示成功。
ts Long 1648021056815 NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
requestId String 7c4b6d9c3e9d42*****cc6e3a4d995 请求的唯一标识。
cost String 48ms 处理该请求所消耗的时间。
data Object - 房间列表信息。
data.totalCount Integer 100 房间总数。
data.pageTotal Integer 10 总页数 。
data.rooms List - 房间列表。
data.rooms.roomArchiveId String 4***251 创建房间时,NERoom 服务端自动生成的一个用于标识房间的 ID,全局唯一。
data.rooms.roomUuid String NE***10 房间 ID,最大长度36个字符。
data.rooms.templateId Integer 40 模版 ID。
data.rooms.roomName String Name*** 房间名。最大长度为 64 个字符。
data.rooms.uv Integer 100 访问用户数。
data.rooms.pv Integer 200 访问用户人次。
data.rooms.onlineUserCount Integer 50 当前在线人数。

示例

请求示例

javahttps://roomkit.netease.im/apps/v2/active-room-list?pageNumber=1&pageSize=10

返回示例

java{
    "code":0,
    "msg":"Success",
    "ts":1619068087795,
    "requestId":"6e507107d1f4447ea731f651dc6d2432",
    "cost":"66ms",
    "data": {
        "totalCount":"1000""pageTotal":"100",
        "rooms":[
            {
                "roomArchiveId":"4***251""roomUuid":"Name***",
                "templateId":100,
                "roomName":"Name***",
                "uv":100,
                "pv":500,
                "onlineUserCount":50
            },
            {
                "roomArchiveId":"4***252""roomUuid":"Name***",
                "templateId":100,
                "roomName":"Name***",
                "uv":100,
                "pv":500,
                "onlineUserCount":50
            }            
        ]
    }
}
此文档是否对你有帮助?
有帮助
去反馈
  • 接口请求地址
  • URL 中参数说明
  • 返回参数
  • 示例
  • 请求示例
  • 返回示例