终止背调订单
调用此接口将会将背调订单状态变成已终止,已终止订单将将无法通过更新背调订单进度和回传背调订单的最终结果修改订单进度和最终结果。 调用此接口前,建议先调用更新背调订单进度接口将订单进度更新为「已终止」。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/hire/v1/eco_background_checks/cancel |
| 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" |
请求体示例
json
{
"background_check_id": "6931286400470354183"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1002862 | 背调订单不存在 | 请检查入参background_check_id |
| 500 | 1002001 | 系统错误 | 请根据实际报错信息定位问题或联系技术支持 |
