该接口用于在聊天室中批量删除指定的虚构用户，一次最多删除 100 个虚构用户。

调用频率

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

请求

URL

DELETE https://open.yunxinapi.com/im/v2/room_members/actions/virtual_members

Header

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

查询参数

参数名称	类型	是否必选	描述
room_id	Long	必选	聊天室 ID。
account_ids	Array of strings	必选	需要删除的虚构用户账号列表，一次最多删除 100 个虚构用户。
notification_enabled	Boolean	可选	删除聊天室中的虚构用户是否需要通知，默认为 true（通知）。

响应

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 strings	删除成功的账号列表。	否

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "failed_list": [
            {
                "account_id": "yx1",
                "error_code": 114404,
                "error_msg": "chatroom member is offline"
            },
            {
                "account_id": "yx2",
                "error_code": 114404,
                "error_msg": "chatroom member is offline"
            }
        ],
        "success_list": []
    }
}

错误码

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