查询在线人员列表

更新时间: 2023/07/18 09:25:57

查询房间的当前在线人员列表。

使用场景:如果您的业务系统中需要展示各个房间的实时在线人员,您可以调用该接口查询对应房间的在线人员情况。

已结束的房间无法通过该接口查询在线人员列表。

接口请求地址

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

URL 中参数说明

请求 Header 的设置请参见 请求结构

参数名称 类型 是否必选 示例 描述
roomArchiveId String 4***251 创建房间时,NERoom 服务端自动生成的一个用于标识房间的 ID,全局唯一,最大长度36个字符。
获取方法请参见创建房间 中的返回参数。
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 Long 10 总页数 。
data.users List - 用户列表。
data.users.userUuid String user01 用户 ID。
data.users.name String userName01 用户名称。
data.users.role String host 对应 NERoom 模板中的角色 ID。

示例

请求示例

javahttps://roomkit.netease.im/apps/v2/online-user-list?roomArchiveId=133456&pageNumber=1&pageSize=10

返回示例

java{
    "code":0,
    "msg":"Success",
    "ts":1619068087795,
    "requestId":"6e507107d1f4447ea731f651dc6d2432",
    "cost":"66ms""data": {
        "totalCount":1000"pageTotal":100,
        "users":[
            {
                "userUuid":"user01""name":"Name***",
                "role":"host"
            },
            {
                "userUuid":"user02""name":"Name***",
                "role":"host"
            }            
        ]
    }
}
此文档是否对你有帮助?
有帮助
去反馈
  • 接口请求地址
  • URL 中参数说明
  • 返回参数
  • 示例
  • 请求示例
  • 返回示例