查询提醒时间列表
返回提醒时间列表,支持分页,最大值为50。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/task/v1/tasks/:task_id/reminders |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | task:task 查看、创建、编辑和删除飞书任务(历史版本) task:task:readonly 查看任务详情 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
task_id | string | 任务 ID 示例值:"0d38e26e-190a-49e9-93a2-35067763ed1f" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_size | int | 否 | 分页大小 示例值:50 默认值: 50数据校验规则: - 取值范围: 0 ~ 50 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:「填写上次返回的page_token」 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | reminder\[\] | 返回提醒时间设置列表 |
└ id | string | 提醒时间设置的 ID(在删除时候需要使用这个) |
└ relative_fire_minute | int | 相对于截止时间的提醒时间(如提前 30 分钟,截止时间后 30 分钟,则为 -30) 任务没有截止时间则为全天任务(截止时间为0) |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"id": "1",
"relative_fire_minute": 30
}
],
"page_token": "「填写上次返回的page_token」",
"has_more": false
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 403 | 1470403 | The identity token is incorrect. It should be either user_access_token or tenant_access_token. | 发起请求方的身份token不正确,需要为UserAccessToken或TenantAccessToken其中一种 |
| 400 | 1470602 | Invalid task id. | 请检查任务的 id 是否合法 |
| 400 | 1470432 | have no permission to get task | 没有获取任务的权限,需要检查当前发起请求的对象是否有权限 |
