更新背调订单进度
更新指定背调订单的进度信息和阶段性报告,进度信息将会被展示在「飞书招聘」-「投递详情页」-「背调卡片」上,告知用户目前背调订单的流转状态。
Tip: 当订单状态已完成时,将无法通过此接口更新进度信息和阶段报告。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/hire/v1/eco_background_checks/update_progress |
| HTTP Method | POST |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | hire:background_check_order 更新招聘背调信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
background_check_id | string | 是 | 背调 ID。可通过创建背调事件获取 示例值:"6931286400470354183" |
stage_id | string | 是 | 阶段 ID。同一背调订单此 ID 不能重复,由调用方自定义 示例值:"6931286400470354183" |
stage_en_name | string | 否 | 背调阶段英文名称 示例值:"stage report" |
stage_name | string | 是 | 背调阶段名称 示例值:"阶段报告" |
stage_time | string | 是 | 阶段进度更新时间。 毫秒时间戳,每次调用此字段应严格递增 示例值:"1660123456789" |
result | string | 否 | 背调结果(阶段性背调结果)。 注意:若需回传该字段,report_file_list为必填 示例值:"通过" |
report_file_list | eco_background_check_report_file\[\] | 否 | 报告列表 |
└ report_name | string | 是 | 报告名称 示例值:"阶段报告.pdf" |
└ report_url | string | 是 | 报告地址;当report_url_type 为空或为 1 时需为可下载的 pdf 链接;为 2 时为预览型链接 示例值:"https://xxxxx/xxxxxx/xxxx.pdf" |
└ report_url_type | int | 否 | 报告地址类型;枚举值为空或 1 时为可下载的 pdf 链接,2 为预览型链接 示例值:1 可选值有: - 1: 可下载的链接 - 2: 预览型链接 |
请求体示例
json
{
"background_check_id": "6931286400470354183",
"stage_id": "6931286400470354183",
"stage_en_name": "stage report",
"stage_name": "阶段报告",
"stage_time": "1660123456789",
"result": "通过",
"report_file_list": [
{
"report_name": "阶段报告.pdf",
"report_url": "https://xxxxx/xxxxxx/xxxx.pdf",
"report_url_type": 1
}
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1002858 | 订单状态异常 | 请检查参数 |
| 400 | 1002862 | 背调订单不存在 | 请检查入参background_check_id |
| 500 | 1002001 | 系统异常 | 请根据实际报错信息定位问题或联系技术支持 |
