Skip to content

新增关注人

该接口用于新增任务关注人。可以一次性添加多位关注人。关注人ID要使用表示用户的ID。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/task/v1/tasks/:task_id/followers
HTTP MethodPOST
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型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
示例值:"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
示例值:"ou_99e1a581b36ecc4862cbfbce473f3123"
id_liststring\[\]要删除的关注人ID列表
示例值:["ou_99e1a581b36ecc4862cbfbce473f3123"]

请求体示例

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

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ followerfollower创建后的任务关注者
    └ idstring任务关注人 ID
    └ id_liststring\[\]要删除的关注人ID列表

响应体示例

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

错误码

HTTP状态码错误码描述排查建议
4031470403The identity token is incorrect. It should be either user_access_token or tenant_access_token.发起请求方的身份token不正确,需要为UserAccessToken或TenantAccessToken其中一种
4001470602Invalid task id.请检查任务的 id 是否合法
5001470711failed to add task followers添加任务关注者失败,请结合返回的具体错误进行排查。如果无法解决,请提供 request id 并联系飞书技术人员协助排查
4001470451request api concurrently对同一个任务的操作请求太频繁,需要降低请求频次
4001470412invalid follower id关注者id无效,建议确认一下是否向follower_ids字段传入了非法的关注者id,如空值“”
4001470428total follower exceeds limit关注者的数量超过最大限制,无法继续添加
4001470430followers existed in task用户已经是任务的关注者,不需要重复添加
4001470450request too fast当前同时发起的请求过多,峰值较高导致了限流,请稍后重新尝试
4001470404be refused to create or update task一般是因为操作者没有操作权限,导致更新任务或其他更新任务的操作失败。如,任务的关注者没有权限修改任务。

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