即时通信 IM 批量禁言和取消禁言 - 服务端 API

功能说明

• App 管理员禁止指定群组中某些用户在一段时间内发言。
• App 管理员取消对某些用户的禁言。
• 被禁言用户退出群组之后再进入同一群组，禁言仍然有效。

接口调用说明

适用的群组类型

即时通信 IM 内置以上四种群组类型，详情请参阅 群组系统。

说明：

Private（即新版本中的 Work，好友工作群）类型不支持禁言。

请求 URL 示例

https://console.tim.qq.com/v4/group_open_http_svc/forbid_send_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

200次/秒。

请求包示例

• 设置禁言
  可以通过 ShutUpTime 设置禁言时间，对指定用户禁言。

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "Members_Account": [ // 最多支持500个
        "peter",
        "leckie"
    ],
    "ShutUpTime": 60 // 禁言时间，单位为秒
  }

• 取消禁言
  如果要取消禁言，将 ShutUpTime 设为0。

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "Members_Account": [ // 最多支持 500 个
        "peter",
        "leckie"
    ],
    "ShutUpTime": 0 // 为0时表示取消禁言
  }

请求包字段说明

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

通过 REST API在线调试工具 调试本接口。

参考

获取被禁言群成员列表（v4/group_open_http_svc/get_group_shutted_uin）