即时通信

批量禁言群成员

PATCH

/im/v2/team_members/actions/batch_mute

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

team_id

integer

群组 ID。

必需

chat_ban_account_ids

array[string]

需要禁言的群成员账号 ID 列表

必需

一次最多禁言 10 个群成员。

chat_banned

boolean

在本群中是否禁言目标成员列表

必需

false（默认）：不禁言；true：禁言。

team_type

integer

群组类型

必需

1：高级群；2：超大群。

operator_id

string

操作者（群主或管理员）账号 ID

必需

对于高级群，只有群主可以批量禁言群成员。对于超大群，只有群主和管理员可以批量禁言普通群成员。管理员只有群主可以禁言，管理员不能禁言其他管理员。

示例

{
  "team_id": 18573968767,
  "chat_ban_account_ids": [
    "ciaos12",
    "ciaos13"
  ],
  "chat_banned": true,
  "team_type": 1,
  "operator_id": "accid1"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://open.yunxinapi.com/im/v2/team_members/actions/batch_mute' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "team_id": 18573968767,
    "chat_ban_account_ids": ["ciaos12", "ciaos13"],
    "chat_banned": true,
    "team_type": 1,
    "operator_id": "accid1"
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

200 表示请求成功。

msg

string

提示信息

必需

请求失败时返回错误信息，请求成功时返回 "success"。

data

object

返回数据

必需

返回的 JSON 数据对象，请求失败则返回空对象。

success_list

array[string]

禁言成功的用户账号 ID 列表。

必需

failed_list

array [object {3}]

禁言失败的账号列表。

必需

示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "success_list": [
      "account_id1",
      "account_id2"
    ],
    "failed_list": [
      {
        "account_id": "account_id1",
        "error_code": 102404,
        "error_msg": "%s not valid"
      }
    ]
  }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误

修改于 2024-02-26 02:28:02

更新群成员信息

分页查询指定账号已加入的群组信息