跳到主要内容

禁言指定超级群成员

在指定超级群（或指定频道）或全部频道中，禁言一个或多个用户。

  • 设置用户在超级群（groupId）禁言后，该成员不能通过客户端 SDK 往该超级群及频道中发送消息。设置用户在超级群频道（busChannel）禁言后，该成员不能通过客户端 SDK 往该超级群频道中发送消息。
  • 服务端（Server API）发送超级群消息接口不受禁言状态的限制，被禁言用户可通过 Server API 往该超级群中发送消息。
  • 用户退出超级群，禁言数据不会清除。被设置为单人禁言的用户即使退出超级群，再次加入时，禁言状态仍然有效。
  • 如果需要将用户在所有频道中都设置为禁言，可不指定频道 ID（busChannel 传空）。请注意，单个 App Key 下最多支持将 100 人设置为在超级群全部频道中禁言。如需查询是否已达上限，您可以在调用查询超级群成员禁言列表接口（/ultragroup/userbanned/get.json）时将 busChannel 传空。
提示

如果您的 App 业务需要同时使用超级群的单人禁言、全体禁言、全体禁言白名单功能（在群级别或频道级别禁言指定成员，以及设置群或频道的禁言白名单），可参考加入超级群禁言白名单中的同时使用超级群单人禁言服务。

如 API 行为不符合预期，请参见关于超级群禁言服务行为变更的说明。

请求方法​

POST： https://数据中心域名/ultragroup/userbanned/add.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

请求示例​

参数类型必传说明
groupIdString是超级群 ID。
busChannelString否频道 ID。
userIdsString是用户 ID 列表，每次最多不超过 20 个用户，以逗号分隔。

请求示例​

POST /ultragroup/userbanned/add.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

groupId=abcdefg&userIds=userId_001,userId_002

返回结果​

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值返回类型说明
codeNumber返回码，200 为正常。

返回结果示例​

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}
最后于 更新