tencent cloud

功能说明

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

接口调用说明

适用的群组类型

即时通信 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 简介。

最高调用频率

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"
    ]
  }
  

请求包字段说明

应答包体示例

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

应答包字段说明

错误码说明

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

接口调试工具

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

参考

增加群成员（v4/group_open_http_svc/add_group_member）

可能触发的回调

群成员离开之后回调