批量获取待办事项
批量获取当前用户的待办事项信息,包含评估待办事项、面试待办事项、笔试待办事项和 Offer 待办事项。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/hire/v1/todos |
| HTTP Method | GET |
| 接口频率限制 | 10 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | hire:todo:readonly 获取招聘待办信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ== |
page_size | string | 否 | 每页获取记录数量 示例值:10 默认值: 10数据校验规则: - 最大值: 100 |
user_id | string | 否 | 用户 ID,该字段无效,请勿使用 示例值:6894116548131161608 |
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? - people_admin_id: 以 people_admin_id 来识别用户默认值: people_admin_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
type | string | 是 | 待办类型 示例值:interview 可选值有: - evaluation: 评估待办 - offer: Offer 待办 - exam: 笔试待办 - interview: 面试待办 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | todo\[\] | 待办事项列表 |
└ evaluation | todo_common | 简历评估待办事项,仅当待办类型为 evaluation 时返回 |
└ talent_id | string | 人才 ID,详情可查看:获取人才信息 |
└ job_id | string | 职位 ID,详情可查看:获取职位信息 |
└ application_id | string | 投递 ID,详情可查看:获取投递信息 |
└ id | string | 评估 ID,详情可查看:批量获取简历评估信息 |
└ offer | todo_common | Offer 待办事项,仅当待办类型为 offer 时返回 |
└ talent_id | string | 人才 ID,详情可查看:获取人才信息 |
└ job_id | string | 职位 ID,详情可查看:获取职位信息 |
└ application_id | string | 投递 ID,详情可查看:获取投递信息 |
└ id | string | Offer 审批流程 ID |
└ exam | todo_common | 笔试待办事项,仅当类型为 exam 时返回 |
└ talent_id | string | 人才 ID,详情可查看:获取人才信息 |
└ job_id | string | 职位 ID,详情可查看:获取职位信息 |
└ application_id | string | 投递 ID,详情可查看:获取投递信息 |
└ id | string | 笔试 ID |
└ interview | todo_common | 面试待办事项,仅当类型为 interview 时返回 |
└ talent_id | string | 人才 ID,详情可查看:获取人才信息 |
└ job_id | string | 职位 ID,详情可查看:获取职位信息 |
└ application_id | string | 投递 ID,详情可查看:获取投递信息 |
└ id | string | 面试 ID,详情可查看:获取面试信息 |
└ has_more | boolean | 是否还有更多项 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
响应体示例
json
{
"code": 0,
"msg": "ok",
"data": {
"items": [
{
"evaluation": {
"talent_id": "6891524011667228941",
"job_id": "6891113155221522701",
"application_id": "6945436033023625516",
"id": "6914542162822695181"
},
"offer": {
"talent_id": "6891524011667228941",
"job_id": "6891113155221522701",
"application_id": "6945436033023625516",
"id": "6914542162822695181"
},
"exam": {
"talent_id": "6891524011667228941",
"job_id": "6891113155221522701",
"application_id": "6945436033023625516",
"id": "6914542162822695181"
},
"interview": {
"talent_id": "6891524011667228941",
"job_id": "6891113155221522701",
"application_id": "6945436033023625516",
"id": "6914542162822695181"
}
}
],
"has_more": true,
"page_token": "eyJvZmZzZXQiOjEwLCJ0aW1lc3RhbXAiOjE2Mjc1NTUyMjM2NzIsImlkIjpudWxsfQ=="
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询技术支持 |
| 400 | 1002002 | 参数错误 | 检查参数是否正确,例如类型,大小 |
更多错误码信息,参见通用错误码。
