飞书开放平台 Server API 文档

主题

获取 Offer 详情 ​

根据 Offer ID 获取 Offer 详细信息。

请求 ​

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

请求头 ​

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

路径参数 ​

名称类型描述
offer_idstringOffer ID，可通过获取 Offer 列表获取
示例值："6791698585114741000"

查询参数 ​

名称类型必填描述
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
department_id_typestring否此次调用中使用的部门 ID 类型。
示例值："department_id"
可选值有：
- open_department_id: 【飞书】用来在具体某个应用中标识一个部门，同一个department_id 在不同应用中的 open_department_id 相同 - department_id: 【飞书】用来标识租户内一个唯一的部门
默认值：open_department_id
job_level_id_typestring否此次调用中使用的「职级 ID」的类型
示例值："job_level_id"
可选值有：
- people_admin_job_level_id: 「人力系统管理后台」适用的职级 ID。人力系统管理后台逐步下线中，建议不继续使用此 ID。 - job_level_id: 「飞书管理后台」适用的职级 ID，通过获取租户职级列表接口获取
默认值：people_admin_job_level_id
job_family_id_typestring否此次调用中使用的「序列 ID」的类型
示例值："people_admin_job_category_id"
可选值有：
- people_admin_job_category_id: 「人力系统管理后台」适用的序列 ID。人力系统管理后台逐步下线中，建议不继续使用此 ID。 - job_family_id: 「飞书管理后台」适用的序列 ID，通过获取租户序列列表接口获取
默认值：people_admin_job_category_id
employee_type_id_typestring否此次调用中使用的「人员类型 ID」的类型
示例值："people_admin_employee_type_id"
可选值有：
- people_admin_employee_type_id: 「人力系统管理后台」适用的人员类型 ID。人力系统管理后台逐步下线中，建议不继续使用此 ID。 - employee_type_enum_id: 「飞书管理后台」适用的人员类型 ID，通过查询人员类型接口获取
默认值：people_admin_employee_type_id

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ offerofferOffer 详情
    └ idstringOffer ID
    └ application_idstring投递 ID，详情请查看：获取投递信息
    └ basic_infoapplication_offer_basic_info基础信息
      └ offer_typeintOffer 类型，废弃字段
可选值有：
- 1: 社招 Offer - 2: 校招 Offer - 3: 实习 Offer - 4: 实习生转正 Offer
      └ remarkstring备注
字段权限要求（满足任一）： hire:offer:readonly 获取 offer 信息 hire:offer 更新 offer 信息
      └ expire_timeintOffer 过期时间，毫秒级时间戳
      └ owner_user_idstringOffer 负责人 ID，与入参user_id_type类型一致
      └ creator_user_idstringOffer 创建人 ID，与入参user_id_type类型一致
      └ employee_typebase_bilingual_with_idOffer 人员类型
        └ idstring人员类型 ID，与入参employee_type_id_type 类型一致
        └ zh_namestring人员类型中文名称
        └ en_namestring人员类型英文名称
      └ create_timestring创建时间，毫秒级时间戳
      └ leader_user_idstring直属上级 ID，与入参user_id_type类型一致
      └ onboard_datestring入职日期，格式为YYYY-MM-DD
      └ department_idstring入职部门，与入参中的department_id_type类型一致
      └ probation_monthint试用期, 比如试用期6个月
      └ contract_yearint合同期（年），推荐使用「contract_period」
      └ contract_periodcontract_period_info合同期（年/月）
        └ period_typeint合同周期类型
可选值有：
- 1: 月 - 2: 年
        └ periodint合同时长
      └ recruitment_typebase_bilingual_with_id雇员类型
        └ idstring职位雇佣类型ID，详情请参考：枚举常量介绍中「职位性质/雇佣类型（recruitment_type）枚举定义」
        └ zh_namestring雇员类型中文名称
        └ en_namestring雇员类型英文名称
      └ sequencebase_bilingual_with_id序列
        └ idstring序列 ID，与入参job_family_id_type 类型一致
        └ zh_namestring序列中文名称
        └ en_namestring序列英文名称
      └ levelbase_bilingual_with_id级别
字段权限要求（满足任一）： hire:offer:readonly 获取 offer 信息 hire:offer 更新 offer 信息
        └ idstring级别 ID，与入参job_level_id_type 类型一致
        └ zh_namestring级别中文名称
        └ en_namestring级别英文名称
      └ onboard_addressbase_address入职地点
        └ idstring入职地点 ID，详情请参考：获取地址列表
        └ zh_namestring入职地点中文名称
        └ en_namestring入职地点英文名称
        └ districtbase_district区域信息
          └ zh_namestring区域中文名称
          └ en_namestring区域英文名称
          └ codestring区域编码
          └ location_typeint地址类型，值固定为4：DISTRICT（区/县）
        └ citybase_city城市信息
          └ zh_namestring城市中文名称
          └ en_namestring城市英文名称
          └ codestring城市编码
          └ location_typeint地址类型，值固定为3：CITY（市）
可选值有：
- 1: COUNTRY（国家） - 2: STATE（省份/州） - 3: CITY（市） - 4: DISTRICT（区/县） - 5: ADDRESS（地址）
        └ statebase_city省信息
          └ zh_namestring省中文名称
          └ en_namestring省英文名称
          └ codestring省编码
          └ location_typeint地址类型，值固定为2：STATE（省/州）
可选值有：
- 1: COUNTRY（国家） - 2: STATE（省/州） - 3: CITY（市） - 4: DISTRICT（区/县） - 5: ADDRESS（地址）
        └ countrybase_country国家信息
          └ zh_namestring国家中文名称
          └ en_namestring国家英文名称
          └ codestring国家编码
          └ location_typeint地址类型，值固定为1：COUNTRY（国家）
可选值有：
- 1: COUNTRY（国家） - 2: STATE（省份/州） - 3: CITY（市） - 4: DISTRICT（区/县） - 5: ADDRESS（地址）
      └ work_addressbase_address工作地点
        └ idstring工作地点 ID，详情请参考：获取地址列表
        └ zh_namestring工作地点中文名称
        └ en_namestring工作地点英文名称
        └ districtbase_district区域信息
          └ zh_namestring区域中文名称
          └ en_namestring区域英文名称
          └ codestring区域编码
          └ location_typeint地址类型，值固定为4：DISTRICT（区/县）
        └ citybase_city城市信息
          └ zh_namestring城市中文名称
          └ en_namestring城市英文名称
          └ codestring城市编码
          └ location_typeint地址类型，值固定为3：STATE（省/州）
可选值有：
- 1: COUNTRY（国家） - 2: STATE（省份/区） - 3: CITY（市） - 4: DISTRICT（区/县） - 5: ADDRESS（地址）
        └ statebase_city省信息
          └ zh_namestring省中文名称
          └ en_namestring省英文名称
          └ codestring省编码
          └ location_typeint地址类型，值固定为2：CITY（市）
可选值有：
- 1: COUNTRY（国家） - 2: STATE（省份/州） - 3: CITY（市） - 4: DISTRICT（区/县） - 5: ADDRESS（地址）
        └ countrybase_country国家信息
          └ zh_namestring国家中文名称
          └ en_namestring国家英文名称
          └ codestring国家编码
          └ location_typeint地址类型，值固定为1：COUNTRY（国家）
可选值有：
- 1: COUNTRY（国家） - 2: STATE（省份/州） - 3: CITY（市） - 4: DISTRICT（区/县） - 5: ADDRESS（地址）
      └ customize_info_listapplication_offer_custom_value\[\]自定义字段信息
字段权限要求（满足任一）： hire:offer:readonly 获取 offer 信息 hire:offer 更新 offer 信息
        └ object_idstring自定义字段 ID，详情请参考：获取 Offer 申请表信息
        └ customize_valuestring自定义字段 value（值为人员ID的自定义字段 value 暂不支持ID转换，会以 people_admin_id 类型返回）
      └ work_location_address_infomaster_location_address_info人事侧的办公地点与地址（目前仅字节可用)
        └ location_infomaster_location_info办公地点
          └ idstring地点 ID
          └ zh_namestring地点中文名称
          └ en_namestring地点英文名称
        └ address_infomaster_location_info办公地址
          └ idstring地址 ID
          └ zh_namestring地址中文名称
          └ en_namestring地址英文名称
      └ position_idstring岗位 ID，可通过查询岗位信息获取（仅限飞书人事租户使用，若链接无法打开，则说明飞书人事未启用岗位，请联系技术支持开通）
      └ job_offeredstring入职职位
      └ job_grade_idstring职等 ID，可通过查询职等 获取（仅限飞书人事租户使用）
      └ common_attachment_id_liststring\[\]通用附件 ID 列表，可通过获取附件信息接口获取附件的详细信息
      └ pathway_idstring通道 ID
    └ salary_planapplication_offer_salary_plan薪酬计划
字段权限要求（满足任一）： hire:offer:readonly 获取 offer 信息 hire:offer 更新 offer 信息
      └ currencystring币种
      └ basic_salarystring基本薪资，为JSON 格式，amount 代表基本薪资的金额，peroid 代表基本薪资的周期单位，如：{"amount":"10000","period":2}。 peroid 可选值有: - 1 : 日薪 - 2 : 月薪
      └ probation_salary_percentagestring试用期百分比
      └ award_salary_multiplestring年终奖月数
      └ option_sharesstring期权股数
      └ quarterly_bonusstring季度奖金额，单位元、支持小数点后两位
      └ half_year_bonusstring半年奖金额，单位元、支持小数点后两位
      └ total_annual_cashstring年度现金总额(数量，非公式)，单位元、支持小数点后两位
      └ customize_info_listapplication_offer_custom_value\[\]自定义字段的 value 信息
        └ object_idstring自定义字段 ID，详情请参考：获取 Offer 申请表模版信息
        └ customize_valuestring自定义字段 value
    └ schema_idstring当前 Offer 使用的 Schema
    └ offer_statusintOffer 状态，注意：除标注「仅实习 Offer 适用」的状态外，其余状态对「实习 Offer」与「正式 Offer」通用
可选值有：
- 1: 未申请 - 2: 审批中 - 3: 审批已撤回 - 4: 审批通过 - 5: 审批不通过 - 6: Offer 已发出 - 7: 候选人已接受 - 8: 候选人已拒绝 - 9: Offer 已失效 - 10: 未审批 - 11: 实习待入职（仅实习 Offer 具有） - 12: 实习已入职（仅实习 Offer 具有） - 13: 实习已离职（仅实习 Offer 具有）
    └ offer_typeintOffer 类型
可选值有：
- 1: 正式 Offer - 2: 实习 Offer
    └ job_infooffer_job_info职位信息
      └ job_idstringOffer 职位 ID
      └ job_namestringOffer 职位名称
    └ customized_module_listapplication_offer_custom_module\[\]Offer 自定义模块列表
字段权限要求（满足任一）： hire:offer:readonly 获取 offer 信息 hire:offer 更新 offer 信息
      └ IDstring自定义模块 ID
      └ object_listapplication_offer_custom_value\[\]自定义模块下字段的值
        └ object_idstring自定义字段 ID，详情请参考：获取 Offer 申请表模版信息
        └ customize_valuestring自定义字段 Value（值为人员ID的自定义字段 value 暂不支持ID转换，会以 people_admin_id 类型返回）
    └ job_requirement_idstring招聘需求ID，详情请查看：获取招聘需求信息
    └ offer_send_record_listoffer_send_record\[\]offer 发送记录列表
      └ offer_send_record_idstringoffer 发送记录 id
      └ operator_user_idstring操作人 ID，与入参user_id_type类型一致
      └ send_timestringoffer 发送时间，毫秒时间戳
      └ offer_letter_statusintoffer 状态
可选值有：
- 1: 已创建 - 2: 已接受 - 3: 已拒绝 - 4: 已过期 - 5: 已作废
      └ email_infooffer_email_infooffer 邮件信息
        └ cc_email_liststring\[\]抄送人邮件列表
        └ receiver_email_liststring\[\]接收人邮件列表
        └ contentstring邮件内容
      └ acceptance_listacceptance\[\]Offer 跟进记录
        └ operator_typeint操作类型
可选值有：
- 1: HR 操作 - 2: 候选人操作
        └ conclusionintoffer 接受或拒绝的结果
可选值有：
- 1: 接受 - 2: 拒绝
        └ memostring备注，如果是拒绝，则展示拒绝原因
        └ operate_timestring操作时间，毫秒时间戳
      └ offer_file_listoffer_file\[\]offer 文件列表
        └ idstring文件 id，可通过获取附件信息接口获取，查询参数 type 传枚举值 3，通用附件
        └ file_template_idstring文件模板 id，暂无接口可通过该 ID 获取对应信息
        └ file_template_namestring文件模板名称
        └ file_template_type_idstring文件模板类型 id，暂无接口可通过该 ID 获取对应信息
        └ file_template_type_namestring文件模板类型名称
      └ offer_signature_infooffer_signature_infooffer 签署信息
        └ idstring电子签信息 id，暂无接口可通过该 ID 获取对应信息
        └ signature_statusint电子签签署状态
可选值有：
- 1: 未签署 - 2: 所有签署人已签署 - 3: 部分签署人已签署 - 4: 已拒绝 - 5: 已失效
        └ attachment_listsignature_attachment\[\]电子签附件列表
          └ idstring文件 id，可通过获取附件信息接口获取，查询参数 type 传枚举值 3，通用附件
          └ file_namestring文件名称
          └ file_template_idstring文件模板 id，暂无接口可通过该 ID 获取对应信息
          └ file_template_namestring文件模板名称
          └ file_template_type_idstring文件模板类型 id，暂无接口可通过该 ID 获取对应信息
          └ file_template_type_namestring文件模板类型名称

响应体示例 ​

json
{
    "code": 0,
    "msg": "ok",
    "data": {
        "offer": {
            "id": "1231231231231231",
            "application_id": "1231231232312312",
            "basic_info": {
                "offer_type": 1,
                "remark": "10",
                "expire_time": 1653383498000,
                "owner_user_id": "ou_99be8e24ad1ad390b6cd3b8916940df1",
                "creator_user_id": "ou_99be8e24ad1ad390b6cd3b8916940df1",
                "employee_type": {
                    "id": "1",
                    "zh_name": "正式",
                    "en_name": "Regular"
                },
                "create_time": "1628512038000",
                "leader_user_id": "ou_99be8e24ad1ad390b6cd3b8916940df1",
                "onboard_date": "2021-05-20",
                "department_id": "od-6b394871807047c7023ebfc1ff37cd3a",
                "probation_month": 1,
                "contract_year": 3,
                "contract_period": {
                    "period_type": 1,
                    "period": 3
                },
                "recruitment_type": {
                    "id": "1",
                    "zh_name": "正式",
                    "en_name": "Regular"
                },
                "sequence": {
                    "id": "1",
                    "zh_name": "正式",
                    "en_name": "Regular"
                },
                "level": {
                    "id": "1",
                    "zh_name": "正式",
                    "en_name": "Regular"
                },
                "onboard_address": {
                    "id": "6932753007915206919",
                    "zh_name": "名字",
                    "en_name": "name",
                    "district": {
                        "zh_name": "伦敦",
                        "en_name": "London",
                        "code": "400700",
                        "location_type": 4
                    },
                    "city": {
                        "zh_name": "中文",
                        "en_name": "eng",
                        "code": "400700",
                        "location_type": 3
                    },
                    "state": {
                        "zh_name": "中文",
                        "en_name": "eng",
                        "code": "400700",
                        "location_type": 2
                    },
                    "country": {
                        "zh_name": "中文",
                        "en_name": "eng",
                        "code": "400700",
                        "location_type": 1
                    }
                },
                "work_address": {
                    "id": "6932753007915206919",
                    "zh_name": "名字",
                    "en_name": "name",
                    "district": {
                        "zh_name": "伦敦",
                        "en_name": "London",
                        "code": "400700",
                        "location_type": 4
                    },
                    "city": {
                        "zh_name": "中文",
                        "en_name": "eng",
                        "code": "400700",
                        "location_type": 3
                    },
                    "state": {
                        "zh_name": "中文",
                        "en_name": "eng",
                        "code": "400700",
                        "location_type": 2
                    },
                    "country": {
                        "zh_name": "中文",
                        "en_name": "eng",
                        "code": "400700",
                        "location_type": 1
                    }
                },
                "customize_info_list": [
                    {
                        "object_id": "key",
                        "customize_value": "value"
                    }
                ],
                "work_location_address_info": {
                    "location_info": {
                        "id": "6930815272790114324",
                        "zh_name": "北京",
                        "en_name": "Beijing"
                    },
                    "address_info": {
                        "id": "6930815272790114324",
                        "zh_name": "北京",
                        "en_name": "Beijing"
                    }
                },
                "position_id": "123",
                "job_offered": "入职职位",
                "job_grade_id": "6897079709306259720",
                "common_attachment_id_list": [
                    "7483412052430997804"
                ],
                "pathway_id": "123456"
            },
            "salary_plan": {
                "currency": "CNY",
                "basic_salary": "{\"amount\":\"10000\",\"period\":2}",
                "probation_salary_percentage": "10%",
                "award_salary_multiple": "12",
                "option_shares": "11",
                "quarterly_bonus": "11111",
                "half_year_bonus": "11111",
                "total_annual_cash": "11111",
                "customize_info_list": [
                    {
                        "object_id": "key",
                        "customize_value": "value"
                    }
                ]
            },
            "schema_id": "6963562624677398823",
            "offer_status": 1,
            "offer_type": 1,
            "job_info": {
                "job_id": "7080891505426925854",
                "job_name": "xx"
            },
            "customized_module_list": [
                {
                    "ID": "6930815272790114324",
                    "object_list": [
                        {
                            "object_id": "6930815272790114324",
                            "customize_value": "value"
                        }
                    ]
                }
            ],
            "job_requirement_id": "1231231232312312",
            "offer_send_record_list": [
                {
                    "offer_send_record_id": "1718959426734",
                    "operator_user_id": "ou_ce613028fe74745421f5dc320bb9c709",
                    "send_time": "1718959426734",
                    "offer_letter_status": 1,
                    "email_info": {
                        "cc_email_list": [
                            "123@test.com"
                        ],
                        "receiver_email_list": [
                            "123@test.com"
                        ],
                        "content": "This is a test email."
                    },
                    "acceptance_list": [
                        {
                            "operator_type": 1,
                            "conclusion": 1,
                            "memo": "Abort",
                            "operate_time": "1718959426734"
                        }
                    ],
                    "offer_file_list": [
                        {
                            "id": "12345678901",
                            "file_template_id": "1718959426734",
                            "file_template_name": "offer 文件",
                            "file_template_type_id": "1718959426734",
                            "file_template_type_name": "offer 文件"
                        }
                    ],
                    "offer_signature_info": {
                        "id": "1718959426734",
                        "signature_status": 1,
                        "attachment_list": [
                            {
                                "id": "12345678901",
                                "file_name": "offer 文件",
                                "file_template_id": "1718959426734",
                                "file_template_name": "offer 文件",
                                "file_template_type_id": "1718959426734",
                                "file_template_type_name": "offer 文件"
                            }
                        ]
                    }
                }
            ]
        }
    }
}

错误码 ​

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

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

本镜像仅供学习与查阅，文档版权归飞书所有