功能说明
App 管理员可以通过该接口封禁群组成员，封禁后成员无法接收消息，并且封禁时间内无法再次进群。
说明：
封禁功能支持需要终端 SDK 6.6 增强版及以上版本、Web SDK v2.22.0及以上版本，需 购买旗舰版或企业版套餐包 并在 控制台 > 群功能配置 > 群功能配置 > 直播群封禁成员 打开开关后方可使用。
接口调用说明
适用的群组类型
群组类型 ID | 是否支持此 REST API |
Private | 支持，同新版本中的 Work（好友工作群） |
Public | 支持 |
ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
AVChatRoom | 支持 |
Community（社群） | 支持 |
请求 URL 示例
https://xxxxxx/v4/group_open_http_svc/ban_group_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com首尔： adminapikr.im.qcloud.com法兰克福： adminapiger.im.qcloud.com硅谷： adminapiusa.im.qcloud.com雅加达： adminapiidn.im.qcloud.com |
v4/group_open_http_svc/ban_group_member | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | 必须为 App 管理员账号，更多详情请参见 。 |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
最高调用频率
200次/秒。
请求包示例
基础形式：封禁群成员。
{"GroupId": "@TGS#aJRGC4MH6", // 封禁成员的群id"Members_Account":["brennanli3", "brennanli12"], //封禁成员的id，单次请求最大20个限制"Duration":3600, //封禁时长，单位是秒"Description": "you are banned because of irregularities" //封禁信息，最大长度1000字节}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
GroupId | String | 必填 | 封禁成员的群 ID。 |
Members_Account | Array | 必填 | 封禁的群成员账号 ID，单次请求最大20个。 |
Duration | Integer | 必填 | 封禁时长，单位：秒，无符号32位数字。 |
Description | String | 选填 | 封禁信息，最大长度1000字节。 |
TopicId | String | 选填 | 仅私密话题支持。 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果： OK： 表示处理成功。 FAIL： 表示处理失败。 |
ErrorCode | Integer | 错误码： 0：表示成功。 非0：表示失败。 |
ErrorInfo | String | 错误信息。 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码 | 描述 |
10002 | 服务器内部错误，请重试。 |
10003 | 请求命令字非法。 |
10004 | 参数非法，请根据错误描述检查请求是否正确。 |
10005 | 封禁成员超过单次请求20个的最大限制。 |
10007 | 操作权限不足，例如 控制台开关没打开 或者 操作账号不是 Root 账号。 |
