动态与公告

产品动态

公告

产品简介

产品概述

基本概念

应用场景

功能介绍

账号系统

用户资料与关系链

消息管理

群组相关

公众号系统

音视频通话 Call

使用限制

购买指南

计费概述

价格说明

购买指引

续费指引

停服说明

退费说明

开发指引

Demo 专区

开通服务

体验 Demo

快速跑通

下载中心

SDK & Demo 源码

更新日志

聊天互动（含 UI）

TUIKit 组件介绍

快速开始

全功能接入

单功能接入

AI 集成

构建基础界面

更多特性

定义外观

国际化界面语言

推送服务（Push）

服务概述

名词解释

开通服务

快速跑通

厂商通道

数据统计

排查工具

客户端 API

服务端 API

推送回调

高级功能

更新日志

错误码

常见问题

智能客服

功能概述

快速入门

集成指引

管理员操作手册

客服操作手册

更多实践

直播间搭建

AI 聊天机器人方案

超大娱乐协作社群

Discord 实现指南

游戏内集成 Chat 指南

类 WhatsApp Channel 搭建方案

发送红包

Chat 应对防火墙限制相关

无 UI 集成

快速开始

集成 SDK

初始化

登录登出

消息相关

会话相关

群组相关

社群话题

用户管理

离线推送

云端搜索

本地搜索

公众号

客户端 API

JavaScript

Android

iOS & macOS

Swift

Flutter

Electron

Unity

React Native

C 接口

C++

服务端 API

生成 UserSig

REST API

第三方回调

控制台指南

新版控制台介绍

创建并升级应用

基本配置

功能配置

账号管理

群组管理

公众号管理

回调配置

用量统计

资源包查看指南

实时监控

开发辅助工具

访问管理

高级功能

常见问题

uni-app 常见问题

购买相关问题

SDK 相关问题

账号鉴权相关问题

用户资料与关系链相关问题

消息相关问题

群组相关问题

直播群相关问题

昵称头像相关问题

协议与认证

服务等级协议

安全合规认证

IM 政策

隐私政策

数据隐私和安全协议

平滑迁移方案

平滑迁移完整版

平滑迁移简化版

错误码

联系我们

群成员封禁

PDF

聚焦模式

字号

最后更新时间： 2025-10-23 11:58:56

功能说明
 App 管理员可以通过该接口向群组封禁成员，封禁后成员无法接收消息，并且封禁时间内无法再次进群。
说明：
封禁功能支持需要终端 SDK 6.6 增强版及以上版本、Web SDK v2.22.0及以上版本，需 购买专业版、专业版plus和企业版 并在 控制台 > 群功能配置 > 群功能配置 > 直播群封禁成员 打开开关后方可使用。
接口调用说明
适用的群组类型
群组类型 ID
支持此 REST API
Private
支持，同新版本中的 Work（好友工作群）
Public
支持
ChatRoom
支持，同新版本中的 Meeting（临时会议群）
AVChatRoom
支持
Community（社群）
支持
即时通信 Chat内置上述群组类型，详情介绍请参见 群组系统。
请求 URL 示例
https://xxxxxx/v4/group_open_http_svc/ban_group_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔： adminapikr.im.qcloud.com
东京：adminapijpn.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/group_open_http_svc/ban_group_member
请求接口
sdkappid
创建应用时即时通信Chat  控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员﻿
usersig
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字节
应答包体示例
{
    "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 账号
接口调试工具
通过 REST API 在线调试工具 调试本接口。

帮助和支持

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

填写满意度调查问卷，共创更好文档体验。

文档反馈

tencent cloud

即时通信 IM

群成员封禁

功能说明

接口调用说明

适用的群组类型

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

基础形式

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具

帮助和支持

群组类型 ID	支持此 REST API
Private	支持，同新版本中的 Work（好友工作群）
Public	支持
ChatRoom	支持，同新版本中的 Meeting（临时会议群）
AVChatRoom	支持
Community（社群）	支持

参数	说明
xxxxxx	SDKAppID 所在国家/地区对应的专属域名：中国：`console.tim.qq.com` 新加坡：`adminapisgp.im.qcloud.com` 首尔： `adminapikr.im.qcloud.com` 东京：`adminapijpn.im.qcloud.com` 法兰克福：`adminapiger.im.qcloud.com` 硅谷：`adminapiusa.im.qcloud.com` 雅加达：`adminapiidn.im.qcloud.com`
v4/group_open_http_svc/ban_group_member	请求接口
sdkappid	创建应用时即时通信Chat 控制台分配的 SDKAppID
identifier	必须为 App 管理员账号，更多详情请参见 App 管理员
usersig	App 管理员账号生成的签名，具体操作请参见生成 UserSig
random	请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype	请求格式固定值为`json`

字段	类型	属性	说明
GroupId	String	必填	封禁成员的群 ID
Members_Account	Array	必填	封禁的群成员账号 ID，单次请求最大20个
Duration	Integer	必填	封禁时长，单位秒，无符号32位数字
Description	String	选填	封禁信息，最大长度1000字节

错误码	描述
10002	服务器内部错误，请重试
10003	请求命令字非法
10004	参数非法，请根据错误描述检查请求是否正确
10005	封禁成员超过单次请求20个的最大限制
10007	操作权限不足，例如控制台开关没打开或者操作账号不是 root 账号