设置群组全体禁言
群组业务支持将群成员全体禁言。您可以调用此 API,将指定的群组加入服务端的全体禁言群组列表。
- 将群组加入全体禁言列表后,群组全体禁言立即生效。该群组的所有成员均不能通过客户端 SDK 向该群组内发送消息。
- 即使群组解散再创建,全体禁言状态仍然有效。如需取消,请调用取消群组全体禁言接口。
提示
- 在群禁言用户白名单中的用户仍可通过客户端 SDK 向该群组中发消息。 详情请参阅加入群组全体禁言白名单。
- 服务端(Server API)发送群聊消息接口不受群组全体成员禁言状态的限制。
请求方法
POST: https://数据中心域名/group/ban/add.json
频率限制: 每秒 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详情请参阅 API 请求签名。
正文参数
HTTP 请求正文支持以下 application/x-www-form-urlencoded
表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
groupId | String | 是 | 群组 ID。支持一次设置多个,最多不超过 20 个。 |
请求示例
HTTP
POST /group/ban/add.json HTTP/1.1
Host: api.rong-api.com
App-Key: c9kqb3rdkbb8j
Nonce: 97
Timestamp: 1480479442
Signature: 9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded
groupId=XklWnVzXm&groupId=LklWnVzXq
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 表示请求成功。 |
返回结果示例
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}