Skip to content

新增执行者

该接口用于新增任务执行者,一次性可以添加多个执行者。 只有任务的创建者和执行者才能添加执行者,关注人无权限添加。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/task/v1/tasks/:task_id/collaborators
HTTP MethodPOST
接口频率限制100 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用task:task 查看、创建、编辑和删除任务(旧版)
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
task_idstring任务 ID,可通过创建任务时响应体中的id字段获取
示例值:"83912691-2e43-47fc-94a4-d512e03984fa"

查询参数

名称类型必填描述
user_id_typestring用户 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

请求体

名称类型必填描述
idstring任务执行者的 ID。 传入的值为 user_id 或 open_id,由user_id_type 决定。user_id和open_id的获取可见文档如何获取不同的用户 ID
> Info: 已经废弃,为了向前兼容早期只支持单次添加一个人的情况而保留,但不再推荐使用,建议使用id_list字段
示例值:"ou_99e1a581b36ecc4862cbfbce473f1234"
id_liststring\[\]执行者的用户ID列表。 传入的值为 user_id 或 open_id,由user_id_type 决定。user_id和open_id的获取可见文档如何获取不同的用户 ID
示例值:["ou_99e1a581b36ecc4862cbfbce473f3123"]

请求体示例

json
{
    "id": "ou_99e1a581b36ecc4862cbfbce473f1234",
    "id_list": [
        "ou_99e1a581b36ecc4862cbfbce473f3123"
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ collaboratorcollaborator返回创建成功后的任务执行者列表
    └ idstring任务执行者的 ID。 传入的值为 user_id 或 open_id,由user_id_type 决定。user_id和open_id的获取可见文档如何获取不同的用户 ID
> Info: 已经废弃,为了向前兼容早期只支持单次添加一个人的情况而保留,但不再推荐使用,建议使用id_list字段
    └ id_liststring\[\]执行者的用户ID列表。 传入的值为 user_id 或 open_id,由user_id_type 决定。user_id和open_id的获取可见文档如何获取不同的用户 ID

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "collaborator": {
            "id": "ou_99e1a581b36ecc4862cbfbce473f1234",
            "id_list": [
                "ou_99e1a581b36ecc4862cbfbce473f3123"
            ]
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
4011470403The identity token is incorrect. It should be either user_access_token or tenant_access_token.发起请求方的身份token不正确,需要为UserAccessToken或TenantAccessToken其中一种
4001470404Be refused to update task, possibly due to lack of permission.一般是因为操作者没有操作权限,导致更新任务或其他更新任务的操作失败。如,任务的关注者没有权限修改任务。
4001470429The total number of collaborators exceeds the maximum number limit.执行者总数超过了最大数量限制,目前一个任务最多只能添加50人
4001470431Users are all collaborators of tasks.用户已经是任务的协作者,不能重复添加
4291470450There are too many requests currently, please try again later.当前同时发起的请求过多,峰值较高导致了限流,请稍后重新尝试
4001470451Operation requests for the same task are too frequent.对同一个任务的操作请求太频繁,需要降低请求频次
4001470602Invalid task id.请检查任务的 id 是否合法
5001470701Failed to add task collaborator.添加任务执行者失败,若重试无法解决,请联系飞书技术人员协助排查

内容来源:飞书开放平台 · 自动爬取整理