该接口用于分页查询指定聊天室中的在线成员列表。

聊天室中的成员包括固定成员（创建者、管理员以及普通成员）和非固定成员（临时成员，即游客）。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求

URL

GET https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/actions/list_online_members

Header

请求 Header 的参数说明请参见请求 Header。

路径参数

参数名称	类型	是否必选	描述
room_id	String	必选	聊天室 ID。

查询参数

参数名称	类型	是否必选	描述	默认值
member_roles	String	可选	需要查询的聊天室成员类型。0：普通用户；1：创建者；2：管理员；3：普通游客；4：匿名游客	"0,1,2,3,4"，即查询全部在线成员
offset	Long	必选	查询的偏移量，首次查询传入 0，后续查询传入上一次查询结果中的 offset。	-
limit	Integer	必选	每页返回的成员数上限，最大为 100。小于等于 0，或者大于 100，会报 414 错误。	-

响应

Header

响应 Header 的参数说明请参见响应 Header。

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
+ data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
has_more	Boolean	是否还有更多数据。	是
offset	Long	下一页的分页标识符。	否
+ items	Array of objects	在线成员信息列表。	否
account_id	String	在线成员的账号 ID。	是
room_nick	String	成员在聊天室中的昵称。	否
room_avator	String	成员在聊天室中的头像。	否
extension	String	成员信息扩展字段。	否
member_role	String	成员角色类型。 0：普通用户；1：创建者；2：管理员；3：普通游客；4：匿名游客。	是
level	Integer	成员级别。	否
is_online	Boolean	是否在线，true：在线；false：不在线。	是
enter_time	Long	进入聊天室的时间戳。	否
blocked	Boolean	是否在聊天室黑名单中，true：在黑名单；false：不在。	是
chat_banned	Boolean	是否被禁言，true：被禁言；false：未被禁言。	是
temp_chat_banned	Boolean	是否被临时禁言，true：被临时禁言；false：未被临时禁言。	是
temp_chat_banned_time	Long	临时禁言的时长，单位秒。	否
tags	String	用户标签，只有在线成员且登录时指定了标签才会有此字段	否
notify_target_tags	String	通知标签，只有在线成员且登录时指定了标签才会有此字段	否
online_count	Integer	当前在线的成员数。	否
+ online_info_list	Array of objects	该客户端中的在线成员信息。	是
room_nick	String	该客户端中的成员昵称。	否
room_avatar	String	该客户端中的成员头像。	否
enter_time	Long	该成员进入聊天室的时间。	否
client_type	Integer	进入聊天室的客户端类型。	否

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "has_more": false,
        "items": [{
            "extension": "extension",
            "account_id": "yx32",
            "room_nick": "yx32",
            "room_avatar": "https://nim-nosdn.netease.im/MTAxMTAxMA\u003d\u003d/bmltd18wXzE2OTA5NDgwMDM2MTVfNDI4NDFiYjMtYTI1Yi00Y2UxLThmMWQtYzZhM2UyNDE0MDU5",
            "member_role": "TEMPORARY",
            "is_online": true,
            "enter_time": 1698657572668,
            "blocked": false,
            "chat_banned": false,
            "temp_chat_banned": false,
            "online_info_list": [{
                "room_nick": "yx32",
                "room_avatar": "https://nim-nosdn.netease.im/MTAxMTAxMA\u003d\u003d/bmltd18wXzE2OTA5NDgwMDM2MTVfNDI4NDFiYjMtYTI1Yi00Y2UxLThmMWQtYzZhM2UyNDE0MDU5",
                "enter_time": 1698657572668,
                                "client_type": 1
            }],
            "online_count": 1
        }]
    }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
113404	聊天室不存在	chatroom not exist
113410	聊天室服务未开通	chatroom service disabled
113406	聊天室已关闭	chatroom closed
500	服务端内部错误	internal server error
503	服务器繁忙	server busy