Skip to content

新增提醒时间

该接口用于创建任务的提醒时间。提醒时间在截止时间基础上做偏移,但是偏移后的结果不能早于当前时间。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/task/v1/tasks/:task_id/reminders
HTTP MethodPOST
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用task:task 查看、创建、编辑和删除飞书任务(历史版本)

请求头

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

请求体

名称类型必填描述
relative_fire_minuteint相对于截止时间的提醒时间(如提前 30 分钟,截止时间后 30 分钟,则为 -30) 任务没有截止时间则为全天任务(截止时间为0)
示例值:30

请求体示例

json
{
    "relative_fire_minute": 30
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ reminderreminder返回创建成功的提醒时间
    └ idstring提醒时间设置的 ID(在删除时候需要使用这个)
    └ relative_fire_minuteint相对于截止时间的提醒时间(如提前 30 分钟,截止时间后 30 分钟,则为 -30) 任务没有截止时间则为全天任务(截止时间为0)

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "reminder": {
            "id": "1",
            "relative_fire_minute": 30
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
4031470403The identity token is incorrect. It should be either user_access_token or tenant_access_token.发起请求方的身份token不正确,需要为UserAccessToken或TenantAccessToken其中一种
4001470602Invalid task id.请检查任务的 id 是否合法
5001470721add task remainder failded设置任务的提醒时间失败,请结合返回的具体错误进行排查。如果无法解决,请提供 request id 并联系飞书技术人员协助排查
4001470450request too fast当前同时发起的请求过多,峰值较高导致了限流,请稍后重新尝试
4001470419task due time not set该任务没有设置时区,需要先进行设置
4001470420already exists duplicate reminder time已经存在一个相同的提醒时间,不能重复添加
4001470427total reminder exceeds limit提醒时间的数量超过了最大限制
4001470451request api concurrently对同一个任务的操作请求太频繁,需要降低请求频次
4001470404be refused to create or update task一般是因为操作者没有操作权限,导致更新任务或其他更新任务的操作失败。如,任务的关注者没有权限修改任务。

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