该接口用于批量查询指定的聊天室固定成员信息。

调用频率

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

请求

URL

GET https://open.yunxinapi.com/im/v2/room_members/:{room_id}/actions/batch

Header

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

路径参数

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

查询参数

参数名称	类型	是否必选	描述
account_ids	Array of strings	必选	需要查询的聊天室成员列表，一次最多查询 200 个账号。

响应

Header

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

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
+ data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
+ failed_list	Array of objects	查询失败的账号列表。	否
account_id	String	用户账号 ID。	否
error_code	Integer	查询失败的错误码。	否
error_msg	String	查询失败的错误信息。	否
+ success_list	Array of objects	查询成功的成员信息列表。	否
account_id	String	在线成员的账号 ID。	是
room_nick	String	成员在聊天室中的昵称。	否
room_avator	String	成员在聊天室中的头像。	否
extension	String	成员信息扩展字段。	否
member_role	Integer	成员角色类型。 0：普通用户；1：创建者；2：管理员；3：普通游客；4：匿名游客。	是
member_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	通知标签，只有在线成员且登录时指定了标签才会有此字段	否

响应体示例

json{
    "code": 200,
    "msg": "ok",
    "data": {
        "success_list": [
            {
                "extension": "magna Lorem 01",
                "account_id": "yx1",
                "room_nick": "黄涛03",
                "room_avatar": "incididunt ad",
                "member_role": "MANAGER",
                "is_online": false,
                "blocked": false,
                "chat_banned": false,
                "temp_chat_banned": false
            }
        ],
        "failed_list": [
            {
                "account_id": "yx6",
                "error_code": 114404,
                "error_msg": "chatroom member does not exist"
            }
        ]
    }
}

错误码

错误码	错误码描述	错误信息示例
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