即时通信

聊天室禁言

开发中

PATCH

/im/v2/chatrooms/{room_id}/actions/chat_banned

请求参数

Path 参数

room_id

string

必需

需要设置整体禁言的聊天室 ID，聊天室创建成功后，云信会返回聊天室 ID。

示例值:

1605537145

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

operator_account_id

string

必需

chat_banned

boolean

必需

notification_enabled

boolean

可选

notification_extension

string

可选

示例

{
    "operator_account_id": "yx29",
    "chat_banned": true,
    "notification_extension": "et ipsum reprehenderit",
    "notification_enabled": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://open.yunxinapi.com/im/v2/chatrooms/1605537145/actions/chat_banned' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operator_account_id": "yx29",
    "chat_banned": true,
    "notification_extension": "et ipsum reprehenderit",
    "notification_enabled": true
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

示例

{
    "code": 200,
    "msg": "success",
    "data": {}
}

开放/关闭聊天室

开启/关闭进出聊天室事件通知