文档中心 员工接口 添加员工

添加员工

1.功能说明

添加员工到关爱通企业平台

注意:

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

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

2.接口调用说明

请求URL

https://openapi.guanaitong.tech/employee/add

HTTP请求方式

POST

输入参数说明

(1)公共参数

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

(2)私有参数

参数名称 是否必须 参数类型 长度限制 描述
corp_code string [1,20] 员工工号
userid string [1,100] 员工第三方唯一标识,工号和唯一标识必填其一
enterprise_code string [1,20] 企业编号(集团和运营商同步,企业不填)
name string [1,50] 员工姓名,若想加密传输该字段,请联系关爱通人员配置
gender int [1] 性别,1:男;2:女;3:未知
email string [1,100] 邮箱,企业内唯一
mobile_area int [1,10] 手机区号,国外手机同步,不填默认为国内手机区号(86)
mobile string [6,20] 手机,企业内唯一。默认mobileemail之间至少选填一个,若不想填写,请联系关爱通人员配置
send_invite int [1] 是否发送登录邀请, 1:发送,2:不发送。默认不发送。
remark string [0,254] 备注
dept_code string [1,50] 部门编号
level string [1,50] 员工分级(需先在企业后台开启该功能)
category string [] 员工分类,多个分类,用“,”分割(需先在企业后台开启该功能)
birth_day string [10] 生日,格式为yyyy-MM-dd,如:1991-01-01
entry_day string [10] 入职日,格式为yyyy-MM-dd,如:2016-02-03
card_type int [1] 证件类型,1-身份证,2-护照,3-香港居民身份证,4-澳门居民身份证,5-台湾身份证,6-台胞证,7-回乡证
card_no string [1,30] 证件号码
extattr string 第三方绑定,JsonArray,格式如:
List«ThirdUser»(需先绑定第三方平台)
allow_simple_pwd int [1] 是否设置简单密码:1.是;2.否。(需提前联系关爱通人员,开通企业设置简单密码的权限)
password string [6,20] 初始密码(字母数字),只有当allow_simple_pwd=1时,生效
employee_attribute string 扩展信息,JsonArray,格式如:
List«EmployeeAttribute»(需先确认扩展信息已启用的字段,合同性质、固定电话、级别、分类等默认已启用)
cost_center_id int [1,10] 成本中心id,取值范围1~2147483647之间的整数

(3)extattr中的ThirdUser对象,通过userid添加员工该字段无需传递

参数名称 是否必须 参数类型 长度限制 描述
thirdType string [1] 第三方类型,目前仅支持 1.企业微信 2.钉钉
userId string [1,100] 第三方中的userId

(4)employee_attribute中的EmployeeAttribute对象

参数名称 是否必须 参数类型 长度限制 描述
attributeCode string [1,100] 扩展字段编号,如:contractNature(合同性质)
taxpayerMapper(纳税人归属)
attributeValue string [1,100] 扩展字段值,如:contractNature对应:
正式员工,试用员工,临时员工,实习生,兼职员工,外聘员工
taxpayerMapper对应纳税人归属id
请求示例
POST /employee/add HTTP/1.1
Host: openapi.guanaitong.tech
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

access_token=1ba50b8f418a3ceeba989d7b789de149&birth_day=1991-02-20&card_no=371322199105204626&
card_type=1&corp_code=SN112&cost_center_id=1234&email=12345678@qq.com&entry_day=2016-10-01&dept_code=A001&level=S1&
timestamp=1492671463&send_invite=1&mobile_area=86&mobile=15588652444&sign=ada2316deb82816d61a7a40dfba3553a34a2e82e&
gender=1&remark=添加员工&name=zhangfei1
                    
返回参数说明
参数名称 描述
code 返回码。详见错误返回码
msg 如果错误,返回错误信息。
data 如果没有错误,返回业务数据。通过工号添加返回的是工号,通过userid添加返回userid。
正确返回示例
{
    "code": 0,
    "data": "SN112",
    "msg": "OK"
}
错误返回示例
{
    "code": 1000210001,
    "msg": "timestamp check failed!",
    "data": null
}