聊天室标签禁言 - 即时通信

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

room_id

integer <long>

聊天室 ID

必需

聊天室 ID。

operator_account_id

string

操作者账号 ID

必需

操作者账号 ID。

target_tag

string

目标标签

必需

需要禁言的目标标签。

chat_banned

boolean

禁言状态

必需

是否设置为禁言状态。true：设置为禁言状态；false：取消禁言状态。

chat_banned_duration

integer <long>

临时禁言的时间

必需

设置临时禁言的时间（秒）。chat_banned 为 true 时，该参数必填。禁言时间最大不能超过 2592000 秒（30天）。

notification_enabled

boolean

是否发送通知消息

可选

操作完成后是否发送通知消息。false（默认）：不发送；true：发送。

notification_extension

string

通知扩展字段

可选

通知扩展字段，JSON 格式，长度上限为 2048 位字符。

notification_target_tags

string

目标标签表达式

可选

禁言通知的目标标签表达式，默认发送给target_tag标签下的用户。例如 {"tag":"26333816"} AND {"tag":"243680"}

示例

{
  "operator_account_id": "hzwanglei2014",
  "chat_banned": true,
  "notification_target_tags": "{\"tag\":\"tag1\"}",
  "notification_extension": "dolore",
  "notification_enabled": true,
  "target_tag": "test01",
  "chat_banned_duration": 3000
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://open.yunxinapi.com/im/v2/room_members/actions/chat_banned_tagged_members' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operator_account_id":"hzwanglei2014",
    "chat_banned":true,
    "notification_target_tags": "{\"tag\":\"tag1\"}",
    "notification_extension": "dolore",
    "notification_enabled":true,
    "target_tag": "test01",
    "chat_banned_duration":3000
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

mute_duration

integer

禁言时长。

必需

示例

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

🟢200成功

🟢200请求参数错误

🟢200服务器错误