删除群组成员

最近更新时间:2019-08-02 18:08:37

功能说明

App 管理员可以通过该接口删除群成员。

接口调用说明

适用的群组类型

群组类型 支持此 REST API
私有群(Private)
公开群(Public)
聊天室(ChatRoom)
音视频聊天室(AVChatRoom) 否(见下方说明)
在线成员广播大群(BChatRoom) 否(见下方说明)

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

说明:

  • 音视频聊天室不支持删除群成员,对这种类型的群组进行操作时会返回10004错误。如果管理员希望达到删除群成员的效果,可以通过设置 批量禁言和取消禁言 的方式实现。
  • 在线成员广播大群也不支持删除群成员,对这种类型的群组进行操作时同样会返回10004错误。且该类型群组只支持 App 管理员推送广播消息。

请求 URL示例

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

请求参数说明

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

参数 说明
v4/group_open_http_svc/delete_group_member 请求接口
sdkappid 创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier 必须为 App 管理员帐号,更多详情请参见 App 管理员
usersig App 管理员帐号生成的签名,具体操作请参见 生成 UserSig
random 请输入随机的32位无符号整数

最高调用频率

100次/秒。如需提升调用频率,请根据 工单模板 提交工单申请处理。

请求包示例

  • 基础形式
    用来向群中进行删除群成员,一次请求最多支持删除500个成员。后台默认情况下会给群中所有成员下发删除群成员系统通知(除没有激活的 Private 类型群组外)。
    如果删除的用户原本就不在群组中,该接口依然返回成功。
    {
      "GroupId": "@TGS#2J4SZEAEL", // 要操作的群组(必填)
      "MemberToDel_Account": [ // 要删除的群成员列表,最多500个
          "tommy",
          "jared"
      ]
    }
  • 静默删人
    当 Silence 为1时,成员成功删除后,不会给任何人下发系统通知。
    {
      "GroupId": "@TGS#2J4SZEAEL", // 要操作的群组(必填)
      "Silence": 1, // 是否静默删除(选填)
      "MemberToDel_Account": [ // 要删除的群成员列表,最多500个
          "tommy",
          "jared"
      ]
    }
  • 指定踢出原因
    指定踢出用户的原因,会在下发通知中体现。
    {
      "GroupId": "@TGS#2J4SZEAEL", // 要操作的群组(必填)
      "Reason": "kick reason", // 踢出用户原因(选填)
      "MemberToDel_Account": [ // 要删除的群成员列表,最多500个
          "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

可能触发的回调

群成员离开之后回调