添加聊天室虚构用户
POST
/im/v2/room_members/actions/virtual_members请求参数
Body 参数application/json
room_id
integer <long>
聊天室 ID
聊天室 ID。
virtual_members
object
虚构用户列表
需要添加的虚构用户列表,一次最多添加 200 个虚构用户。
account_id
string
虚构用户账号 ID
虚构用户账号 ID。
room_nick
string
虚构用户昵称
虚构用户昵称。
room_avatar
string
虚构用户头像
虚构用户头像。
extension
string
扩展字段
虚构用户信息扩展字段,JSON 格式,长度限制为 4096 字符。例如 {"test":"聊天室自定义信息"}。
notification_enabled
boolean
是否需要通知
虚构用户进入聊天室是否需要通知,默认为 true(通知)。
notification_extension
string
通知扩展字段
虚构用户进入聊天室的通知扩展字段,JSON 格式,长度限制为 2048 字符。
示例
{
"notification_enabled": true,
"room_id": 72,
"virtual_members": {
"account_id": "abcffr"
},
"extension": "veniam ex ullamco labore"
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
code
integer
必需
msg
string
必需
data
object
必需
failed_list
array [object {3}]
可选
添加失败的虚构用户账号列表。
success_list
array[string]
可选
添加成功的账号列表。
示例
{
"code": 200,
"msg": "success",
"data": {
"failed_list": [
{
"account_id": "哈哈哈",
"error_code": 414,
"error_msg": "invalid parameter: account_id"
}
],
"success_list": [
"yx1"
]
}
}
最后修改时间: 8 个月前