新增

优质

小牛编辑

128浏览

2023-12-01

请求地址

https://api.es.xiaojukeji.com/river/Member/single

返回数据格式

JSON

请求方式

POST

是否需要登录

是关于登录授权，参见如何登录授权

访问授权限制

暂无

请求参数

名称	类型	必选	描述
client_id	string	yes	申请应用时分配的AppKey
access_token	string	yes	授权后的access token
timestamp	int	yes	当前时间戳，精确到秒级
company_id	bigint	yes	企业ID
data	string	yes	员工数据json格式
sign	string(32)	yes	签名

员工信息（data对应数组中每条记录中字段）

名称	类型	必选	描述
phone	string	yes	员工手机号
realname	string	yes	员工姓名(最多50个字符)
employee_number	string	no	员工ID（员工在公司的员工号）(最多32个字符)
email	string	no	邮箱
department	string	no	部门名称（老），后续此参数会去掉
branch_name	string	no	所在分公司名称（老），后续此参数会去掉
system_role	int	no	系统角色(0-车辆预定人员，1-普通管理员，2-超级管理员；默认为0)
role_ids	string	no	角色（默认为员工），通过角色获取API 。可以填多个，以_分隔。初始管理员、主管不支持新增
immediate_superior_phone	string	no	员工直属上级的手机号码（需为本企业中已存在账号），直属上级可在审批流中担任审批人
residentsname	string	no	常驻地中文,可通过城市查询接口获得地级市名称
use_company_money	int	no	是否企业支付余额（0-否，1-是，默认为0）
total_quota	string	no	每月配额(单位：元，可为小数)
is_remark	int	no	叫车时备注信息是否必填(0-选填，1-必填，2-按制度填写；默认为0)
budget_center_id	bigint	no	所在部门ID（新），默认为1（企业）。通过成本中心查询api获取id（类型为1）
regulation_id	string	no	用车制度ID（从 9.1用车制度查询中选取，可以填多个，以_分隔，如 123_456_789）注:如不传用车制度ID,无法使用企业支付
project_ids	string	no	所在项目ID（新）。可以填多个，以_分隔。通过成本中心查询api获取id（类型为2）
invoice_info	string	no	开票主体信息，必须为json串，且需包含taxpayer_subject(纳税人主体)

注意事项

1、参数data为json字符串格式(传参时，data中的中文字符必须进行unicode编码，data外的参数不需要unicode编码，后面有具体示例)，如：

{"phone":"18611869995","realname":"\u5f20\u4e09","employee_number":"","email":"dys@didichuxing.com","department":"QA","branch_name":"TEST","system_role":0,"use_company_money":1,"total_quota":10000,"is_remark":0,"regulation_id":"5489198484344538189_5489709520894035023"}

2、常驻地目前只支持如“北京”、“北京市”、“北京市海淀区”格式，不支持“海淀区”此类格式，如果传参中带了区县则必须把“市”、“区“、”县”字段都带上。

请求参数

client_id = "client_id_test", "access_token" = "access_token_test", timestamp = "1565875844", company_id = "12345678980"
data原始值：phone = 11000001234, realname = "张三", employee_number = "D123456", email = "1234@test.com"
data转换为json串后为(注意中文字)：{"phone":11000001234,"realname":"\u5f20\u4e09","employee_number":"D123456","email":"1234@test.com"}
sign_key = "sign_key_test"

计算签名

加密前的字符串：access_token=access_token_test&client_id=client_id_test&company_id=12345678980&data={"phone":11000001234,"realname":"\u5f20\u4e09","employee_number":"D123456","email":"1234@test.com"}&sign_key=sign_key_test&timestamp=1565875844
计算得到的签名：sign = md5("access_token=access_token_test&client_id=client_id_test&company_id=12345678980&data={"phone":11000001234,"realname":"\u5f20\u4e09","employee_number":"D123456","email":"1234@test.com"}&sign_key=sign_key_test&timestamp=1565875844") = 7473eb9bff6e1aa352dd2e433ed1924a

请求示例

curl -X POST -H "content-type:application/json" \
-d '{"client_id":"client_id_test","access_token":"access_token_test","timestamp":"1565875844","company_id":"12345678980","data":"{\"phone\":\"11000001234\",\"realname\":\"\u5f20\u4e09\",\"employee_number\":\"D123456\",\"email\":\"1234@test.com\"}","sign":"7473eb9bff6e1aa352dd2e433ed1924a"}' \
https://api.es.xiaojukeji.com/river/Member/single

返回参数说明

返回值字段	字段类型	字段说明
errno	int	0表示成功，非0表示失败
errmsg	string	errno=0时为常量"SUCCESS"，errno!=0时为错误信息
data	object	返回值对象
data.id	bigint	员工在滴滴企业平台的ID
data.phone	string	员工手机号

返回示例

{
    "errno": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 1125904406565093,
        "phone": "19811110001"
    }
}

接口错误解决方案

通用错误解决文档

4xx 错误
1xxx 错误

50202(添加员工失败(xxxxxx))

xxxxxx有以下可能：
请求间隔不能小于150毫秒,请稍后重试
公司已停
管理员已注销
只有超管和初始超管才能添加员工
一次只能添加一名员工
http://api.es.xiaojukeji.com/river/Member/single 该接口每次只能添加一个员工
员工已存在
员工手机号、邮箱、员工工号必须唯一。同时返回该员工对应的滴滴id、手机号
员工处于待确认状态,请联系员工自行确认加入
员工已在A企业，现在B企业去添加该员工，此时B企业添加失败，员工进入B企业的待确认列表中，会在企业APP上的卡片提示员工，是否加入B企业; 员工确认链接会通过data.url返回，可以让员工点击链接进行操作
员工存在于其他公司,已经通知该员工加入企业,请联系员工自行确认加入与7的区别是，提示这个错误时，会给员工发送短信提示是否加入新企业
员工确认链接会通过data.url返回，可以让员工点击链接进行操作
员工已存在于其他企业,请联系员工退出企业
员工确认链接会通过data.url返回，可以让员工点击链接进行操作
部门不存在
调用成本中心查询接口,参数中的type=1获取所有部门的信息,返回值中的id(即部门id)就是员工添加接口的budget_center_id
项目不存在
调用成本中心查询接口,参数中的type=2获取所有部门的信息,返回值中的id(即部门id)就是员工添加接口的project_ids
制度不存在
调用用车制度列表接口,返回值中的regulation_id就是员工添加接口的regulation_id

50242(添加员工失败(您最多可以导入X员工,如需导入更多员工,请购买更多的许可))

这是由于贵企业购买了按许可数的高级费控版本，一旦已导入的员工数量达到了X，则不能再添加，除非购买更多的许可数(操作方式：登录滴滴企业ES后台——>企业设置——>增值服务)