删除用户组
调用该接口删除指定用户组。
注意事项
- 应用的通讯录权限范围必须为全部员工,否则会调用失败。了解应用通讯录权限范围,可参见权限范围资源介绍。
- API 方式暂不支持删除动态用户组。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/contact/v3/group/:group_id |
| HTTP Method | DELETE |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | contact:group 更新用户组信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
group_id | string | 需删除的用户组 ID。 用户组 ID 可在创建用户组时从返回值中获取,你也可以调用查询用户组列表接口,获取用户组的 ID。 示例值:"g1837191" |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 40003 | internal error | 内部错误,你可以获取请求的 X-Request-Id,并联系技术支持。 |
| 400 | 42002 | invalid group_id | 用户组 ID 无效。请检查传入的用户组 ID 是否正确,你可以调用查询用户组列表接口,获取用户组的 ID。 |
| 403 | 42009 | no user group authority error | 应用没有全部员工权限。应用的通讯录权限范围必须为全部员工,否则会调用失败。了解应用通讯录权限范围,可参见权限范围资源介绍。 |
| 400 | 42017 | group has member not allow delete | 用户组中还有成员时无法删除。你可以按照以下步骤移除用户组的成员。 1. 调用查询用户组成员列表接口,获取成员 ID。 2. 调用移除用户组成员接口,移除成员。 注意:移除用户组成员接口目前仅能移除用户。如需移除部门请联系企业管理员,在管理后台操作移除。 |
| 400 | 42015 | user group disable | 用户组功能未开启。请联系技术支持处理。 |
更多错误码信息,参见通用错误码。
