Tencent Cloud

删除群成员

最后更新时间：2024-07-16 11:15:59

功能说明
 App 管理员可以通过该接口删除群成员。
接口调用说明
适用的群组类型
群组类型 ID
是否支持此 REST API
Private
支持，同新版本中的 Work（好友工作群）
Public
支持
ChatRoom
支持，同新版本中的 Meeting（临时会议群）
AVChatRoom
不支持
Community（社群）
支持
即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。
说明
AVChatRoom（直播群）不支持删除群成员，对这种类型的群组进行操作时会返回10004错误。如果管理员希望达到删除群成员的效果，可以通过设置 批量禁言和取消禁言 的方式实现。
请求 URL 示例
https://xxxxxx/v4/group_open_http_svc/delete_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
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/group_open_http_svc/delete_group_member
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员﻿
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig﻿
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json
最高调用频率
200次/秒。
请求包示例
基础形式。
用来向群中进行删除群成员，一次请求最多支持删除100个成员。后台默认情况下会给群中所有成员下发删除群成员系统通知，除已创建但没有激活的 Private（即新版本中的 Work，好友工作群）类型群组外。
如果删除的用户原本就不在群组中，该接口依然返回成功。
{
  "GroupId": "@TGS#2J4SZEAEL", // 要操作的群组（必填）
  "MemberToDel_Account": [ // 要删除的群成员列表，最多100个
      "tommy",
      "jared"
  ]
}
静默删人。
当 Silence 为1时，成员成功删除后，不会给任何人下发系统通知。
{
  "GroupId": "@TGS#2J4SZEAEL", // 要操作的群组（必填）
  "Silence": 1, // 是否静默删除（选填）
  "MemberToDel_Account": [ // 要删除的群成员列表，最多100个
      "tommy",
      "jared"
  ]
}
指定踢出原因。
指定踢出用户的原因，会在下发通知中体现。
{
  "GroupId": "@TGS#2J4SZEAEL", // 要操作的群组（必填）
  "Reason": "kick reason", // 踢出用户原因（选填）
  "MemberToDel_Account": [ // 要删除的群成员列表，最多100个
      "tommy",
      "jared"
  ]
}
请求包字段说明
字段
类型
属性
说明
GroupId
String
必填
操作的群 ID
Silence
Integer
选填
是否静默删人。0表示非静默删人，1表示静默删人。静默即删除成员时不通知群里所有成员，只通知被删除群成员。不填写该字段时默认为0
Reason
String
选填
踢出用户原因
MemberToDel_Account
Array
必填
待删除的群成员
应答包体示例
{
    "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
参数非法，请根据错误描述检查请求是否正确
10007
操作权限不足，例如 Public 群组中普通成员尝试执行踢人操作，但只有 App 管理员才有权限
10010
群组不存在，或者曾经存在过，但是目前已经被解散
10015
群组 ID 非法，请检查群组 ID 是否填写正确
接口调试工具
通过 REST API 在线调试工具 调试本接口。
参考
增加群成员（v4/group_open_http_svc/add_group_member）
可能触发的回调
群成员离开之后回调

tencent cloud

Recent Pages

删除群成员

功能说明

接口调用说明

适用的群组类型

请求 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` 法兰克福：`adminapiger.im.qcloud.com` 硅谷：`adminapiusa.im.qcloud.com` 雅加达：`adminapiidn.im.qcloud.com`
v4/group_open_http_svc/delete_group_member	请求接口
sdkappid	创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier	必须为 App 管理员账号，更多详情请参见 App 管理员
usersig	App 管理员账号生成的签名，具体操作请参见生成 UserSig
random	请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype	请求格式固定值为`json`

字段	类型	属性	说明
GroupId	String	必填	操作的群 ID
Silence	Integer	选填	是否静默删人。0表示非静默删人，1表示静默删人。静默即删除成员时不通知群里所有成员，只通知被删除群成员。不填写该字段时默认为0
Reason	String	选填	踢出用户原因
MemberToDel_Account	Array	必填	待删除的群成员

错误码	描述
10002	服务器内部错误，请重试
10003	请求命令字非法
10004	参数非法，请根据错误描述检查请求是否正确
10007	操作权限不足，例如 Public 群组中普通成员尝试执行踢人操作，但只有 App 管理员才有权限
10010	群组不存在，或者曾经存在过，但是目前已经被解散
10015	群组 ID 非法，请检查群组 ID 是否填写正确

tencent cloud

注册

登录

Recent Pages

删除群成员

功能说明

接口调用说明

适用的群组类型

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具

参考

可能触发的回调

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

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