创建外部背调
创建外部背调,可用于导入来自其他系统的背调信息。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/hire/v1/external_background_checks |
| HTTP Method | POST |
| 接口频率限制 | 20 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | hire:external_application 更新外部投递 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
external_id | string | 否 | 外部系统背调主键 (仅用于幂等) - 若不传此值,则不进行幂等校验 - 若传此值,则用于幂等校验,同一external_id 24小时内仅可创建一次示例值:"7003247299220982060" |
external_application_id | string | 是 | 外部投递 ID,可通过查询外部投递列表接口获取 示例值:"7003247299220982060" |
date | int | 否 | 背调日期,毫秒时间戳(字段类型为:int64) 示例值:1626602069392 |
name | string | 否 | 背调名称 示例值:"张三的背调" |
result | string | 否 | 背调结果 示例值:"已通过" |
attachment_id_list | string\[\] | 否 | 背调附件 ID 列表,可通过创建附件接口返回 示例值:["7249929009008494908"] |
请求体示例
json
{
"external_id": "7003247299220982060",
"external_application_id": "7003247299220982060",
"date": 1626602069392,
"name": "张三的背调",
"result": "已通过",
"attachment_id_list": [
"7249929009008494908"
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ external_background_check | external_background_check | 外部背调 |
└ id | string | 外部背调 ID(由飞书招聘系统生成),详情可查看:查询外部背调列表 |
└ external_application_id | string | 外部投递 ID,详情可查看:查询外部投递列表 |
└ date | int | 背调日期,毫秒时间戳(字段类型为:int64) |
└ name | string | 背调名称 |
└ result | string | 背调结果 |
└ attachment_list | external_background_check_attachment\[\] | 背调附件列表 |
└ id | string | 附件 ID,详情可查看:获取附件信息 |
└ name | string | 附件名称 |
└ size | int | 附件大小(单位:字节) |
响应体示例
json
{
"code": 0,
"msg": "ok",
"data": {
"external_background_check": {
"id": "6989202908470446380",
"external_application_id": "6989202908470446380",
"date": 1626602069393,
"name": "张三的背调",
"result": "已通过",
"attachment_list": [
{
"id": "6987954043925432620",
"name": "test_resume.pdf",
"size": 126371
}
]
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1002001 | 系统异常 | 请根据实际报错信息定位问题或联系技术支持 |
| 400 | 1002002 | 参数错误 | 检查参数是否正确,例如类型,大小 |
