# 查询背调信息列表

可根据背调 ID 列表或投递 ID 等过滤条件查询背调订单信息。

## 请求

基本 | &nbsp;
---|---
HTTP URL | https://open.feishu.cn/open-apis/hire/v1/background_check_orders/batch_query
HTTP Method | POST
接口频率限制 | [10 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 更新招聘背调信息(hire:background_check_order)<br>获取招聘背调信息(hire:background_check_order:readonly)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请<br>获取用户 user ID(contact:user.employee_id:readonly)<br>查看员工邮箱(hire:employee.email:readonly)<br>查看员工手机号(hire:employee.mobile:readonly)<br>查看人才邮箱(hire:talent.email:readonly)<br>查看人才手机号(hire:talent.mobile:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
user_id_type | string | 否 | 用户 ID 类型<br>**示例值**：open_id<br>**可选值有**：<br>- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)<br>- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)<br>- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)<br>**默认值**：`open_id`<br>**当值为 `user_id`，字段权限要求**：<br>获取用户 user ID(contact:user.employee_id:readonly)
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果<br>**示例值**：eyJvZmZzZXQiOjEsInRpbWVzdGFtcCI6MTY0MDc2NTYzMjA4OCwiaWQiOm51bGx9
page_size | int | 否 | 每页获取记录数量<br>**示例值**：10<br>**默认值**：`10`<br>**数据校验规则**：<br>- 最大值：`100`

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
background_check_order_id_list | string\[\] | 否 | 背调订单 ID 列表，可通过本接口其他查询条件查询结果所得，当传递此值，以此值为准，其余查询字段失效<br>**示例值**：["7412902352778840358"]<br>**数据校验规则**：<br>- 最大长度：`20`
update_start_time | string | 否 | 最早更新时间，毫秒时间戳。需小于等于begin_end_time<br>**示例值**："1618500000000"
update_end_time | string | 否 | 最晚更新时间，毫秒时间戳。需大于等于update_start_time<br>**示例值**："1618500278663"
begin_start_time | string | 否 | 最早创建时间，毫秒时间戳<br>**示例值**："1618500278663"
begin_end_time | string | 否 | 最晚创建时间，毫秒时间戳<br>**示例值**："1618500278663"
application_id | string | 否 | 投递 ID，可通过[获取投递列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/list)接口获取<br>**示例值**："7398493486516799788"
order_status | string | 否 | 订单状态<br>**示例值**："2"<br>**可选值有**：<br>- 2：已安排<br>- 3：已完成<br>- 4：已终止<br>- 5：审批中<br>- 6：审批已撤回<br>- 8：审批通过<br>- 9：审批未通过

### 请求体示例
```json
{
    "background_check_order_id_list": [
        "7412902352778840358"
    ],
    "update_start_time": "1618500000000",
    "update_end_time": "1618500278663",
    "begin_start_time": "1618500278663",
    "begin_end_time": "1618500278663",
    "application_id": "7398493486516799788",
    "order_status": "2"
}
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
has_more | boolean | 是否还有更多项
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
items | background_check_order\[\] | 背调订单列表
order_id | string | 背调订单 ID
application_id | string | 投递 ID，详情可查看：[获取投递信息](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get)
order_status | int | 背调状态<br>**可选值有**：<br>- 2：已安排<br>- 3：已完成<br>- 4：已终止<br>- 5：审批中<br>- 6：审批已撤回<br>- 8：审批通过<br>- 9：审批未通过
account_third_type | int | 供应商类型<br>**可选值有**：<br>- 1：八方锦程<br>- 2：背调<br>- 3：轩渡<br>- 127：自定义供应商
package | string | 背调套餐名称
name | string | 背调名称（仅用户手动录入的背调结果支持返回该字段）
feedback_info_list | background_check_order_feedback_info\[\] | 背调报告列表，按照报告创建时间降序排列。可通过[更新背调订单进度](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/update_progress)更新报告
id | string | 背调报告 ID
attachment_url | string | 背调信息附件下载链接（大部分供应商均支持该字段；该字段与「report_preview_url」同一供应商只能支持 1 种），有效期1小时
report_preview_url | string | 背调预览链接（该字段与「attachment_url」同一供应商只能支持 1 种），有效期由供应商控制
result | string | 背调结果。招聘系统预置的背调结果有 红灯、黄灯、蓝灯、绿灯，也可以是更新背调进度时推送的状态。
report_type | int | 报告类型<br>**可选值有**：<br>- 1：阶段性报告<br>- 2：终版报告
create_time | string | 创建时间，毫秒时间戳
report_name | string | 报告名称
process_info_list | background_check_order_process_info\[\] | 背调进度列表，按照更新时间降序排列。可通过[更新背调订单进度](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/update_progress)更新进度
process | string | 中文背调进度
update_time | string | 进度更新时间，毫秒时间戳
en_process | string | 英文背调进度
upload_time | string | 录入时间毫秒时间戳（仅用户手动录入的背调结果支持返回该字段）
candidate_info | user_contact_info | 候选人信息
name | string | 候选人姓名
mobile | string | 候选人手机号<br>**字段权限要求**：<br>查看人才手机号(hire:talent.mobile:readonly)
email | string | 候选人邮箱<br>**字段权限要求**：<br>查看人才邮箱(hire:talent.email:readonly)
first_name | string | 候选人名字
last_name | string | 候选人姓氏
creator_info | background_check_order_creator | 背调发起人信息
user_id | string | 发起人 ID，与入参 `user_id_type` 类型一致
contactor_info | user_contact_info | 背调联系人信息
name | string | 联系人姓名
mobile | string | 联系人手机号<br>**字段权限要求**：<br>查看员工手机号(hire:employee.mobile:readonly)
email | string | 联系人邮箱<br>**字段权限要求**：<br>查看员工邮箱(hire:employee.email:readonly)
begin_time | string | 背调发起时间，毫秒时间戳
end_time | string | 背调结束时间，毫秒时间戳
conclusion | string | 背调结论，为最后一次背调报告的结果
provider_info | provider_id_name_object | 供应商信息
provider_id | string | 供应商 ID
provider_name | i18n | 供应商名称
zh_cn | string | 供应商中文名称
en_us | string | 供应商英文名称
custom_field_list | eco_background_check_custom_field_data\[\] | 自定义字段模板。数据来源于[创建背调自定义字段](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_custom_field/create)
type | string | 自定义字段类型<br>**可选值有**：<br>- text：单行文本，最多100个汉字<br>- textarea：多行文本，最多200个汉字<br>- number：数字<br>- boolean：布尔<br>- select：单选<br>- multiselect：多选<br>- date：日期<br>- file：附件<br>- resume：候选人简历
key | string | 自定义字段的标识，在同一账号内唯一
name | i18n | 自定义字段的名称，用户在安排背调表单看到的控件标题
zh_cn | string | 自定义字段中文名称
en_us | string | 自定义字段英文名称
is_required | boolean | 是否必填
description | i18n | 自定义字段的描述，如果是输入控件，为用户在安排背调表单看到的 placeholder 或提示文字
zh_cn | string | 自定义字段中文描述
en_us | string | 自定义字段英文描述
options | eco_background_check_custom_field_data_option\[\] | `type` 为 `select` 或 `multiselect` 时必填，单选或多选的选项
key | string | 选项的 key
name | i18n | 选项名称
zh_cn | string | 选项中文名称
en_us | string | 选项英文名称
custom_data_list | background_check_custom_field_data_value\[\] | 自定义字段值
key | string | 对应前文`custom_field_list`的 key
value | string | 用户填入的值
ext_item_info_list | background_check_item_info\[\] | 背调调查附加项列表。数据来源于[创建背调套餐和附加调查项](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_package/create)
id | string | 附加项的 ID
name | string | 附加项的名称
update_time | string | 订单更新时间，毫秒时间戳
geo | string | 属地<br>**可选值有**：<br>- cn：中国大陆<br>- sg：新加坡<br>- us：美东<br>- jp：日本
location_code | string | 预计入职地点的编码，详见[查询地点列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/query)
remark | string | 备注

### 响应体示例
```json
{
    "code": 0,
    "msg": "SUCCESS",
    "data": {
        "has_more": true,
        "page_token": "eyJvZmZzZXQiOjEsInRpbWVzdGFtcCI6MTY0MDc2NTYzMjA4OCwiaWQiOm51bGx9",
        "items": [
            {
                "order_id": "7037986982531778860",
                "application_id": "6985833807195212076",
                "order_status": 2,
                "account_third_type": 1,
                "package": "基础版",
                "name": "录入的背调",
                "feedback_info_list": [
                    {
                        "id": "6930815272790114324",
                        "attachment_url": "https://feishucdn.com/staource/v1/2de04c10-5cda-4c50~?image_size=np&cutpe=&quity=&mat=g&stmat=.wp",
                        "report_preview_url": "https://feishucdn.com/preview/file/6930815272790114324/",
                        "result": "红灯",
                        "report_type": 1,
                        "create_time": "1686645425868",
                        "report_name": "张三的背调报告"
                    }
                ],
                "process_info_list": [
                    {
                        "process": "待安排",
                        "update_time": "1638359554952",
                        "en_process": "arranged"
                    }
                ],
                "upload_time": "1662476247755",
                "candidate_info": {
                    "name": "王二",
                    "mobile": "176xxxx1234",
                    "email": "xxx@abc.vom",
                    "first_name": "Ming",
                    "last_name": "Lee"
                },
                "creator_info": {
                    "user_id": "6930815272790114324"
                },
                "contactor_info": {
                    "name": "王二",
                    "mobile": "176xxxx1234",
                    "email": "xxx@abc.vom"
                },
                "begin_time": "1686297649024",
                "end_time": "1686297649024",
                "conclusion": "绿灯",
                "provider_info": {
                    "provider_id": "6930815272790114324",
                    "provider_name": {
                        "zh_cn": "测试供应商",
                        "en_us": "test provider"
                    }
                },
                "custom_field_list": [
                    {
                        "type": "number",
                        "key": "candidate_resume",
                        "name": {
                            "zh_cn": "其他备注",
                            "en_us": "Other remark"
                        },
                        "is_required": true,
                        "description": {
                            "zh_cn": "其他备注描述",
                            "en_us": "Other remarks description"
                        },
                        "options": [
                            {
                                "key": "A",
                                "name": {
                                    "zh_cn": "选项 A",
                                    "en_us": "option A"
                                }
                            }
                        ]
                    }
                ],
                "custom_data_list": [
                    {
                        "key": "1",
                        "value": "user input value"
                    }
                ],
                "ext_item_info_list": [
                    {
                        "id": "6930815272790114324",
                        "name": "户籍查询"
                    }
                ],
                "update_time": "1686809576215",
                "geo": "cn",
                "location_code": "CN_1",
                "remark": "候选人很优秀"
            }
        ]
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1002001 | System exception | 请根据实际报错信息定位问题或联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
400 | 1002002 | Parameter error | 检查参数是否正确，例如类型，大小

