ATS用户中心
所有文章
系统应用
升级公告
常见问题
公开课
校招专栏
内推和门店
数据平台
亮点功能
热门活动
基础操作视频
API文档
时间字段格式说明(Date)
API开发指南(Guide)
主动推送说明(Webhooks)
公共API
招聘官网API
企业信息API
门店API
组织架构API
职责API
用户API
招聘需求 API
候选人API
职位API
面试API
Offer API
入职API
内推账户API
猎头API
BI报表API
district code
错误码
人才库数据导入
最后更新于 2024/04/03   阅读数 88

HTTP请求

POST https://api.mokahr.com/api-platform/v2/syncCandidates

请求body参数(application/json)

字段

必填

类型

描述

candidateName

string

候选人姓名

candidatePhone

string

候选人手机号

candidateEmail

string

候选人邮箱

note

string

备注

channelType

string

渠道类型
如果未匹配
可选值:
1:招聘网站(moka已对接的招聘网站)
2:社招门户
3:内推门户
4:猎头
5:人才库
6:其他渠道
7:内部自有
8:招聘网站(客户自定义的一个渠道类别)
9:招聘会
10:论坛
11:SNS
12:其他
默认:5

sourceStatistics

string

来源效果
在channel_type为2、3、4时需要填写,若未填写,导入失败

channelName

string

渠道
如果未匹配,默认:人才库

source

int

来源
各个渠道默认的来源
可选值:
1:主动搜索
2:主动投递
3:人才推荐

appliedAt

string

申请时间
若为空,默认使用系统当前时间
格式遵从ISO8061标准

jobId

string

职位ID

candidateAge

integer

候选人年龄

candidateGender

string

候选人性别

candidateLastCompany

string

最近公司

candidateLastSpeciality

string

最近毕业专业

candidateAcademicDegree

string

最高学历

educationInfo

array

教育经历

educationInfo[].school

string

学校名称

educationInfo[].startDate

格式遵从ISO8601标准 string

开始时间

educationInfo[].endDate

格式遵从ISO8601标准 string

结束时间

educationInfo[].speciality

string

学习专业

educationInfo[].academicDegree

string

学历

experienceInfo

array

工作经验

experienceInfo[].company

string

公司名称

experienceInfo[].startDate

格式遵从ISO8601标准 string

开始时间

experienceInfo[].endDate

格式遵从ISO8061标准 string

结束时间

experienceInfo[].title

string

工作职位

experienceInfo[].summary

string

工作职责

projectInfo

array

项目经验

projectInfo[].projectName

string

项目名称

projectInfo[].startDate

格式遵从ISO8601标准 string

开始时间

projectInfo[].endDate

格式遵从ISO8601标准 string

结束时间

projectInfo[].title

string

项目中担任的> 职责

projectInfo[].projectDescription

string

项目功能描述

projectInfo[].responsibilities

string

项目中的职责

practiceInfo

array

实习经历

practiceInfo[].company

string

公司名称

practiceInfo[].title

string

职位名称

practiceInfo[].startDate

格式遵从ISO8601标准 string

开始时间

practiceInfo[].endDate

格式遵从ISO8601标准 string

结束时间

practiceInfo[].summary

string

工作职责

jobIntention

object

求职意向

jobIntention.aimSalary

string

期望薪资

jobIntention.forwardLocation

string

期望城市

selfDescription

object

自我描述

selfDescription.personal

object

自我描述,简介

customFields[].id

integer

自定义字段id

customFields[].value

string

自定义字段值

customFields[].index

number

如果当前模块数据是一个数组且含有自定义字段,则该值必填且与数组下标一致(备注:支持自定义模块数据)

talentPoolId

int

若是入职人才库,需填写:hired_type、hired_time
若是离职人才库,须填写:resign_type、resign_detail、resign_time
若需要导入黑名单人才库,此人才库ID为黑名单人才库ID
若要导入人才库,则该字段是必填的

email

string

用户邮箱
有人才库权限的用户邮箱, 若归档候选人时,该字段必填

hiredTime

string

入职时间
默认使用请求时间

isResignWriteJob

boolean

是否回写离职信息
可选值:
0:不开启
1:开启,开启后需填写离职职位
默认:0

resignJobName

string

离职职位

resignDepartment

string

离职部门

reason

int

离职原因
可选值:
0:已离职
1:主动离职
2:被动离职

detail

string

离职详情
若为离职,该字段必填

time

string

离职时间(日期格式为:ISO8601)
若为空,则为当前时间

political

string

政治面貌

certificateType

string

证件类型
枚举值
1:身份证
2:身份证(中国香港)
3:身份证(中国澳门)
4:身份证(中国台湾)
5:护照
6:其他证件
7:港澳居民来往内地通行证
8:台湾居民来往内地通行证
9:外国人工作许可证
10:外国人居留许可证

citizenId | 否 | string | 证件号码

请求body参数 (multipart/form-data方式)

字段

类型

描述

candidateInfo

string

json格式的字符串,字段同json请求方式的body

resume

file

简历文件

attachments

file

附件文件,可以同时传多个

返回

返回body的JSON数据如下:

字段

类型

描述

msg

string

报错信息

code

integer

返回码

data

object

返回数据

可能的错误信息

code

errorMessage

说明

200

success

成功

1240040102

channel_source.error

渠道来源错误

1240040104

talent_pool_Id.error

人才库错误

1240040105

userId.error

用户id错误(a.不存在该用户;b.ID错误)

1240040106

user_permission.error

用户无权限

请求样例 (application/json)

$ curl https://api.mokahr.com/api-platform/v2/syncCandidates \
   -u 'your_api_key:' \
   -X PUT \
   -H 'Content-Type: application/json' \
   -d '{ "orgId":"livingsimple", "candidateName": "test", "candidatePhone": "18700998899", "candidateEmail": "1234@test.com", "note": "测试备注", "talentPoolId": 200000131, "email": "xiedi@mokahr.com", "resignDepartment": "离职部门", "reason": 1, "detail": "世界那么大,我想去看看", "time": "2020-01-01 00:00:00", "channelType": 5, "channelName": "人才库", "source": 0, "jobId": "07af7045-b4e7-43eb-ba64-87128c4df3bf", "candidateAge": 18, "candidateGender": "男", "candidateLastCompany": "天南", "candidateLastSpeciality": "化工", "candidateAcademicDegree": "本科", "hiredTime": "2020-01-01 00:00:00", "educationInfo": [ { "school": "北京大学", "startDate": "2014-09", "endDate": "2017-06", "speciality": "软件工程", "academicDegree": "本科" } ], "experienceInfo": [ { "company": "百度", "startDate": "2014-09", "endDate": "2017-06", "title": "初级工程师", "summary": "负责产品功能实现" },{ "company": "百度", "startDate": "2014-09", "endDate": "2017-06", "title": "初级工程师", "summary": "负责产品功能实现" } ], "projectInfo": [ { "projectName": "项目1", "startDate": "2017-01", "endDate": "2017-11", "projectDescription": "项目功能描述", "title": "后端工程师", "responsibilities": "项目职责" }, { "projectName": "项目2", "startDate": "2017-01", "endDate": "2017-11", "projectDescription": "项目功能描述", "title": "后端工程师", "responsibilities": "项目职责" } ], "practiceInfo": [ { "company": "腾讯", "title": "实习工程师", "startDate": "2017-01", "endDate": "2017-11", "summary": "负责简单的功能实现" },{ "company": "腾讯", "title": "实习工程师", "startDate": "2017-01", "endDate": "2017-11", "summary": "负责简单的功能实现" } ], "jobIntention": { "aimSalary": "7000-13000元/月", "forwardLocation": "北京" }, "selfDescription": { "personal": "人经历丰富,在校担任过部长,主持人以及新生教官。" }, "customFields": [ { "id": 146, "value": "22", "index": 0 }, { "id": 121, "value": "22", "index": 10 }, { "id": 124, "value": "bbb", "index": 0 }, { "id": 130, "value": {"endDate":"2020-01","startDate":"2021-01"}, "index": 0 } ], "isResignWriteJob": true, "resignJobName": "工程师", "resignJobType": "技术" }'
1
2
3
4
5
plaintext

请求样例(multipart/form-data方式)

$ curl https://api.mokahr.com/api-platform/v2/syncCandidates \
   -u 'your_api_key:' \
   -X PUT \
   -H 'Content-Type: multipart/form-data' \
   -F 'basicInfo={"candidateName": "王五","age": 20,"gender": "男","candidatePhone": "13800000000","candidateEmail":"test@mokahr.com","jobId":"330fd7e3-45a1-4705-828c-7e1beafad355","talentPoolId":200004785,"email":"test@mokahr.com"}' \
   -F 'resume=@/path/to/resume/张三.pdf' \
   -F 'attachments=@/path/to/attachments/attach1.txt'
1
2
3
4
5
6
7
plaintext

返回示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "applicationId": 189316652,
        "candidateId": 168776432
    }
}
1
2
3
4
5
6
7
8
plaintext

失败返回实例

{
    "code": 40040102,
    "msg":  "找不到归档原因,归档信息错误"
}
1
2
3
4
plaintext
未能解决您的问题?请联系
本篇目录

HTTP请求

请求body参数(application/json)

请求body参数 (multipart/form-data方式)

返回

可能的错误信息

请求样例 (application/json)

请求样例(multipart/form-data方式)

返回示例

失败返回实例