创建个人信息
创建员工的个人信息,包括姓名、个人电话、邮箱、联系地址、政治面貌、户口信息等
Tip: - 非必填字段,不传时默认为空
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v2/persons |
| HTTP Method | POST |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | corehr:person:write 读写员工的个人信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 corehr:person.address:read 读取个人地址信息 corehr:person.address:write 读写个人地址信息 corehr:person.bank_account:read 获取银行账号列表信息 corehr:person.bank_account:write 读写银行账号信息 corehr:person.born_country_region:read 获取出生国家/地区信息 corehr:person.custom_field:read 获取个人信息自定义字段信息 corehr:person.date_entered_workforce:read 获取参加工作日期 corehr:person.date_entered_workforce:write 读写参加工作日期 corehr:person.date_of_birth:read 获取生日信息 corehr:person.date_of_birth:write 读写生日信息 corehr:person.dependent:read 获取家庭成员信息 corehr:person.dependent:write 读写家庭成员信息 corehr:person.education:read 获取教育经历信息 corehr:person.education:write 读写教育经历信息 corehr:person.email:read 获取个人邮箱信息 corehr:person.email:write 读写个人邮箱信息 corehr:person.emergency_contact:read 获取紧急联系人信息 corehr:person.emergency_contact:write 读写紧急联系人信息 corehr:person.entry_leave_time:read 获取出入境日期信息 corehr:person.gender:read 获取性别信息 corehr:person.gender:write 读写性别信息 corehr:person.hukou:read 获取户口信息 corehr:person.hukou:write 读写户口信息 corehr:person.is_disabled:read 获取残疾信息 corehr:person.is_old_alone:read 获取孤老信息 corehr:person.legal_name:read 获取法定姓名信息 corehr:person.legal_name:write 读写法定姓名信息 corehr:person.marital_status:read 获取婚姻状况信息 corehr:person.marital_status:write 读写婚姻状况信息 corehr:person.martyr_family:read 获取烈属信息 corehr:person.martyr_family:write 读写烈属信息 corehr:person.national_id:read 获取证件信息 corehr:person.national_id:write 读写证件信息 corehr:person.native_region:read 获取籍贯信息 corehr:person.native_region:write 读写籍贯信息 corehr:person.passport_number:read 获取护照号码 corehr:person.personal_profile:read 获取个人资料信息 corehr:person.personal_profile:write 读写个人资料信息 corehr:person.phone:read 获取个人手机号信息 corehr:person.phone:write 读写个人手机号信息 corehr:person.race:read 获取民族/种族信息 corehr:person.resident_tax:read 获取居民身份信息 corehr:person.resident_tax:write 读写居民身份信息 corehr:person.resident_tax_custom_field:read 获取居民身份自定义字段信息 corehr:person.resident_tax_custom_field:write 读写居民身份自定义字段信息 corehr:person.work_experience:read 获取工作履历信息 corehr:person.work_experience:write 读写工作履历信息 corehr:person.is_disabled:write 读写残疾信息 corehr:person.entry_leave_time:write 读写出入境日期信息 corehr:person.is_old_alone:write 读写孤老信息 corehr:person.custom_field:write 读写个人信息中的自定义字段信息 corehr:person.born_country_region:write 读写出生国家/地区信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
client_token | string | 否 | 操作的唯一标识,用于幂等的进行更新操作,格式为标准的 UUIDV4。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 示例值:"fe599b60-450f-46ff-b2ef-9f6675625b97" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
name_list | person_name\[\] | 否 | 姓名列表,当用于【创建雇佣】 的离职重聘时,该字段必填 字段权限要求: 读写法定姓名信息(corehr:person.legal_name:write) |
└ local_primary | string | 否 | 姓 - 本地文字 示例值:"黄" |
└ local_first_name | string | 否 | 名 - 本地文字 示例值:"四" |
└ country_region_id | string | 是 | 国家/地区,可通过【查询国家/地区信息】获取 示例值:"6862995757234914824" |
└ name_type | enum | 是 | 姓名类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:name_type |
└ enum_name | string | 是 | 枚举值 示例值:"legal_name" |
└ local_first_name_2 | string | 否 | 名 - 第二本地文字 示例值:"五" |
└ local_primary_2 | string | 否 | 姓 - 第二本地文字 示例值:"王" |
└ additional_name_type | enum | 否 | 补充姓名类型,可通过【获取字段详情】获取,查询参数: - custom_api_name:additional_name_type - object_api_name:person_name |
└ enum_name | string | 是 | 枚举值 示例值:"legal_name" |
└ first_name | string | 否 | 名 示例值:"帅" |
└ full_name | string | 否 | 全名 示例值:"王大帅" |
└ hereditary | string | 否 | 姓氏称谓 示例值:"王" |
└ custom_name | string | 否 | 自定义姓名(未传入时,姓名将默认根据所属国家 / 地区规则对相关姓、名字段拼接) 示例值:"王大帅" |
└ custom_local_name | string | 否 | 本地文字的自定义姓名(未传入时,本地文字的姓名将默认根据所属国家 / 地区规则对本地文字的相关姓、名字段拼接) 示例值:"王大帅" |
└ middle_name | string | 否 | 中间名 示例值:"大" |
└ name_primary | string | 否 | 姓 示例值:"王" |
└ secondary | string | 否 | 第二姓氏 示例值:"王" |
└ social | enum | 否 | 尊称,可通过 【获取字段详情】接口获取,按如下参数查询即可: - custom_api_name:social - object_api_name:person_name 示例值:王大帅 |
└ enum_name | string | 是 | 枚举值 示例值:"example" |
└ tertiary | string | 否 | 婚后姓氏 示例值:"王" |
└ title | enum | 否 | 头衔,可通过 【获取字段详情】接口获取,按如下参数查询即可: - custom_api_name:social - object_api_name:person_name 示例值:王 |
└ enum_name | string | 是 | 枚举值 示例值:"example" |
└ local_middle_name | string | 否 | 本地中间名 示例值:"大" |
└ local_secondary | string | 否 | 第二姓氏 - 本地文字 示例值:"王" |
gender | enum | 否 | 性别,枚举值可通过【获取字段详情】接口查询,查询参数如下: - object_api_name = "person" - custom_api_name = "gender" 字段权限要求: 读写性别信息(corehr:person.gender:write) |
└ enum_name | string | 是 | 枚举值 示例值:"male" |
date_of_birth | string | 否 | 出生日期 字段权限要求: 读写生日信息(corehr:person.date_of_birth:write) 示例值:"2020-01-01" |
race | enum | 否 | 民族 / 种族,枚举值 api_name 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name = "person" - custom_api_name = "ethnicity_race" |
└ enum_name | string | 是 | 枚举值 示例值:"example" |
marital_status | enum | 否 | 婚姻状况,枚举值 api_name 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name = "person" - custom_api_name = "marital_status" 字段权限要求: 读写婚姻状况信息(corehr:person.marital_status:write) |
└ enum_name | string | 是 | 枚举值 示例值:"example" |
phone_list | phone\[\] | 否 | 电话列表 |
└ international_area_code | enum | 否 | 国家区号,可通过【获取字段详情】获取,按如下参数查询即可: - custom_api_name:international_area_code - object_api_name:phone |
└ enum_name | string | 是 | 枚举值 示例值:"86_china" |
└ phone_number | string | 是 | 电话号码 示例值:"010-12345678" |
address_list | address\[\] | 否 | 地址列表 字段权限要求: 读取个人地址信息(corehr:person.address:write) |
└ address_id | string | 否 | 地址 ID,首次创建可不填 示例值:"6989822217869624863" |
└ country_region_id | string | 是 | 国家/地区,可通过【查询国家/地区信息】获取 示例值:"6862995757234914824" |
└ region_id | string | 否 | 主要行政区,可通过【查询省份/主要行政区信息】获取 示例值:"6863326815667095047" |
└ address_line1 | string | 否 | 地址行 1 示例值:"丹佛测试地址-纽埃时区" |
└ address_line2 | string | 否 | 地址行 2 示例值:"PoewH" |
└ address_line3 | string | 否 | 地址行 3 示例值:"PoewH" |
└ address_line4 | string | 否 | 地址行 4 示例值:"jmwJc" |
└ address_line5 | string | 否 | 地址行 5 示例值:"jmwJc" |
└ address_line6 | string | 否 | 地址行 6 示例值:"jmwJc" |
└ address_line7 | string | 否 | 地址行 7 示例值:"jmwJc" |
└ address_line8 | string | 否 | 地址行 8 示例值:"rafSu" |
└ address_line9 | string | 否 | 地址行 9 示例值:"McPRG" |
└ local_address_line1 | string | 否 | 地址行 1(非拉丁语系的本地文字) 示例值:"丹佛测试地址-纽埃时区" |
└ local_address_line2 | string | 否 | 地址行 2(非拉丁语系的本地文字) 示例值:"PoewH" |
└ local_address_line3 | string | 否 | 地址行 3(非拉丁语系的本地文字) 示例值:"PoewH" |
└ local_address_line4 | string | 否 | 地址行 4(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line5 | string | 否 | 地址行 5(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line6 | string | 否 | 地址行 6(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line7 | string | 否 | 地址行 7(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line8 | string | 否 | 地址行 8(非拉丁语系的本地文字) 示例值:"rafSu" |
└ local_address_line9 | string | 否 | 地址行 9(非拉丁语系的本地文字) 示例值:"McPRG" |
└ postal_code | string | 否 | 邮政编码 示例值:"611530" |
└ address_type_list | enum\[\] | 是 | 地址类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:address - custom_api_name:address_type - 默认:home_address |
└ enum_name | string | 是 | 枚举值 示例值:"home_address" |
└ is_primary | boolean | 是 | 主要地址,默认 false 示例值:true |
└ is_public | boolean | 是 | 公开地址,默认 true 示例值:true |
└ custom_fields | custom_field_data\[\] | 否 | 自定义字段 - 具体支持的对象请参考【自定义字段说明】 |
└ custom_api_name | string | 是 | 自定义字段 apiname,即自定义字段的唯一标识 示例值:"name" |
└ value | string | 是 | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 示例值:""231"" |
email_list | email\[\] | 否 | 邮箱列表 字段权限要求: 读写个人邮箱信息(corehr:person.email:write) |
└ email | string | 是 | 邮箱地址 示例值:"1234567@example.feishu.cn" |
└ is_primary | boolean | 否 | 是否为主要邮箱,默认 true 示例值:true |
└ is_public | boolean | 否 | 是否为公开邮箱,默认 true 示例值:true |
└ email_usage | enum | 否 | 邮箱用途 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name: email - custom_api_name: email_usage - 请勿填写 work 枚举,工作邮箱在雇佣信息中操作 - 默认:emergency_contact |
└ enum_name | string | 是 | 枚举值 示例值:"emergency_contact" |
work_experience_list | work_experience_info\[\] | 否 | 工作经历列表 字段权限要求: 读写工作履历信息(corehr:person.work_experience:write) |
└ company_organization | i18n\[\] | 否 | 公司 / 组织 |
└ lang | string | 是 | 语言编码(IETF BCP 47) 示例值:"zh-CN" |
└ value | string | 是 | 文本内容 示例值:"中文示例" |
└ department | i18n\[\] | 否 | 部门 |
└ lang | string | 是 | 语言编码(IETF BCP 47) 示例值:"zh-CN" |
└ value | string | 是 | 文本内容 示例值:"中文示例" |
└ job | i18n\[\] | 否 | 岗位 |
└ lang | string | 是 | 语言编码(IETF BCP 47) 示例值:"zh-CN" |
└ value | string | 是 | 文本内容 示例值:"中文示例" |
└ description | i18n\[\] | 否 | 工作描述 |
└ lang | string | 是 | 语言编码(IETF BCP 47) 示例值:"zh-CN" |
└ value | string | 是 | 文本内容 示例值:"中文示例" |
└ start_date | string | 否 | 开始日期 示例值:"2020-01-01" |
└ end_date | string | 否 | 结束日期 示例值:"2020-01-01" |
└ custom_fields | custom_field_data\[\] | 否 | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 是 | 自定义字段 apiname,即自定义字段的唯一标识 示例值:"name" |
└ value | string | 是 | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 示例值:""231"" |
education_list | education\[\] | 否 | 教育经历列表 字段权限要求: 读写教育经历信息(corehr:person.education:write) |
└ school | i18n\[\] | 是 | 学校 - 如果学校有对应枚举,请使用 school_name 字段 |
└ lang | string | 是 | 语言编码(IETF BCP 47) 示例值:"zh-CN" |
└ value | string | 是 | 文本内容 示例值:"中文示例" |
└ level_of_education | enum | 否 | 学历 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:education - custom_api_name:level_of_education |
└ enum_name | string | 是 | 枚举值 示例值:"phd" |
└ start_date | string | 否 | 开始日期 示例值:"2011-09-01" |
└ end_date | string | 否 | 结束日期 示例值:"2015-06-30" |
└ field_of_study | i18n\[\] | 否 | 专业名称 - 如果专业有对应枚举,请使用 field_of_study_name 字段 |
└ lang | string | 是 | 语言编码(IETF BCP 47) 示例值:"zh-CN" |
└ value | string | 是 | 文本内容 示例值:"中文示例" |
└ degree | enum | 否 | 学位 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:education - custom_api_name:degree |
└ enum_name | string | 是 | 枚举值 示例值:"mba" |
└ school_name | enum | 否 | 学校名称 - 可通过【获取字段详情】获取,查询参数: - custom_api_name:school_name - object_api_name:education - 如果学校有对应枚举,请使用该字段,否则可使用 school 直接写入文本 |
└ enum_name | string | 是 | 枚举值 示例值:"example" |
└ field_of_study_name | enum | 否 | 专业名称 - 可通过【获取字段详情】获取,查询参数: - custom_api_name:field_of_study_name - object_api_name:education - 如果专业有对应枚举,请使用该字段,否则可使用 field_of_study 直接写入文本 |
└ enum_name | string | 是 | 枚举值 示例值:"example" |
└ country_region_id | string | 否 | 国家/地区ID,可通过【查询国家/地区信息】获取 示例值:"1" |
└ expected_end_date | string | 否 | 预期结束日期 示例值:"2011-09-01" |
└ custom_fields | custom_field_data\[\] | 否 | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 是 | 自定义字段 apiname,即自定义字段的唯一标识 示例值:"name" |
└ value | string | 是 | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 示例值:""231"" |
bank_account_list | bank_account\[\] | 否 | 银行账户 字段权限要求: 读写银行账号列表信息(corehr:person.bank_account:write) |
└ bank_name | string | 否 | 银行名称 - 如果有对应银行ID,请使用 bank_id_v2 示例值:"中国农业银行" |
└ bank_account_number | string | 是 | 银行账号 示例值:"6231200000001223" |
└ account_holder | string | 是 | 开户人姓名 示例值:"孟十五" |
└ branch_name | string | 否 | 支行名称 - 如果有对应支行 ID,请使用 branch_id_v2 示例值:"中国农业银行支行" |
└ bank_id_v2 | string | 否 | 银行 ID,可通过【查询银行信息】接口查询获得 示例值:"MDBH00000001" |
└ branch_id_v2 | string | 否 | 支行 ID,要求必须为填入银行的支行,可通过【查询支行信息】接口查询获得 示例值:"MDBK00000017" |
└ country_region_id | string | 否 | 国家/地区ID,可通过【查询国家/地区信息】获取 示例值:"12" |
└ bank_account_usage | enum\[\] | 否 | 银行卡类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name: bank_account - custom_api_name: bank_account_type |
└ enum_name | string | 是 | 枚举值 示例值:"payment" |
└ bank_account_type | enum | 否 | 银行卡类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name: bank_account - custom_api_name: bank_account_type |
└ enum_name | string | 是 | 枚举值 示例值:"checking" |
└ currency_id | string | 否 | 货币 ID - 详细信息可通过【查询货币信息】接口查询获得 示例值:"12QueryCountryRegionSubdivisionDataReq" |
└ custom_fields | custom_field_data\[\] | 否 | 自定义字段 - 具体支持的对象请参考【自定义字段说明】 |
└ custom_api_name | string | 是 | 自定义字段 apiname,即自定义字段的唯一标识 示例值:"name" |
└ value | string | 是 | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 示例值:""231"" |
national_id_list | national_id\[\] | 否 | 证件列表 字段权限要求: 读写证件信息(corehr:person.national_id:write) |
└ national_id_type_id | string | 是 | 国家证件类型,可通过【批量查询国家证件类型】获得 示例值:"6863330041896371725" |
└ national_id_number | string | 是 | 证件号码 示例值:"1231131333" |
└ issue_date | string | 否 | 证件签发日期 示例值:"2020-04-01" |
└ expiration_date | string | 否 | 证件到期日期 示例值:"2020-05-21" |
└ country_region_id | string | 是 | 国家/地区ID,可通过【查询国家/地区信息】获取 示例值:"6862995757234914824" |
└ issued_by | string | 否 | 证件签发机构 示例值:"北京市公安局" |
└ custom_fields | custom_field_data\[\] | 否 | 自定义字段 - 具体支持的对象请参考【自定义字段说明】 |
└ custom_api_name | string | 是 | 自定义字段 apiname,即自定义字段的唯一标识 示例值:"name" |
└ value | string | 是 | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 示例值:""231"" |
dependent_list | dependent\[\] | 否 | 家庭成员列表 字段权限要求: 读写家庭成员信息(corehr:person.dependent:write) |
└ relationship | enum | 是 | 亲属关系 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:dependent - custom_api_name:relationship_with_dependent |
└ enum_name | string | 是 | 枚举值 示例值:"parent" |
└ gender | enum | 否 | 性别,枚举值可通过【获取字段详情】接口查询,查询参数如下: - object_api_name = "person" - custom_api_name = "gender" |
└ enum_name | string | 是 | 枚举值 示例值:"male" |
└ date_of_birth | string | 否 | 生日 示例值:"2020-01-01" |
└ nationality_id_v2 | string | 否 | 国籍 ID,可通过【查询国籍信息】接口查询 示例值:"6862995745046267401" |
└ national_id_list | national_id\[\] | 否 | 证件号码 |
└ national_id_type_id | string | 是 | 国家证件类型,可通过【批量查询国家证件类型】获得 示例值:"6863330041896371725" |
└ national_id_number | string | 是 | 证件号码 示例值:"1231131333" |
└ issue_date | string | 否 | 证件签发日期 示例值:"2020-04-01" |
└ expiration_date | string | 否 | 证件到期日期 示例值:"2020-05-21" |
└ country_region_id | string | 是 | 国家/地区ID,可通过【查询国家/地区信息】获取 示例值:"6862995757234914824" |
└ issued_by | string | 否 | 证件签发机构 示例值:"北京市公安局" |
└ custom_fields | custom_field_data\[\] | 否 | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 是 | 自定义字段 apiname,即自定义字段的唯一标识 示例值:"name" |
└ value | string | 是 | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 示例值:""231"" |
└ spouses_working_status | enum | 否 | 配偶工作状态,可通过【获取字段详情】获取,查询参数: - custom_api_name:spouses_working_status - object_api_name:dependent |
└ enum_name | string | 是 | 枚举值 示例值:"example" |
└ is_this_person_covered_by_health_insurance | boolean | 否 | 包含家属医疗保险 示例值:true |
└ is_this_person_allowed_for_tax_deduction | boolean | 否 | 允许家属抵扣税款 示例值:false |
└ custom_fields | custom_field_data\[\] | 否 | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 是 | 自定义字段 apiname,即自定义字段的唯一标识 示例值:"name" |
└ value | string | 是 | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 示例值:""231"" |
└ dependent_name | string | 否 | 家庭成员姓名 示例值:"张三" |
└ employer | string | 否 | 工作单位 示例值:"海淀区交警大队" |
└ job | string | 否 | 岗位 示例值:"保安" |
└ phone | phone | 否 | 电话 |
└ international_area_code | enum | 否 | 国家区号,可通过【获取字段详情】获取,按如下参数查询即可: - custom_api_name:international_area_code - object_api_name:phone |
└ enum_name | string | 是 | 枚举值 示例值:"86_china" |
└ phone_number | string | 是 | 电话号码 示例值:"010-12345678" |
└ address | address | 否 | 联系地址 |
└ address_id | string | 否 | 地址 ID,在【创建个人信息】、【更新个人信息】时可获得 示例值:"6989822217869624863" |
└ country_region_id | string | 是 | 国家/地区,可通过【查询国家/地区信息】获取 示例值:"6862995757234914824" |
└ region_id | string | 否 | 主要行政区,可通过【查询省份/主要行政区信息】获取 示例值:"6863326815667095047" |
└ address_line1 | string | 否 | 地址行 1 示例值:"丹佛测试地址-纽埃时区" |
└ address_line2 | string | 否 | 地址行 2 示例值:"PoewH" |
└ address_line3 | string | 否 | 地址行 3 示例值:"PoewH" |
└ address_line4 | string | 否 | 地址行 4 示例值:"jmwJc" |
└ address_line5 | string | 否 | 地址行 5 示例值:"jmwJc" |
└ address_line6 | string | 否 | 地址行 6 示例值:"jmwJc" |
└ address_line7 | string | 否 | 地址行 7 示例值:"jmwJc" |
└ address_line8 | string | 否 | 地址行 8 示例值:"rafSu" |
└ address_line9 | string | 否 | 地址行 9 示例值:"McPRG" |
└ local_address_line1 | string | 否 | 地址行 1(非拉丁语系的本地文字) 示例值:"丹佛测试地址-纽埃时区" |
└ local_address_line2 | string | 否 | 地址行 2(非拉丁语系的本地文字) 示例值:"PoewH" |
└ local_address_line3 | string | 否 | 地址行 3(非拉丁语系的本地文字) 示例值:"PoewH" |
└ local_address_line4 | string | 否 | 地址行 4(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line5 | string | 否 | 地址行 5(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line6 | string | 否 | 地址行 6(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line7 | string | 否 | 地址行 7(非拉丁语系的本地文字) 示例值:"jmwJc" |
└ local_address_line8 | string | 否 | 地址行 8(非拉丁语系的本地文字) 示例值:"rafSu" |
└ local_address_line9 | string | 否 | 地址行 9(非拉丁语系的本地文字) 示例值:"McPRG" |
└ postal_code | string | 否 | 邮政编码 示例值:"611530" |
└ custom_fields | custom_field_data\[\] | 否 | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 是 | 自定义字段 apiname,即自定义字段的唯一标识 示例值:"name" |
└ value | string | 是 | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 示例值:""231"" |
└ birth_certificate_of_child | file\[\] | 否 | 出生证明 |
└ id | string | 否 | 上传文件ID,可通过【上传文件】获取 示例值:"150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200" |
emergency_contact_list | emergency_contact\[\] | 否 | 紧急联系人列表 字段权限要求: 读写紧急联系人信息(corehr:person.emergency_contact:write) |
└ name | person_name | 否 | 姓名 - 该字段已废弃,请使用 legal_name |
└ local_primary | string | 否 | 姓 - 本地文字 示例值:"黄" |
└ local_first_name | string | 否 | 名 - 本地文字 示例值:"四" |
└ country_region_id | string | 是 | 国家/地区,可通过【查询国家/地区信息】获取 示例值:"6862995757234914824" |
└ name_type | enum | 是 | 姓名类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:name_type |
└ enum_name | string | 是 | 枚举值 示例值:"legal_name" |
└ local_first_name_2 | string | 否 | 名 - 第二本地文字 示例值:"五" |
└ local_primary_2 | string | 否 | 姓 - 第二本地文字 示例值:"王" |
└ additional_name_type | enum | 否 | 补充姓名类型,可通过【获取字段详情】获取,查询参数: - custom_api_name:additional_name_type - object_api_name:person_name |
└ enum_name | string | 是 | 枚举值 示例值:"legal_name" |
└ first_name | string | 否 | 名 示例值:"帅" |
└ full_name | string | 否 | 全名 示例值:"王大帅" |
└ hereditary | string | 否 | 姓氏称谓 示例值:"王" |
└ custom_name | string | 否 | 自定义姓名(未传入时,姓名将默认根据所属国家 / 地区规则对相关姓、名字段拼接) 示例值:"王大帅" |
└ custom_local_name | string | 否 | 本地文字的自定义姓名(未传入时,本地文字的姓名将默认根据所属国家 / 地区规则对本地文字的相关姓、名字段拼接) 示例值:"王大帅" |
└ middle_name | string | 否 | 中间名 示例值:"大" |
└ name_primary | string | 否 | 姓 示例值:"王" |
└ secondary | string | 否 | 第二姓氏 示例值:"王" |
└ social | enum | 否 | 尊称,可通过 【获取字段详情】接口获取,按如下参数查询即可: - custom_api_name:social - object_api_name:person_name 示例值:王大帅 |
└ enum_name | string | 是 | 枚举值 示例值:"example" |
└ tertiary | string | 否 | 婚后姓氏 示例值:"王" |
└ title | enum | 否 | 头衔,可通过 【获取字段详情】接口获取,按如下参数查询即可: - custom_api_name:social - object_api_name:person_name 示例值:王 |
└ enum_name | string | 是 | 枚举值 示例值:"example" |
└ local_middle_name | string | 否 | 本地中间名 示例值:"大" |
└ local_secondary | string | 否 | 第二姓氏 - 本地文字 示例值:"王" |
└ relationship | enum | 否 | 关系 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:dependent - custom_api_name:relationship_with_dependent |
└ enum_name | string | 是 | 枚举值 示例值:"parent" |
└ phone_ist | phone\[\] | 否 | 电话 |
└ international_area_code | enum | 否 | 国家区号,可通过【获取字段详情】获取,按如下参数查询即可: - custom_api_name:international_area_code - object_api_name:phone |
└ enum_name | string | 是 | 枚举值 示例值:"86_china" |
└ phone_number | string | 是 | 电话号码 示例值:"010-12345678" |
└ legal_name | string | 否 | 法定姓名 示例值:"张三" |
└ custom_fields | custom_field_data\[\] | 否 | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 是 | 自定义字段 apiname,即自定义字段的唯一标识 示例值:"name" |
└ value | string | 是 | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 示例值:""231"" |
date_entered_workforce | string | 否 | 参加工作日期 字段权限要求: 读写参加工作日期(corehr:person.date_entered_workforce:write) 示例值:"2020-10-01" |
profile_image_id | string | 否 | 头像资源的 ID - 该字段已废弃 示例值:"dfysuc8x76dsfsw" |
personal_profile | personal_profile\[\] | 否 | 个人资料附件 字段权限要求: 读写个人资料信息(corehr:person.personal_profile:write) |
└ personal_profile_type | enum | 否 | 资料类型 - 可通过【获取字段详情】获取,查询参数: - custom_api_name:profile_type - object_api_name:personal_profile - 仅 【飞书人事-档案配置-资料附件】存在的字段编码可用 |
└ enum_name | string | 是 | 枚举值 示例值:"example" |
└ files | file\[\] | 否 | 上传文件列表 |
└ id | string | 否 | 上传文件ID 示例值:"150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200" |
native_region | string | 否 | 籍贯 ID,可通过【查询省份/主要行政区信息】接口查询 字段权限要求: 读写籍贯信息(corehr:person.native_region:write) 示例值:"6863326262618752111" |
hukou_type | enum | 否 | 户口类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name: person_info_chn - custom_api_name: hukou_type 字段权限要求: 读写户口信息(corehr:person.hukou:write) |
└ enum_name | string | 是 | 枚举值 示例值:"local_urban_residence" |
hukou_location | string | 否 | 户口所在地 字段权限要求: 读写户口信息(corehr:person.hukou:write) 示例值:"山东省平阴县" |
political_affiliations | enum\[\] | 否 | 政治面貌 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:person_info_chn - custom_api_name:political_affiliation |
└ enum_name | string | 是 | 枚举值 示例值:"communist_party_of_china" |
talent_id | string | 否 | 人才ID,可通过【获取人才列表】获取 示例值:"6863326262618752123" |
custom_fields | custom_field_data\[\] | 否 | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 是 | 自定义字段 apiname,即自定义字段的唯一标识 示例值:"name" |
└ value | string | 是 | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 示例值:""231"" |
born_country_region | string | 否 | 出生国家/地区 示例值:"中国" |
is_disabled | boolean | 否 | 是否残疾 示例值:true |
disable_card_number | string | 否 | 残疾证号 示例值:"1110000" |
is_martyr_family | boolean | 否 | 是否烈属 示例值:true |
martyr_card_number | string | 否 | 烈属证号 示例值:"1110000" |
is_old_alone | boolean | 否 | 是否孤老 示例值:true |
resident_taxes | resident_tax\[\] | 否 | 居民身份信息 示例值:6863326262618752123 |
└ year_resident_tax | string | 是 | 年度 示例值:"2023" |
└ resident_status | enum | 否 | 居民身份,枚举值可通过【获取字段详情】接口查询,查询参数如下: - object_api_name = "resident_tax" - custom_api_name = "resident_status" |
└ enum_name | string | 是 | 枚举值 示例值:"example" |
└ tax_country_region_id | string | 否 | 国家/地区,可通过【查询国家/地区信息】接口查询 示例值:"中国" |
└ custom_fields | object_field_data\[\] | 否 | 自定义字段 - 请参考【自定义字段说明】 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 示例值:"Sandy" |
first_entry_time | string | 否 | 首次入境日期 示例值:"2021-01-02" |
leave_time | string | 否 | 预计离境日期 示例值:"2022-01-02" |
请求体示例
json
{
"name_list": [
{
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "legal_name"
},
"local_first_name_2": "五",
"local_primary_2": "王",
"additional_name_type": {
"enum_name": "legal_name"
},
"first_name": "帅",
"full_name": "王大帅",
"hereditary": "王",
"custom_name": "王大帅",
"custom_local_name": "王大帅",
"middle_name": "大",
"name_primary": "王",
"secondary": "王",
"social": {
"enum_name": "example"
},
"tertiary": "王",
"title": {
"enum_name": "example"
},
"local_middle_name": "大",
"local_secondary": "王"
}
],
"gender": {
"enum_name": "male"
},
"date_of_birth": "2020-01-01",
"race": {
"enum_name": "example"
},
"marital_status": {
"enum_name": "example"
},
"phone_list": [
{
"international_area_code": {
"enum_name": "86_china"
},
"phone_number": "010-12345678"
}
],
"address_list": [
{
"address_id": "6989822217869624863",
"country_region_id": "6862995757234914824",
"region_id": "6863326815667095047",
"address_line1": "丹佛测试地址-纽埃时区",
"address_line2": "PoewH",
"address_line3": "PoewH",
"address_line4": "jmwJc",
"address_line5": "jmwJc",
"address_line6": "jmwJc",
"address_line7": "jmwJc",
"address_line8": "rafSu",
"address_line9": "McPRG",
"local_address_line1": "丹佛测试地址-纽埃时区",
"local_address_line2": "PoewH",
"local_address_line3": "PoewH",
"local_address_line4": "jmwJc",
"local_address_line5": "jmwJc",
"local_address_line6": "jmwJc",
"local_address_line7": "jmwJc",
"local_address_line8": "rafSu",
"local_address_line9": "McPRG",
"postal_code": "611530",
"address_type_list": [
{
"enum_name": "home_address"
}
],
"is_primary": true,
"is_public": true,
"custom_fields": [
{
"custom_api_name": "name",
"value": "\"231\""
}
]
}
],
"email_list": [
{
"email": "1234567@example.feishu.cn",
"is_primary": true,
"is_public": true,
"email_usage": {
"enum_name": "emergency_contact"
}
}
],
"work_experience_list": [
{
"company_organization": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"department": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"job": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"description": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"start_date": "2020-01-01",
"end_date": "2020-01-01",
"custom_fields": [
{
"custom_api_name": "name",
"value": "\"231\""
}
]
}
],
"education_list": [
{
"school": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"level_of_education": {
"enum_name": "phd"
},
"start_date": "2011-09-01",
"end_date": "2015-06-30",
"field_of_study": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"degree": {
"enum_name": "mba"
},
"school_name": {
"enum_name": "example"
},
"field_of_study_name": {
"enum_name": "example"
},
"country_region_id": "1",
"expected_end_date": "2011-09-01",
"custom_fields": [
{
"custom_api_name": "name",
"value": "\"231\""
}
]
}
],
"bank_account_list": [
{
"bank_name": "中国农业银行",
"bank_account_number": "6231200000001223",
"account_holder": "孟十五",
"branch_name": "中国农业银行支行",
"bank_id_v2": "MDBH00000001",
"branch_id_v2": "MDBK00000017",
"country_region_id": "12",
"bank_account_usage": [
{
"enum_name": "payment"
}
],
"bank_account_type": {
"enum_name": "checking"
},
"currency_id": "12QueryCountryRegionSubdivisionDataReq",
"custom_fields": [
{
"custom_api_name": "name",
"value": "\"231\""
}
]
}
],
"national_id_list": [
{
"national_id_type_id": "6863330041896371725",
"national_id_number": "1231131333",
"issue_date": "2020-04-01",
"expiration_date": "2020-05-21",
"country_region_id": "6862995757234914824",
"issued_by": "北京市公安局",
"custom_fields": [
{
"custom_api_name": "name",
"value": "\"231\""
}
]
}
],
"dependent_list": [
{
"relationship": {
"enum_name": "parent"
},
"gender": {
"enum_name": "male"
},
"date_of_birth": "2020-01-01",
"nationality_id_v2": "6862995745046267401",
"national_id_list": [
{
"national_id_type_id": "6863330041896371725",
"national_id_number": "1231131333",
"issue_date": "2020-04-01",
"expiration_date": "2020-05-21",
"country_region_id": "6862995757234914824",
"issued_by": "北京市公安局",
"custom_fields": [
{
"custom_api_name": "name",
"value": "\"231\""
}
]
}
],
"spouses_working_status": {
"enum_name": "example"
},
"is_this_person_covered_by_health_insurance": true,
"is_this_person_allowed_for_tax_deduction": false,
"custom_fields": [
{
"custom_api_name": "name",
"value": "\"231\""
}
],
"dependent_name": "张三",
"employer": "海淀区交警大队",
"job": "保安",
"phone": {
"international_area_code": {
"enum_name": "86_china"
},
"phone_number": "010-12345678"
},
"address": {
"address_id": "6989822217869624863",
"country_region_id": "6862995757234914824",
"region_id": "6863326815667095047",
"address_line1": "丹佛测试地址-纽埃时区",
"address_line2": "PoewH",
"address_line3": "PoewH",
"address_line4": "jmwJc",
"address_line5": "jmwJc",
"address_line6": "jmwJc",
"address_line7": "jmwJc",
"address_line8": "rafSu",
"address_line9": "McPRG",
"local_address_line1": "丹佛测试地址-纽埃时区",
"local_address_line2": "PoewH",
"local_address_line3": "PoewH",
"local_address_line4": "jmwJc",
"local_address_line5": "jmwJc",
"local_address_line6": "jmwJc",
"local_address_line7": "jmwJc",
"local_address_line8": "rafSu",
"local_address_line9": "McPRG",
"postal_code": "611530",
"custom_fields": [
{
"custom_api_name": "name",
"value": "\"231\""
}
]
},
"birth_certificate_of_child": [
{
"id": "150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200"
}
]
}
],
"emergency_contact_list": [
{
"name": {
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "legal_name"
},
"local_first_name_2": "五",
"local_primary_2": "王",
"additional_name_type": {
"enum_name": "legal_name"
},
"first_name": "帅",
"full_name": "王大帅",
"hereditary": "王",
"custom_name": "王大帅",
"custom_local_name": "王大帅",
"middle_name": "大",
"name_primary": "王",
"secondary": "王",
"social": {
"enum_name": "example"
},
"tertiary": "王",
"title": {
"enum_name": "example"
},
"local_middle_name": "大",
"local_secondary": "王"
},
"relationship": {
"enum_name": "parent"
},
"phone_ist": [
{
"international_area_code": {
"enum_name": "86_china"
},
"phone_number": "010-12345678"
}
],
"legal_name": "张三",
"custom_fields": [
{
"custom_api_name": "name",
"value": "\"231\""
}
]
}
],
"date_entered_workforce": "2020-10-01",
"profile_image_id": "dfysuc8x76dsfsw",
"personal_profile": [
{
"personal_profile_type": {
"enum_name": "example"
},
"files": [
{
"id": "150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200"
}
]
}
],
"native_region": "6863326262618752111",
"hukou_type": {
"enum_name": "local_urban_residence"
},
"hukou_location": "山东省平阴县",
"political_affiliations": [
{
"enum_name": "communist_party_of_china"
}
],
"talent_id": "6863326262618752123",
"custom_fields": [
{
"custom_api_name": "name",
"value": "\"231\""
}
],
"born_country_region": "中国",
"is_disabled": true,
"disable_card_number": "1110000",
"is_martyr_family": true,
"martyr_card_number": "1110000",
"is_old_alone": true,
"resident_taxes": [
{
"year_resident_tax": "2023",
"resident_status": {
"enum_name": "example"
},
"tax_country_region_id": "中国",
"custom_fields": [
{
"field_name": "name",
"value": "Sandy"
}
]
}
],
"first_entry_time": "2021-01-02",
"leave_time": "2022-01-02"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ person | person_info | 个人信息 |
└ person_id | string | 个人信息 ID,可通过【批量查询员工信息】获取详细信息 |
└ phone_number | string | 个人电话 字段权限要求(满足任一): corehr:person.phone:read 获取个人手机号信息 corehr:person.phone:write 读写个人手机号信息 |
└ legal_name | string | 法定姓名 字段权限要求(满足任一): corehr:person.legal_name:read 获取法定姓名信息 corehr:person.legal_name:write 读写法定姓名信息 |
└ preferred_name | string | 常用名 |
└ preferred_local_full_name | string | 常用本地全名 |
└ preferred_english_full_name | string | 常用英文全名 |
└ name_list | person_name\[\] | 姓名列表 字段权限要求(满足任一): corehr:person.legal_name:read 获取法定姓名信息 corehr:person.legal_name:write 读写法定姓名信息 |
└ local_primary | string | 姓 - 本地文字 |
└ local_first_name | string | 名 - 本地文字 |
└ country_region_id | string | 国家 / 地区,可通过【查询国家/地区信息】获取详细信息 |
└ name_type | enum | 姓名类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:name_type |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ local_first_name_2 | string | 名 - 第二本地文字 |
└ local_primary_2 | string | 姓 - 第二本地文字 |
└ additional_name_type | enum | 补充姓名类型,可通过【获取字段详情】获取,查询参数: - custom_api_name:additional_name_type - object_api_name:person_name |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ first_name | string | 名 |
└ full_name | string | 全名 |
└ hereditary | string | 姓氏称谓 |
└ custom_name | string | 自定义姓名(未传入时,姓名将默认根据所属国家 / 地区规则对相关姓、名字段拼接) |
└ custom_local_name | string | 本地文字的自定义姓名(未传入时,本地文字的姓名将默认根据所属国家 / 地区规则对本地文字的相关姓、名字段拼接) |
└ middle_name | string | 中间名 |
└ name_primary | string | 姓 |
└ secondary | string | 第二姓氏 |
└ social | enum | 尊称,可通过 【获取字段详情】接口获取,按如下参数查询即可: - custom_api_name:social - object_api_name:person_name |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ tertiary | string | 婚后姓氏 |
└ title | enum | 头衔,可通过 【获取字段详情】接口获取,按如下参数查询即可: - custom_api_name:social - object_api_name:person_name |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ local_middle_name | string | 本地中间名 |
└ local_secondary | string | 第二姓氏 - 本地文字 |
└ display_name_local_and_western_script | string | 展示姓名(本地和西方文字) |
└ display_name_local_script | string | 展示姓名(本地文字) |
└ display_name_western_script | string | 展示姓名(西方文字) |
└ gender | enum | 性别,枚举值可通过【获取字段详情】接口查询,查询参数如下: - object_api_name = "person" - custom_api_name = "gender" 字段权限要求(满足任一): corehr:person.gender:read 获取性别信息 corehr:person.gender:write 读写性别信息 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ date_of_birth | string | 出生日期 字段权限要求(满足任一): corehr:person.date_of_birth:read 获取生日信息 corehr:person.date_of_birth:write 读写生日信息 |
└ race | enum | 民族 / 种族,枚举值 api_name 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name = "person" - custom_api_name = "ethnicity_race" 字段权限要求: corehr:person.race:read 获取民族/种族信息 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ marital_status | enum | 婚姻状况,枚举值 api_name 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name = "person" - custom_api_name = "marital_status" 字段权限要求: 读写婚姻状况信息(corehr:person.marital_status:write) 字段权限要求(满足任一): corehr:person.marital_status:read 获取婚姻状况信息 corehr:person.marital_status:write 读写婚姻状况信息 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ phone_list | phone\[\] | 电话列表 字段权限要求(满足任一): corehr:person.phone:read 获取个人手机号信息 corehr:person.phone:write 读写个人手机号信息 |
└ international_area_code | enum | 国家区号,枚举值 api_name 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name = "phone" - custom_api_name = "international_area_code" |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ phone_number | string | 电话号码 |
└ formatted_phone_number | string | 完整电话号码 |
└ device_type | enum | 设备类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:phone - custom_api_name:device_type |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ phone_usage | enum | 电话用途 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:phone - custom_api_name:phone_usage |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ is_primary | boolean | 主要电话 |
└ is_public | boolean | 公开电话 |
└ address_list | address\[\] | 地址列表 字段权限要求(满足任一): corehr:person.address:read 读取个人地址信息 corehr:person.address:write 读写个人地址信息 |
└ full_address_local_script | string | 完整地址(本地文字) |
└ full_address_western_script | string | 完整地址(西方文字) |
└ address_id | string | 地址 ID,可用于【更新个人信息】联系地址更新 |
└ country_region_id | string | 国家 / 地区,可通过【查询国家/地区信息】查询 |
└ region_id | string | 主要行政区,可通过【查询省份/主要行政区信息】查询 |
└ address_line1 | string | 地址行 1 |
└ address_line2 | string | 地址行 2 |
└ address_line3 | string | 地址行 3 |
└ address_line4 | string | 地址行 4 |
└ address_line5 | string | 地址行 5 |
└ address_line6 | string | 地址行 6 |
└ address_line7 | string | 地址行 7 |
└ address_line8 | string | 地址行 8 |
└ address_line9 | string | 地址行 9 |
└ local_address_line1 | string | 地址行 1(非拉丁语系的本地文字) |
└ local_address_line2 | string | 地址行 2(非拉丁语系的本地文字) |
└ local_address_line3 | string | 地址行 3(非拉丁语系的本地文字) |
└ local_address_line4 | string | 地址行 4(非拉丁语系的本地文字) |
└ local_address_line5 | string | 地址行 5(非拉丁语系的本地文字) |
└ local_address_line6 | string | 地址行 6(非拉丁语系的本地文字) |
└ local_address_line7 | string | 地址行 7(非拉丁语系的本地文字) |
└ local_address_line8 | string | 地址行 8(非拉丁语系的本地文字) |
└ local_address_line9 | string | 地址行 9(非拉丁语系的本地文字) |
└ postal_code | string | 邮政编码 |
└ address_type_list | enum\[\] | 地址类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:address - custom_api_name:address_type |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ is_primary | boolean | 主要地址 |
└ is_public | boolean | 公开地址 |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 具体支持的对象请参考【自定义字段说明】 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ email_list | email\[\] | 邮箱列表 字段权限要求(满足任一): corehr:person.email:read 获取个人邮箱信息 corehr:person.email:write 读写个人邮箱信息 |
└ email | string | 邮箱地址 |
└ is_primary | boolean | 是否为主要邮箱 |
└ is_public | boolean | 是否为公开邮箱 |
└ email_usage | enum | 邮箱用途 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name: email - custom_api_name:email_usage |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ work_experience_list | work_experience_info\[\] | 工作经历列表 字段权限要求(满足任一): corehr:person.work_experience:read 获取工作履历信息 corehr:person.work_experience:write 读写工作履历信息 |
└ company_organization | i18n\[\] | 公司 / 组织 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ department | i18n\[\] | 部门 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ job | i18n\[\] | 岗位 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ description | i18n\[\] | 工作描述 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ start_date | string | 开始日期 |
└ end_date | string | 结束日期 |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ education_list | education\[\] | 教育经历列表 字段权限要求(满足任一): corehr:person.education:read 获取教育经历信息 corehr:person.education:write 读写教育经历信息 |
└ school | i18n\[\] | 学校 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ level_of_education | enum | 学历 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:education - custom_api_name:level_of_education |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ start_date | string | 开始日期 |
└ end_date | string | 结束日期 |
└ field_of_study | i18n\[\] | 专业 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ degree | enum | 学位 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:education - custom_api_name:degree |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ school_name | enum | 学校名称,可通过【获取字段详情】获取,查询参数: - custom_api_name:school_name - object_api_name:education |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ field_of_study_name | enum | 专业名称,可通过【获取字段详情】获取,查询参数: - custom_api_name:field_of_study_name - object_api_name:education |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ country_region_id | string | 国家地区 ID,详细信息可通过【查询国家/地区信息】接口查询获得 |
└ expected_end_date | string | 预期结束日期 |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ bank_account_list | bank_account\[\] | 银行账户 字段权限要求(满足任一): corehr:person.bank_account:read 获取银行账号列表信息 corehr:person.bank_account:write 读写银行账号信息 |
└ bank_name | string | 银行名称 |
└ bank_account_number | string | 银行账号 |
└ account_holder | string | 开户人姓名 |
└ branch_name | string | 支行名称 |
└ bank_id_v2 | string | 银行 ID,详细信息可通过【查询银行信息】接口查询获得 |
└ branch_id_v2 | string | 支行 ID,要求必须为填入银行的支行,详细信息可通过【查询支行信息】接口查询获得 |
└ country_region_id | string | 国家/地区 ID,详细信息可通过【查询国家/地区信息】接口查询获得 |
└ bank_account_usage | enum\[\] | 银行卡用途 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name: bank_account - custom_api_name: bank_account_usage |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ bank_account_type | enum | 银行卡类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name: bank_account - custom_api_name: bank_account_type |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ currency_id | string | 货币 ID,详细信息可通过【查询货币信息】接口查询获得 |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ national_id_list | national_id\[\] | 证件 字段权限要求(满足任一): corehr:person.national_id:read 获取证件信息 corehr:person.national_id:write 读写证件信息 |
└ national_id_type_id | string | 国家证件类型,可通过【查询单个国家证件类型】获取详细信息 |
└ national_id_number | string | 证件号码 |
└ issue_date | string | 证件签发日期 |
└ expiration_date | string | 证件到期日期 |
└ country_region_id | string | 国家/地区ID,可通过【查询国家/地区信息】获取 |
└ issued_by | string | 证件签发机构 |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 具体支持的对象请参考【自定义字段说明】 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ dependent_list | dependent\[\] | 家庭成员列表 字段权限要求(满足任一): corehr:person.dependent:read 获取家庭成员信息 corehr:person.dependent:write 读写家庭成员信息 |
└ name | person_name | 姓名 |
└ local_primary | string | 姓 - 本地文字 |
└ local_first_name | string | 名 - 本地文字 |
└ country_region_id | string | 国家/地区ID,可通过【查询国家/地区信息】获取 |
└ name_type | enum | 姓名类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:name_type |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ local_first_name_2 | string | 名 - 第二本地文字 |
└ local_primary_2 | string | 姓 - 第二本地文字 |
└ additional_name_type | enum | 补充姓名类型,可通过【获取字段详情】获取,查询参数: - custom_api_name:additional_name_type - object_api_name:person_name |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ first_name | string | 名 |
└ full_name | string | 全名 |
└ hereditary | string | 姓氏称谓 |
└ custom_name | string | 自定义姓名(未传入时,姓名将默认根据所属国家 / 地区规则对相关姓、名字段拼接) |
└ custom_local_name | string | 本地文字的自定义姓名(未传入时,本地文字的姓名将默认根据所属国家 / 地区规则对本地文字的相关姓、名字段拼接) |
└ middle_name | string | 中间名 |
└ name_primary | string | 姓 |
└ secondary | string | 第二姓氏 |
└ social | enum | 尊称,可通过 【获取字段详情】接口获取,按如下参数查询即可: - custom_api_name:social - object_api_name:person_name |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ tertiary | string | 婚后姓氏 |
└ title | enum | 头衔,可通过 【获取字段详情】接口获取,按如下参数查询即可: - custom_api_name:social - object_api_name:person_name |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ local_middle_name | string | 本地中间名 |
└ local_secondary | string | 第二姓氏 - 本地文字 |
└ display_name_local_and_western_script | string | 展示姓名(本地和西方文字) |
└ display_name_local_script | string | 展示姓名(本地文字) |
└ display_name_western_script | string | 展示姓名(西方文字) |
└ relationship | enum | 关系 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:dependent - custom_api_name:relationship_with_dependent |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ gender | enum | 性别,枚举值可通过【获取字段详情】接口查询,查询参数如下: - object_api_name = "person" - custom_api_name = "gender" |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ date_of_birth | string | 生日 |
└ nationality_id_v2 | string | 国籍 ID,可通过【查询国籍信息】接口查询 |
└ national_id_list | national_id\[\] | 证件号码 |
└ national_id_type_id | string | 国家证件类型,可通过【查询单个国家证件类型】获取详细信息 |
└ national_id_number | string | 证件号码 |
└ issue_date | string | 证件签发日期 |
└ expiration_date | string | 证件到期日期 |
└ country_region_id | string | 国家/地区ID,可通过【查询国家/地区信息】获取 |
└ issued_by | string | 证件签发机构 |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 具体支持的对象请参考【自定义字段说明】 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ spouses_working_status | enum | 配偶工作状态,可通过【获取字段详情】获取,查询参数: - custom_api_name:spouses_working_status - object_api_name:dependent |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ is_this_person_covered_by_health_insurance | boolean | 包含家属医疗保险 |
└ is_this_person_allowed_for_tax_deduction | boolean | 允许家属抵扣税款 |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ dependent_name | string | 家庭成员姓名 |
└ employer | string | 工作单位 |
└ job | string | 岗位 |
└ phone | phone | 电话 |
└ international_area_code | enum | 国家区号 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ phone_number | string | 电话号码 |
└ formatted_phone_number | string | 完整电话号码 |
└ device_type | enum | 设备类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:phone - custom_api_name:device_type |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ phone_usage | enum | 电话用途 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:phone - custom_api_name:phone_usage |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ is_primary | boolean | 主要电话 |
└ is_public | boolean | 公开电话 |
└ address | address | 联系地址 |
└ full_address_local_script | string | 完整地址(本地文字) |
└ full_address_western_script | string | 完整地址(西方文字) |
└ address_id | string | 地址 ID,在【更新个人信息】-家庭联系地址时使用 |
└ country_region_id | string | 国家/地区,可通过【查询国家/地区信息】获取 |
└ region_id | string | 主要行政区,可通过【查询省份/主要行政区信息】获取 |
└ address_line1 | string | 地址行 1 |
└ address_line2 | string | 地址行 2 |
└ address_line3 | string | 地址行 3 |
└ address_line4 | string | 地址行 4 |
└ address_line5 | string | 地址行 5 |
└ address_line6 | string | 地址行 6 |
└ address_line7 | string | 地址行 7 |
└ address_line8 | string | 地址行 8 |
└ address_line9 | string | 地址行 9 |
└ local_address_line1 | string | 地址行 1(非拉丁语系的本地文字) |
└ local_address_line2 | string | 地址行 2(非拉丁语系的本地文字) |
└ local_address_line3 | string | 地址行 3(非拉丁语系的本地文字) |
└ local_address_line4 | string | 地址行 4(非拉丁语系的本地文字) |
└ local_address_line5 | string | 地址行 5(非拉丁语系的本地文字) |
└ local_address_line6 | string | 地址行 6(非拉丁语系的本地文字) |
└ local_address_line7 | string | 地址行 7(非拉丁语系的本地文字) |
└ local_address_line8 | string | 地址行 8(非拉丁语系的本地文字) |
└ local_address_line9 | string | 地址行 9(非拉丁语系的本地文字) |
└ postal_code | string | 邮政编码 |
└ address_type_list | enum\[\] | 地址类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:address - custom_api_name:address_type |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ is_primary | boolean | 主要地址 |
└ is_public | boolean | 公开地址 |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ birth_certificate_of_child | file\[\] | 出生证明 |
└ id | string | 文件 ID,可用于【下载文件】 |
└ name | string | 文件名 |
└ emergency_contact_list | emergency_contact\[\] | 紧急联系人列表 字段权限要求(满足任一): corehr:person.emergency_contact:read 获取紧急联系人信息 corehr:person.emergency_contact:write 读写紧急联系人信息 |
└ name | person_name | 姓名 |
└ local_primary | string | 姓 - 本地文字 |
└ local_first_name | string | 名 - 本地文字 |
└ country_region_id | string | 国家/地区,可通过【查询国家/地区信息】获取 |
└ name_type | enum | 姓名类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:person_name - custom_api_name:name_type |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ local_first_name_2 | string | 名 - 第二本地文字 |
└ local_primary_2 | string | 姓 - 第二本地文字 |
└ additional_name_type | enum | 补充姓名类型,可通过【获取字段详情】获取,查询参数: - custom_api_name:additional_name_type - object_api_name:person_name |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ first_name | string | 名 |
└ full_name | string | 全名 |
└ hereditary | string | 姓氏称谓 |
└ custom_name | string | 自定义姓名(未传入时,姓名将默认根据所属国家 / 地区规则对相关姓、名字段拼接) |
└ custom_local_name | string | 本地文字的自定义姓名(未传入时,本地文字的姓名将默认根据所属国家 / 地区规则对本地文字的相关姓、名字段拼接) |
└ middle_name | string | 中间名 |
└ name_primary | string | 姓 |
└ secondary | string | 第二姓氏 |
└ social | enum | 尊称,可通过 【获取字段详情】接口获取,按如下参数查询即可: - custom_api_name:social - object_api_name:person_name |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ tertiary | string | 婚后姓氏 |
└ title | enum | 头衔,可通过 【获取字段详情】接口获取,按如下参数查询即可: - custom_api_name:social - object_api_name:person_name |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ local_middle_name | string | 本地中间名 |
└ local_secondary | string | 第二姓氏 - 本地文字 |
└ display_name_local_and_western_script | string | 展示姓名(本地和西方文字) |
└ display_name_local_script | string | 展示姓名(本地文字) |
└ display_name_western_script | string | 展示姓名(西方文字) |
└ relationship | enum | 关系 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:dependent - custom_api_name:relationship_with_dependent |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ phone_ist | phone\[\] | 电话 |
└ international_area_code | enum | 国家区号,可通过【获取字段详情】获取,按如下参数查询即可: - custom_api_name:international_area_code - object_api_name:phone |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ phone_number | string | 电话号码 |
└ formatted_phone_number | string | 完整电话号码 |
└ device_type | enum | 设备类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:phone - custom_api_name:device_type |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ phone_usage | enum | 电话用途 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:phone - custom_api_name:phone_usage |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ is_primary | boolean | 主要电话 |
└ is_public | boolean | 公开电话 |
└ phone_list | phone\[\] | 电话 |
└ international_area_code | enum | 国家区号,可通过【获取字段详情】获取,按如下参数查询即可: - custom_api_name:international_area_code - object_api_name:phone |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ phone_number | string | 电话号码 |
└ formatted_phone_number | string | 完整电话号码 |
└ device_type | enum | 设备类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:phone - custom_api_name:device_type |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ phone_usage | enum | 电话用途 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:phone - custom_api_name:phone_usage |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ is_primary | boolean | 主要电话 |
└ is_public | boolean | 公开电话 |
└ legal_name | string | 法定姓名 |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ date_entered_workforce | string | 参加工作日期 字段权限要求(满足任一): corehr:person.date_entered_workforce:read 获取参加工作日期 corehr:person.date_entered_workforce:write 读写参加工作日期 |
└ working_years | int | 工龄 |
└ profile_image_id | string | 头像资源的 ID - 该字段已废弃 |
└ email_address | string | 邮箱地址 字段权限要求(满足任一): corehr:person.email:read 获取个人邮箱信息 corehr:person.email:write 读写个人邮箱信息 |
└ age | int | 年龄 字段权限要求(满足任一): corehr:person.date_of_birth:read 获取生日信息 corehr:person.date_of_birth:write 读写生日信息 |
└ highest_level_of_education | education | 最高学历教育经历 字段权限要求(满足任一): corehr:person.education:read 获取教育经历信息 corehr:person.education:write 读写教育经历信息 |
└ school | i18n\[\] | 学校 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ level_of_education | enum | 学历 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:education - custom_api_name:level_of_education |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ start_date | string | 开始日期 |
└ end_date | string | 结束日期 |
└ field_of_study | i18n\[\] | 专业 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ degree | enum | 学位 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:education - custom_api_name:degree |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ school_name | enum | 学校名称,可通过【获取字段详情】获取,查询参数: - custom_api_name:school_name - object_api_name:education |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ field_of_study_name | enum | 专业名称,可通过【获取字段详情】获取,查询参数: - custom_api_name:field_of_study_name - object_api_name:education |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ country_region_id | string | 国家地区 ID,详细信息可通过【查询国家/地区信息】接口查询获得 |
└ expected_end_date | string | 预期结束日期 |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 请参考【自定义字段说明】 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ highest_degree_of_education | education | 最高学位教育经历 字段权限要求(满足任一): corehr:person.education:read 获取教育经历信息 corehr:person.education:write 读写教育经历信息 |
└ school | i18n\[\] | 学校 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ level_of_education | enum | 学历 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:education - custom_api_name:level_of_education |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ start_date | string | 开始日期 |
└ end_date | string | 结束日期 |
└ field_of_study | i18n\[\] | 专业 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ degree | enum | 学位 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name:education - custom_api_name:degree |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ school_name | enum | 学校名称,可通过【获取字段详情】获取,查询参数: - custom_api_name:school_name - object_api_name:education |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ field_of_study_name | enum | 专业名称,可通过【获取字段详情】获取,查询参数: - custom_api_name:field_of_study_name - object_api_name:education |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ country_region_id | string | 国家地区 ID,详细信息可通过【查询国家/地区信息】接口查询获得 |
└ expected_end_date | string | 预期结束日期 |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 具体支持的对象请参考【自定义字段说明】 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ personal_profile | personal_profile\[\] | 个人资料附件 字段权限要求(满足任一): corehr:person.personal_profile:read 获取个人资料信息 corehr:person.personal_profile:write 读写个人资料信息 |
└ personal_profile_type | enum | 资料类型 - 可通过【获取字段详情】获取,查询参数: - custom_api_name:profile_type - object_api_name:personal_profile - 仅 【飞书人事-档案配置-资料附件】存在的字段编码可用 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ files | file\[\] | 上传文件列表 |
└ id | string | 上传文件 ID,可用于【下载文件】 |
└ name | string | 文件名 |
└ native_region | string | 籍贯 ID,详细信息可通过【查询省份/行政区信息】接口查询获得 字段权限要求(满足任一): corehr:person.native_region:read 获取籍贯信息 corehr:person.native_region:write 读写籍贯信息 |
└ hukou_type | enum | 户口类型 - 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name: person_info_chn - custom_api_name: hukou_type 字段权限要求(满足任一): corehr:person.hukou:read 获取户口信息 corehr:person.hukou:write 读写户口信息 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ hukou_location | string | 户口所在地 字段权限要求(满足任一): corehr:person.hukou:read 获取户口信息 corehr:person.hukou:write 读写户口信息 |
└ talent_id | string | 人才 ID |
└ custom_fields | custom_field_data\[\] | 自定义字段 - 请参考【自定义字段说明】 字段权限要求(满足任一): corehr:person.custom_field:read 获取个人信息自定义字段信息 corehr:person.custom_field:write 读写个人信息中的自定义字段信息 |
└ custom_api_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ name | custom_name | 自定义字段名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ type | int | 自定义字段类型 |
└ value | string | 字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段 |
└ national_id_number | string | 居民身份证件号码 字段权限要求(满足任一): corehr:person.national_id:read 获取证件信息 corehr:person.national_id:write 读写证件信息 |
└ family_address | string | 家庭地址 字段权限要求(满足任一): corehr:person.address:read 读取个人地址信息 corehr:person.address:write 读写个人地址信息 |
└ born_country_region | string | 出生国家/地区 字段权限要求(满足任一): corehr:person.born_country_region:read 获取出生国家/地区信息 corehr:person.born_country_region:write 读写出生国家/地区信息 |
└ is_disabled | boolean | 是否残疾 字段权限要求(满足任一): corehr:person.is_disabled:read 获取残疾信息 corehr:person.is_disabled:write 读写残疾信息 |
└ disable_card_number | string | 残疾证号 字段权限要求(满足任一): corehr:person.is_disabled:read 获取残疾信息 corehr:person.is_disabled:write 读写残疾信息 |
└ is_martyr_family | boolean | 是否烈属 字段权限要求(满足任一): corehr:person.martyr_family:read 获取烈属信息 corehr:person.martyr_family:write 读写烈属信息 |
└ martyr_card_number | string | 烈属证号 字段权限要求(满足任一): corehr:person.martyr_family:read 获取烈属信息 corehr:person.martyr_family:write 读写烈属信息 |
└ is_old_alone | boolean | 是否孤老 字段权限要求(满足任一): corehr:person.is_old_alone:read 获取孤老信息 corehr:person.is_old_alone:write 读写孤老信息 |
└ resident_taxes | resident_tax\[\] | 居民身份信息 字段权限要求(满足任一): corehr:person.resident_tax:read 获取居民身份信息 corehr:person.resident_tax:write 读写居民身份信息 |
└ year_resident_tax | string | 年度 |
└ resident_status | enum | 居民身份,枚举值 api_name 可通过【获取字段详情】接口查询,查询参数如下: - object_api_name = "resident_tax" - custom_api_name = "resident_status" |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言编码(IETF BCP 47) |
└ value | string | 文本内容 |
└ tax_country_region_id | string | 国家/地区,可通过【查询国家/地区信息】接口查询 |
└ custom_fields | object_field_data\[\] | 自定义字段 字段权限要求(满足任一): corehr:person.resident_tax_custom_field:read 获取居民身份自定义字段信息 corehr:person.resident_tax_custom_field:write 读写居民身份自定义字段信息 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(123, 123.23, true, ["id1","id2], 2006-01-02 15:04:05]) |
└ first_entry_time | string | 首次入境日期 字段权限要求(满足任一): corehr:person.entry_leave_time:read 获取出入境日期信息 corehr:person.entry_leave_time:write 读写出入境日期信息 |
└ leave_time | string | 预计离境日期 字段权限要求(满足任一): corehr:person.entry_leave_time:read 获取出入境日期信息 corehr:person.entry_leave_time:write 读写出入境日期信息 |
└ passport_number | string | 护照号码 字段权限要求: corehr:person.passport_number:read 获取护照号码 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"person": {
"person_id": "6919733936050406926",
"phone_number": "13649211111",
"legal_name": "张三",
"preferred_name": "刘梓新(Henry)",
"preferred_local_full_name": "刘梓新",
"preferred_english_full_name": "Henry",
"name_list": [
{
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "legal_name",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"local_first_name_2": "五",
"local_primary_2": "王",
"additional_name_type": {
"enum_name": "legal_name",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"first_name": "帅",
"full_name": "王大帅",
"hereditary": "王",
"custom_name": "王大帅",
"custom_local_name": "王大帅",
"middle_name": "大",
"name_primary": "王",
"secondary": "王",
"social": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"tertiary": "王",
"title": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"local_middle_name": "大",
"local_secondary": "王",
"display_name_local_and_western_script": "王大帅",
"display_name_local_script": "王大帅",
"display_name_western_script": "王大帅"
}
],
"gender": {
"enum_name": "male",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"date_of_birth": "2020-01-01",
"race": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"marital_status": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"phone_list": [
{
"international_area_code": {
"enum_name": "86_china",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"phone_number": "010-12345678",
"formatted_phone_number": "+86 010-12345678",
"device_type": {
"enum_name": "mobile_phone",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"phone_usage": {
"enum_name": "home",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"is_primary": true,
"is_public": true
}
],
"address_list": [
{
"full_address_local_script": "中国北京北京",
"full_address_western_script": "Beijing, Beijing, China,",
"address_id": "6989822217869624863",
"country_region_id": "6862995757234914824",
"region_id": "6863326815667095047",
"address_line1": "丹佛测试地址-纽埃时区",
"address_line2": "PoewH",
"address_line3": "PoewH",
"address_line4": "jmwJc",
"address_line5": "jmwJc",
"address_line6": "jmwJc",
"address_line7": "jmwJc",
"address_line8": "rafSu",
"address_line9": "McPRG",
"local_address_line1": "丹佛测试地址-纽埃时区",
"local_address_line2": "PoewH",
"local_address_line3": "PoewH",
"local_address_line4": "jmwJc",
"local_address_line5": "jmwJc",
"local_address_line6": "jmwJc",
"local_address_line7": "jmwJc",
"local_address_line8": "rafSu",
"local_address_line9": "McPRG",
"postal_code": "611530",
"address_type_list": [
{
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
}
],
"is_primary": true,
"is_public": true,
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
]
}
],
"email_list": [
{
"email": "1234567@ example.feishu.cn",
"is_primary": true,
"is_public": true,
"email_usage": {
"enum_name": "home",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
}
}
],
"work_experience_list": [
{
"company_organization": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"department": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"job": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"description": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"start_date": "2020-01-01",
"end_date": "2020-01-01",
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
]
}
],
"education_list": [
{
"school": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"level_of_education": {
"enum_name": "phd",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"start_date": "2011-09-01",
"end_date": "2015-06-30",
"field_of_study": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"degree": {
"enum_name": "mba",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"school_name": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"field_of_study_name": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"country_region_id": "1",
"expected_end_date": "2011-09-01",
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
]
}
],
"bank_account_list": [
{
"bank_name": "中国农业银行",
"bank_account_number": "6231200000001223",
"account_holder": "孟十五",
"branch_name": "中国农业银行支行",
"bank_id_v2": "MDBH00000001",
"branch_id_v2": "MDBK00000017",
"country_region_id": "12",
"bank_account_usage": [
{
"enum_name": "checking",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
}
],
"bank_account_type": {
"enum_name": "checking",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"currency_id": "12QueryCountryRegionSubdivisionDataReq",
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
]
}
],
"national_id_list": [
{
"national_id_type_id": "6863330041896371725",
"national_id_number": "1231131333",
"issue_date": "2020-04-01",
"expiration_date": "2020-05-21",
"country_region_id": "6862995757234914824",
"issued_by": "北京市公安局",
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
]
}
],
"dependent_list": [
{
"name": {
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "legal_name",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"local_first_name_2": "五",
"local_primary_2": "王",
"additional_name_type": {
"enum_name": "legal_name",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"first_name": "帅",
"full_name": "王大帅",
"hereditary": "王",
"custom_name": "王大帅",
"custom_local_name": "王大帅",
"middle_name": "大",
"name_primary": "王",
"secondary": "王",
"social": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"tertiary": "王",
"title": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"local_middle_name": "大",
"local_secondary": "王",
"display_name_local_and_western_script": "王大帅",
"display_name_local_script": "王大帅",
"display_name_western_script": "王大帅"
},
"relationship": {
"enum_name": "parent",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"gender": {
"enum_name": "male",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"date_of_birth": "2020-01-01",
"nationality_id_v2": "6862995745046267401",
"national_id_list": [
{
"national_id_type_id": "6863330041896371725",
"national_id_number": "1231131333",
"issue_date": "2020-04-01",
"expiration_date": "2020-05-21",
"country_region_id": "6862995757234914824",
"issued_by": "北京市公安局",
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
]
}
],
"spouses_working_status": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"is_this_person_covered_by_health_insurance": true,
"is_this_person_allowed_for_tax_deduction": false,
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
],
"dependent_name": "张三",
"employer": "海淀区交警大队",
"job": "保安",
"phone": {
"international_area_code": {
"enum_name": "86_china",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"phone_number": "010-12345678",
"formatted_phone_number": "+86 010-12345678",
"device_type": {
"enum_name": "fax",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"phone_usage": {
"enum_name": "home",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"is_primary": true,
"is_public": true
},
"address": {
"full_address_local_script": "中国北京北京",
"full_address_western_script": "Beijing, Beijing, China,",
"address_id": "6989822217869624863",
"country_region_id": "6862995757234914824",
"region_id": "6863326815667095047",
"address_line1": "丹佛测试地址-纽埃时区",
"address_line2": "PoewH",
"address_line3": "PoewH",
"address_line4": "jmwJc",
"address_line5": "jmwJc",
"address_line6": "jmwJc",
"address_line7": "jmwJc",
"address_line8": "rafSu",
"address_line9": "McPRG",
"local_address_line1": "丹佛测试地址-纽埃时区",
"local_address_line2": "PoewH",
"local_address_line3": "PoewH",
"local_address_line4": "jmwJc",
"local_address_line5": "jmwJc",
"local_address_line6": "jmwJc",
"local_address_line7": "jmwJc",
"local_address_line8": "rafSu",
"local_address_line9": "McPRG",
"postal_code": "611530",
"address_type_list": [
{
"enum_name": "home_address",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
}
],
"is_primary": true,
"is_public": true,
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
]
},
"birth_certificate_of_child": [
{
"id": "150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200",
"name": "document.txt"
}
]
}
],
"emergency_contact_list": [
{
"name": {
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "legal_name",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"local_first_name_2": "五",
"local_primary_2": "王",
"additional_name_type": {
"enum_name": "emergency_contact_name",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"first_name": "帅",
"full_name": "王大帅",
"hereditary": "王",
"custom_name": "王大帅",
"custom_local_name": "王大帅",
"middle_name": "大",
"name_primary": "王",
"secondary": "王",
"social": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"tertiary": "王",
"title": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"local_middle_name": "大",
"local_secondary": "王",
"display_name_local_and_western_script": "王大帅",
"display_name_local_script": "王大帅",
"display_name_western_script": "王大帅"
},
"relationship": {
"enum_name": "parent",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"phone_ist": [
{
"international_area_code": {
"enum_name": "86_china",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"phone_number": "010-12345678",
"formatted_phone_number": "+86 010-12345678",
"device_type": {
"enum_name": "fax",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"phone_usage": {
"enum_name": "home",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"is_primary": true,
"is_public": true
}
],
"phone_list": [
{
"international_area_code": {
"enum_name": "86_china",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"phone_number": "010-12345678",
"formatted_phone_number": "+86 010-12345678",
"device_type": {
"enum_name": "fax",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"phone_usage": {
"enum_name": "home",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"is_primary": true,
"is_public": true
}
],
"legal_name": "张三",
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
]
}
],
"date_entered_workforce": "2020-10-01",
"working_years": 2,
"profile_image_id": "dfysuc8x76dsfsw",
"email_address": "test@example.feishu.cn",
"age": 22,
"highest_level_of_education": {
"school": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"level_of_education": {
"enum_name": "phd",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"start_date": "2011-09-01",
"end_date": "2015-06-30",
"field_of_study": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"degree": {
"enum_name": "mba",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"school_name": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"field_of_study_name": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"country_region_id": "1",
"expected_end_date": "2011-09-01",
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
]
},
"highest_degree_of_education": {
"school": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"level_of_education": {
"enum_name": "phd",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"start_date": "2011-09-01",
"end_date": "2015-06-30",
"field_of_study": [
{
"lang": "zh-CN",
"value": "中文示例"
}
],
"degree": {
"enum_name": "mba",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"school_name": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"field_of_study_name": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"country_region_id": "1",
"expected_end_date": "2011-09-01",
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
]
},
"personal_profile": [
{
"personal_profile_type": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"files": [
{
"id": "150018109586e8ea745e47ae8feb3722dbe1d03a181336393633393133303431393831343930373235150200",
"name": "document.txt"
}
]
}
],
"native_region": "6863326262618752111",
"hukou_type": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"hukou_location": "山东省平阴县",
"talent_id": "6863326262618752123",
"custom_fields": [
{
"custom_api_name": "name",
"name": {
"zh_cn": "自定义姓名",
"en_us": "Custom Name"
},
"type": 1,
"value": "\"231\""
}
],
"national_id_number": "11010000000000",
"family_address": "6863326262618752123",
"born_country_region": "中国",
"is_disabled": true,
"disable_card_number": "1110000",
"is_martyr_family": true,
"martyr_card_number": "1110000",
"is_old_alone": true,
"resident_taxes": [
{
"year_resident_tax": "2023",
"resident_status": {
"enum_name": "example",
"display": [
{
"lang": "zh-CN",
"value": "中文示例"
}
]
},
"tax_country_region_id": "中国",
"custom_fields": [
{
"field_name": "name",
"value": "Sandy"
}
]
}
],
"first_entry_time": "2021-01-02",
"leave_time": "2022-01-02",
"passport_number": "6919733936050406926"
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1160001 | param is invalid | 请检查输入参数 |
| 400 | 1160021 | param is invalid | 请检查输入参数 |
| 400 | 1160022 | param is invalid | 请检查输入参数 |
| 400 | 1160004 | request ID repeat | 请检查参数client_token |
| 400 | 1160017 | No permission to modify data | 请检查权限配置 |
| 500 | 1160999 | internal server error | 请联系技术支持 |
