跳到主要内容

设置超级群全体禁言

设置指定的超级群(或频道)的禁言状态,支持设为禁言或取消禁言。

  • 设置超级群全体禁言后,该超级群的所有成员均不能往该超级群及频道中发送消息。
  • 设置超级群频道全体禁言后,该超级群的所有成员均不能往该超级群频道中发送消息。
提示
  • 超级群(或频道)解散再创建,禁言状态仍然有效。
  • 服务端(Server API)发送超级群消息接口不受全体禁言状态的限制,被禁言用户可通过 Server API 往该超级群中发送消息。

如需添加例外用户,请使用禁言白名单。详见加入超级群全体成员禁言白名单

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

请求方法

POST: https://数据中心域名/ultragroup/globalbanned/set.json

频率限制: 每秒钟限 100 次

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

正文参数

HTTP 请求正文中可包含如下 HTTP 表单参数:

参数类型必传说明
groupIdString超级群 ID
busChannelString频道 ID。
statusStringtrue 为已禁言状态。false 为未被禁言状态。

请求示例

POST /ultragroup/globalbanned/set.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=abcdefg&status=true

返回结果

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

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

返回结果示例

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

{"code":200}