即时通信

拉黑聊天室成员

PATCH

/im/v2/room_members/{account_id}/actions/blocked

请求参数

Path 参数

account_id

string

必需

需要拉黑或取消拉黑的成员账号 ID。

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。

blocked

boolean

是否拉黑

必需

是否拉黑。true：设置为拉黑状态；false：取消拉黑状态。

notification_enabled

boolean

是否发送通知消息

可选

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

notification_extension

string

通知扩展字段

可选

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

示例

{
  "room_id": 79,
  "operator_account_id": "88",
  "blocked": false,
  "notification_enabled": true,
  "notification_extension": "dolor officia"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://open.yunxinapi.com/im/v2/room_members//actions/blocked' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "room_id": 79,
    "operator_account_id": "88",
    "blocked": false,
    "notification_enabled": true,
    "notification_extension": "dolor officia"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

示例

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

🟢200成功

🟢200请求参数错误

🟢200服务器错误

修改于 2024-02-26 02:29:57

查询聊天室的禁言列表

聊天室标签禁言