查询内推信息
根据人才查询内推信息列表,包含内推人信息、内推时间、投递 ID等,按内推投递的创建时间从小到大排序返回。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/hire/v1/referrals/search |
| HTTP Method | POST |
| 接口频率限制 | 10 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | hire:referral:readonly 获取内推信息 hire:referral 更新内推信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
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?默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
talent_id | string | 是 | 人才 ID ,可通过批量获取人才ID获取 示例值:"6930815272790114324" |
start_time | string | 否 | 内推记录最早创建时间,毫秒时间戳。若不填,默认为指定人才下的全部记录,但最多返回200条 示例值:"1701226882718" |
end_time | string | 否 | 内推记录最晚创建时间,毫秒时间戳。默认为指定人才下的全部记录,但最多返回200条 示例值:"1701226882719" |
请求体示例
json
{
"talent_id": "6930815272790114324",
"start_time": "1701226882718",
"end_time": "1701226882719"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | referral_info\[\] | 内推信息列表 |
└ id | string | 内推 ID |
└ application_ids | string\[\] | 投递 ID 列表,详情请查看获取投递信息。通常情况下1次内推仅有1个投递 ID,即内推原始投递 ID(列表中的第一个 ID)。 若投递发生过转移,还会包含「转移到其他职位后的投递 ID」。 但不包含投递结束后被HR复捞(加入职位)的投递 ID。 |
└ create_time | string | 内推创建时间,毫秒时间戳 |
└ referral_user | id_name_object | 内推人信息 |
└ id | string | 内推人 ID,跟user_id_type类型一致 |
└ name | i18n | 内推人名称 |
└ zh_cn | string | 中文名称 |
└ en_us | string | 英文名称 |
响应体示例
json
{
"code": 0,
"msg": "SUCCESS",
"data": {
"items": [
{
"id": "6930815272790114322",
"application_ids": [
"6930815272790114323"
],
"create_time": "1618899376474",
"referral_user": {
"id": "6930815272790114324",
"name": {
"zh_cn": "张三",
"en_us": "zhangsan"
}
}
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询技术支持 |
| 400 | 1002002 | 参数错误 | 请检查参数或根据实际报错定位 |
