API 参考
在线调试

踢人出群

更新时间: 2024/07/17 17:08:56

该接口用于将群成员踢出群组,一次最多可以踢 10 个群成员。

  • 只有群主和管理员才能将普通成员踢出群。
  • 只有群主能踢管理员,管理员之间不能互踢。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

DELETE https://open.yunxinapi.com/im/v2/team_members/actions/kick_member

请求 Header 的参数说明请参见请求 Header

查询参数

参数名称 类型 是否必选 描述
operator_id String 必选 操作者(群主或和管理员)账号 ID。
team_id Long 必选 群组 ID,创建群组成功时,云信服务器会自动生成并返回。
team_type Integer 必选 群组类型。1:高级群;2:超大群。
kick_account_ids Array of strings 必选 踢出群的成员列表。一次最多可以踢 10 个群成员。
extension String 可选 自定义扩展字段,即自定义的通知字段,JSON 格式,不会持久化。长度上限 512 位字符。该字段仅针对高级群,对超大群无效。

响应

Header

响应 Header 的参数说明请参见 响应 Header

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "success_list": [
            "account_id1",
            "account_id2"
        ],
        "failed_list": [
            {
                "account_id": "account_id1",
                "error_code": 102404,
                "error_msg": "%s not valid"
            }
        ]
    }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
416 频率超限 rate limit exceeded
102404 用户不存在 account not exist
108311 超大群服务未开通 super team service disabled
108404 群组不存在 team not exist
109404 群成员不存在 team member not exist
500 服务端内部错误 internal server error
503 服务器繁忙 server busy
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 查询参数
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码