即时通信

添加聊天室虚构用户

POST

/im/v2/room_members/actions/virtual_members

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

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"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open.yunxinapi.com/im/v2/room_members/actions/virtual_members' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "notification_enabled": true,
    "room_id": 72,
    "virtual_members": {
        "account_id": "abcffr"
    },
    "extension": "veniam ex ullamco labore"
}'

返回响应

🟢200成功

application/json

Body

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"
        ]
    }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误

批量查询聊天室固定成员信息

删除聊天室虚构用户