# 将用户移出群聊
将用户移出群聊。
注意事项:
- 可以用户身份调用
- 需要符合有效性,操作人(机器人/用户)在群里且具备管理员权限
- 部门群不允许移出人
- 不允许自己移出自己
# 请求
基本 | |
---|---|
HTTP URL | https://hi-gw.weizhipin.com/open-apis/im/v2/chats/:chat_id/members |
HTTP Method | DELETE |
支持的应用类型 | 自建应用商店应用 |
权限要求 | 获取与更新群组信息 |
# 请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token "示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" |
Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
# 路径参数(url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值)
名称 | 类型 | 描述 |
---|---|---|
chat_id | string | 群 ID[群ID 说明] 示例值:"oc_a0553eda9014c201e6969b478895c230" |
# 查询参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
user_id_type | string | 否 | 用户 ID 类型示例值:"open_id" 可选值有: open_id:用户的 open id union_id:用户的 union id user_id:用户的 user id email:用户的邮箱 默认值:open_id |
# 请求体
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
user_ids | string[] | 是 | 用户 ID 集合 |
# 请求体示例
{
"user_ids": ["zenglinhong@kanzhun.com"]
}
1
2
3
2
3
# 响应
# 响应体
名称 | 类型 | 描述 |
---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | - | - |
∟failed_users | string[] | 失败的成员列表 |
# 响应体示例
{
"code": 0,
"success": true,
"data": {
"failed_users": []
},
"msg": "操作成功",
"traceId": "0c4e904a-a079-44ec-9198-4c3b68d8f382"
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9