跳到主要内容

禁言指定群成员

您可调用此接口在指定群组中禁言一个或多个成员。核心能力如下：

  • 在指定的群组中禁言一个或多个用户。
  • 如不指定群组（groupId 可传空），可将用户在其加入的所有群组中禁言。最多支持对 100 个用户设置此状态。如需查询是否已达上限，可调用查询群成员禁言列表接口（/group/user/gag/list.json），将 groupId 传空。
  • 支持设置禁言时长，可设置为固定时长（上限 43,200 分钟）或永久。
  • 禁言状态立即生效。群成员被禁言后可以接收并查看群组中用户聊天信息，但不能通过客户端 SDK 向该群组内发送消息。

用户退出群组后，禁言数据不会清除：

  • 被设置为单人禁言（永久）的用户退出群组后再次加入，禁言状态仍然有效。
  • 被设置为单人禁言（指定时长）的用户退出群组后，在禁言时长内再次加入，禁言状态仍然有效。
提示

服务端（Server API）发送群聊消息接口不受群成员禁言状态的限制。被禁言用户仍可通过 Server API 向该群组中发送消息。详情请参阅发送群聊消息。

请求方法​

POST： https://数据中心域名/group/user/gag/add.json

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

频率限制： 每秒 100 次

正文参数​

HTTP 请求正文支持以下 application/x-www-form-urlencoded 表单参数：

参数类型必传说明
userIdString是用户 ID。支持一次禁言多个用户，最多不超过 20 个。
groupIdString否群组 ID。如果为空，则表示该用户在其加入的所有群组中都将被禁言。
minuteString是禁言时长，以分钟为单位。最大值为 43200 分钟。传 0 表示永久禁言。

请求示例​

HTTP
POST /group/user/gag/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

userId=2582&userId=2583&groupId=16&minute=1

返回结果​

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

返回值返回类型说明
codeNumber返回码，200 表示请求成功。

返回结果示例​

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

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