批量删除执行者
该接口用于批量删除执行者。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/task/v1/tasks/:task_id/batch_delete_collaborator |
| HTTP Method | POST |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | task:task 查看、创建、编辑和删除任务(旧版) |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
task_id | string | 任务ID 示例值:"83912691-2e43-47fc-94a4-d512e03984fa" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id_type | string | 否 | 用户 ID 类型 示例值:open_id 可选值有: - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
id_list | string\[\] | 否 | 执行者的用户ID列表。 传入的值为 user_id 或 open_id,由user_id_type 决定。user_id和open_id的获取可见文档如何获取不同的用户 ID。 示例值:["ou_99e1a581b36ecc4862cbfbce473f3123"] |
请求体示例
json
{
"id_list": ["ou_13585843f02bc94923ed17a007cbc9b1", "ou_f4506885e436763c36e03c05ef1bd6f8"]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ collaborators | string\[\] | 实际删除的执行人用户ID列表 |
响应体示例
json
{
"code": 0,
"data": {
"collaborators": [
"ou_13585843f02bc94923ed17a007cbc9b1",
"ou_f4506885e436763c36e03c05ef1bd6f8"
]
},
"msg": ""
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 403 | 1470403 | The identity token is incorrect. It should be either user_access_token or tenant_access_token. | 发起请求方的身份token不正确,需要为UserAccessToken或TenantAccessToken其中一种 |
| 400 | 1470450 | request too fast | 当前同时发起的请求过多,峰值较高导致了限流,请稍后重新尝试 |
| 400 | 1470451 | request api concurrently | 对同一个任务的操作请求太频繁,需要降低请求频次 |
| 400 | 1470602 | Invalid task id. | 请检查任务的 id 是否合法 |
| 500 | 1470702 | failed to delete task collaborator | 移除指定的任务执行者失败,请结合返回的具体错误进行排查。如果无法解决,请提供 request id 并联系飞书技术人员协助排查 |
| 400 | 1470404 | be refused to create or update task | 一般是因为操作者没有操作权限,导致更新任务或其他更新任务的操作失败。如,任务的关注者没有权限修改任务。 |
