即时通信

删除聊天室虚构用户

DELETE

/im/v2/room_members/actions/virtual_members

请求参数

Query 参数

room_id

integer

聊天室 ID。

必需

account_ids

array[string]

必需

需要删除的虚构用户账号列表，一次最多删除 100 个虚构用户。

notification_enabled

boolean

可选

删除聊天室中的虚构用户是否需要通知，默认为 true（通知）。

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request DELETE 'https://open.yunxinapi.com/im/v2/room_members/actions/virtual_members?room_id&account_ids&notification_enabled' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢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": "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成功

🟢200请求参数错误

🟢200服务器错误

添加聊天室虚构用户

清空聊天室虚构用户