文档中心 员工接口 批量同步接口

批量同步接口

1.功能说明

批量同步员工到关爱通企业平台

注意:

(1)工号(corp_code)只支持字母数字,不区分大小写。建议企业用不变且唯一的标识作为工号;

(2)手机号(mobile) 支持国内外手机号,国外手机同步区号(mobile_area),不填写区号默认为国内手机号

2.接口调用说明

请求URL

https://openapi.guanaitong.tech/employee/v2/batchSynchronize

HTTP请求方式

POST

输入参数说明

(1)公共参数

发送请求是必须传入公共参数,详见公共参数

(2)私有参数

参数名称 是否必须 参数类型 长度限制 描述
enterprise_code string [1,20] 企业编号(集团和运营商同步,企业不填)
employee_list json 员工集合
employee_list.userid string [1,100] 员工第三方唯一标识
employee_list.code string [1,20] 员工工号
employee_list.name string [1,50] 员工姓名
employee_list.status int 员工状态 1 在职 2 离职
employee_list.gender int [1] 性别,1:男;2:女;3:未知
employee_list.email string [1,100] 邮箱,企业内唯一
employee_list.mobile_area int [1,10] 手机区号,国外手机同步,不填默认为国内手机区号(86)
employee_list.mobile string [6,20] 手机,企业内唯一。默认mobileemail之间至少选填一个,若不想填写,请联系关爱通人员配置
employee_list.remark string [0,254] 备注
employee_list.dept_code string [1,50] 部门编号
employee_list.level string [1,50] 员工分级(需先在企业后台开启该功能)
employee_list.category string [] 员工分类,多个分类,用“,”分割(需先在企业后台开启该功能)
employee_list.birth_day string [10] 生日,格式为yyyy-MM-dd,如:1991-01-01
employee_list.entry_day string [10] 入职日,格式为yyyy-MM-dd,如:2016-02-03
employee_list.card_type int [1] 证件类型,1-身份证,2-护照,3-香港居民身份证,4-澳门居民身份证,5-台湾身份证,6-台胞证,7-回乡证
employee_list.card_no string [1,30] 证件号码
employee_list.employee_attribute string 扩展信息,JsonArray,格式如:
List«EmployeeAttribute»(需先确认扩展信息已启用的字段,合同性质、固定电话、级别、分类等默认已启用)

(4)employee_attribute中的EmployeeAttribute对象

参数名称 是否必须 参数类型 长度限制 描述
attributeCode string [1,100] 扩展字段编号,如:contractNature(合同性质)taxpayerMapper(纳税人归属)
taxpayerIdentifier(纳税人识别号)
attributeValue string [1,100] 扩展字段值,如:contractNature对应:
正式员工,试用员工,临时员工,实习生,兼职员工,外聘员工
taxpayerMapper对应纳税人归属id
请求示例
POST /employee/v2/batchSynchronize?access_token=d9d6951d1b57e6cb4ddd6cf32d0d5e56&version=1.0.0&sign=4025567bf21aef6490cb3d1f9630a2b5c32fdb1d×tamp=1640077417 HTTP/1.1
Host: //openapi.guanaitong.tech
Content-Type: application/json
Content-Length: 721

{
	"employee_list": [{
		"code": "HB0001",
		"userid": "1",
		"name": "HB0001",
		"gender": 3,
		"status": 1,
		"mobile": "13564307640",
		"birth_day": "1990-10-11",
        "card_type":1,
        "card_no":"110101199010118618",
        "employee_attribute":"[{\"attributeCode\":\"taxpayerIdentifier\",\"attributeValue\":\"18923123654521\"}]",
        "category":"最帅",
        "level":"帅"
	}, {
		"code": "HB0002",
		"userid": "2",
		"name": "HB0002",
		"gender": 3,
		"status": 1,
		"mobile": "13564307641",
		"birth_day": "1995-01-11"
	}, {
		"code": "HB0003",
		"userid": "3",
		"name": "HB0003",
		"gender": 3,
		"status": 1,
		"mobile": "13564307642",
		"birth_day": "1999-12-11"
	}]
}
                    
返回参数说明
参数名称 描述
code 返回码。详见错误返回码
msg 如果错误,返回错误信息。
data 如果没有错误,返回业务数据。消息通知标识notifyId,供下次推送消息时对应匹配员工同步情况(设计时该字段长度为100位以内) 。
正确返回示例
{
    "code": 0,
    "data": "589072095bea0f68043a7a2797476ec3",
    "msg": "OK"
}
错误返回示例
{
    "code": 1000210001,
    "msg": "timestamp check failed!",
    "data": null
}