功能描述

该接口用于在指定聊天室中批量添加虚构用户，虚构用户过期时间为 24 小时。

• 虚构用户通常只用于增加聊天室在线人数，不用于正常交流。
• 同一个虚构用户账号可以同时加入多个不同的聊天室（不限数量）。
• 虚构用户24小时后会自动退出聊天室，如果在24小时内重复添加则重新计时。

调用频率

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

请求

URL

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

Header

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

请求体参数

参数名称	类型	是否必选	描述
room_id	Long	必选	聊天室 ID。
+ virtual_members	Array of objects	必选	需要添加的虚构用户列表，一次最多添加 200 个虚构用户。
account_id	String	必选	虚构用户账号 ID。
room_nick	String	可选	虚构用户昵称。
room_avatar	String	可选	虚构用户头像。
extension	String	可选	虚构用户信息扩展字段，JSON 格式，长度限制为 4096 字符。例如 {"test":"聊天室自定义信息"}。
notification_enabled	Boolean	可选	虚构用户进入聊天室是否需要通知，默认为 true（通知）。
notification_extension	String	可选	虚构用户进入聊天室的通知扩展字段，JSON 格式，长度限制为 2048 字符。

请求体示例

json{
    "notification_enabled": true,
    "room_id": 72,
    "virtual_members": {
        "account_id": "abcffr"
    },
    "extension": "veniam ex ullamco labore"
}

响应

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": "哈哈哈",
                "error_code": 414,
                "error_msg": "invalid parameter: account_id"
            }
        ],
        "success_list": [
            "yx1"
        ]
    }
}

错误码

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