Skip to content

获取内推信息

根据投递 ID 获取内推信息,包含内推人信息、内推创建时间等。

注意:

1.本接口根据 application_id (投递ID)查询内推信息时,仅适用于内推时选择了具体职位的场景

2.对于 无职位内推 (内推时未选择职位),内推信息中不存储投递ID,使用 application_id 查询将返回空结果

3.查询无职位内推信息,请使用 referral_id (内推ID)或 talent_id (人才ID)作为查询条件

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/hire/v1/referrals/get_by_application
HTTP MethodGET
接口频率限制50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可hire:referral:readonly 获取内推信息 hire:referral 更新内推信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

查询参数

名称类型必填描述
application_idstring投递 ID,可通过获取投递列表获取
示例值:6134134355464633
user_id_typestring用户 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? - people_admin_id: 以people_admin_id来识别用户
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ referralreferral内推信息
    └ idstring内推 ID
    └ application_idstring投递 ID
    └ create_timeint创建时间(int64类型),毫秒时间戳
    └ referral_user_idstring内推人 ID,与user_id_type类型一致
    └ referral_userid_name_object内推人信息
      └ idstring内推人ID,同referral_user_id,与user_id_type类型一致
      └ namei18n内推人姓名
        └ zh_cnstring中文姓名
        └ en_usstring英文姓名

响应体示例

json
{
    "code": 0,
    "msg": "ok",
    "data": {
        "referral": {
            "id": "7392247983414413606",
            "application_id": "643452344576878",
            "create_time": 1618899376474,
            "referral_user_id": "ou_669760b021dbd9edbf2f3dc11b3a25ed",
            "referral_user": {
                "id": "ou_669760b021dbd9edbf2f3dc11b3a25ed",
                "name": {
                    "zh_cn": "张三",
                    "en_us": "zhangsan"
                }
            }
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
5001002001System error请根据实际报错信息定位或咨询技术支持
4001002002Invalid parameter检查参数是否正确,例如类型,大小

内容来源:飞书开放平台 · 自动爬取整理