查询某个房间的当前在线人员列表。使用该接口，您可以方便地获取某个房间的实时在线人数和人员信息，相关数据可以用于展示在您的业务系统中，方便您根据实时在线人员的情况，进行业务调度等操作。

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

请求

URI

GET https://{endpoint}/v3/rooms/:room_archive_id/online_user_list?page_number=:page_number&page_size=:page_size

{endpoint} 为 NERoom 接入地址的域名，默认为 roomkit.netease.im。如果您的应用主要服务于海外用户，请将域名设置为海外数据中心域名（roomkit-sg.netease.im）。

Header

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

路径参数

参数名称	类型	是否必选	示例	描述
room_archive_id	String	是	4***251	创建房间时，NERoom 服务端自动生成的一个用于标识房间的 ID，全局唯一，最大长度36个字符。 获取方法请参见创建房间 中的返回参数。

Query 参数

参数名称	类型	是否必选	示例	描述
page_number	Integer	否	1	查询页码，从 1 开始。如果参数为空，默认查询第 1 页。
page_size	Integer	否	10	每页显示个数，最大支持 50 个。如果参数为空，默认显示 10 个。

请求示例

javahttps://roomkit.netease.im/neroom/v3/rooms/123/online_user_list?page_number=1&page_size=10

响应

响应参数

参数名称	类型	示例	描述
code	Integer	0	状态码，0表示成功，具体请参见错误码。
msg	String	Success	业务结果描述，Success 表示成功。
ts	Long	1648021056815	NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
request_id	String	7c4b6d9c3e9d42*****cc6e3a4d995	请求的唯一标识。
cost	String	48ms	处理该请求所消耗的时间。
+ data	Object	-	在线成员列表。
total_count	Integer	100	房间人数总数。
page_total	Long	10	总页数 。
+ users	Array of Object	-	用户列表。
user_uuid	String	user01	用户 ID。
name	String	userName01	用户名称。
role	String	host	对应 NERoom 模板中的角色 ID。

响应体示例

java{
    "code":0,
    "msg":"Success",
    "ts":1619068087795,
    "request_id":"6e507107d1f4447ea731f651dc6d2432",
    "cost":"66ms"，
        "data": {
        "total_count":1000，
        "page_total":100,
        "users":[
            {
                "user_uuid":"user01"，
                "name":"Name***",
                "role":"host"
            },
            {
                "user_uuid":"user02"，
                "name":"Name***",
                "role":"host"
            }            
        ]
    }
}

错误码

错误码	错误信息	说明	处理建议
0	Success	请求成功	无需处理
400	Invalid parameter.	参数错误	检查接口传参
1004	Room not found.	房间不存在或者已关闭	根据业务场景处理