接口说明
- 接口用途:员工修改新增接口,用于单条员工数据修改。
- 频率限制:连续添加员工时,请求间隔必须≥200 毫秒。
- 如果需要批量新增/修改员工,请使用 员工批量处理接口 ,以提升效率并避免触发限流。
- **AES Key 生成规则:**AES Key 采用固定前缀拼接公司 ID 后进行 MD5 加密生成,公式:
MD5(sprintf("es_traveler_%s", companyId))即:es_traveler_+ 滴滴企业版租户唯一 ID,拼接后进行 MD5 加密,结果即为 AES Key。
基本信息
|
HTTP URL |
/river/Member/edit |
|---|---|
|
HTTP Method |
POST |
|
权限要求 |
|
请求头
|
参数名称 |
参数值 |
|---|---|
|
Content-Type |
application/json |
请求参数
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
client_id |
应用唯一标识 |
string |
Y |
滴滴开放平台创建应用时,由平台分配的唯一标识,用于识别调用方身份 |
|
access_token |
接口调用授权凭证 |
string |
Y |
授权认证后获取的访问令牌,用于校验接口调用权限;授权认证方式参见【接口认证-授权认证】 |
|
company_id |
租户唯一标识 |
string |
Y |
滴滴企业版租户唯一 ID,代表当前操作的企业主体 |
|
timestamp |
当前时间戳 |
int |
Y |
当前时间戳,精确到秒级 |
|
sign |
签名 |
string |
Y |
根据规则生成的接口签名,用于校验请求合法性与完整性;生成方式参见【接口认证-授权认证】 |
|
member_id |
员工滴滴侧ID |
bigint |
N |
员工新增接口的响应中返回,用于定位要修改的员工 |
|
employee_number |
员工工号 |
string |
N |
使用时,与member_id字段二者选一即可 |
|
has_card_info |
是否添加证件信息 |
int |
N |
使用商旅功能时,需要证件信息,可提前维护,或是预订时维护 |
|
data |
员工信息 |
string |
Y |
详见 data |
data
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
phone |
员工手机号 |
string |
N |
员工手机号支持修改,修改后,员工在滴滴侧的ID不会变化 |
|
realname |
员工姓名 |
string |
Y |
传空或者不传不做任何处理,保持原有值不变 |
|
employee_number |
员工工号 |
string |
N |
不传则不做任何处理,保持原有值不变 |
|
|
邮箱 |
string |
N |
不传则不做任何处理,保持原有值不变 |
|
use_company_money |
企业支付状态 |
int |
N |
不传则不做任何处理,保持原有值不变 |
|
regulation_id |
员工制度ID数组 |
|
|
传0,清空员工绑定的制度信息 |
|
is_remark |
用车备注信息 |
string |
N |
不传则不做任何处理,保持原有值不变 |
|
system_role |
系统角色 |
int |
N |
枚举值数字: |
|
role_ids |
角色 |
string |
N |
不传则不做任何处理,保持原有值不变 |
|
immediate_superior_phone |
直属上级手机号 |
string |
N |
传空或者不传不做任何处理,保持原有值不变 |
|
immediate_superior_email |
直属上级邮箱 |
string |
N |
|
|
immediate_superior_employee_number |
直属上级员工编号 |
string |
N |
|
|
immediate_superior_memberID |
直属上级滴滴侧ID |
int |
N |
|
|
clear_immediate_superior |
清空上级 |
int |
N |
传数字1代表清空上级 |
|
budget_center_id |
主部门滴滴侧ID |
bigint |
N |
传空或者不传不做任何处理,保持原有值不变 |
|
out_budget_id |
主部门编号 |
string |
N |
合作方侧自定义的唯一标识,需要与滴滴管理后台维护的部门编号一致 |
|
con_department_ids |
兼岗部门滴滴侧ID |
string |
N |
员工的兼岗部门 |
|
con_department_codes |
兼岗部门编号 |
string |
N |
合作方侧自定义的唯一标识,需要与滴滴管理后台维护的部门编号一致 |
|
project_ids |
所属项目滴滴侧ID |
string |
N |
不传不做任何处理,保持原有值不变 |
|
project_codes_detail |
所属项目信息 |
string |
N |
数量限制:≤ 500 |
|
legal_entity_id |
所属公司滴滴侧ID |
string |
N |
传空或者不传不做任何处理,保持原有值不变 |
|
out_legal_entity_id |
所属公司外部编号 |
string |
N |
传空或者不传不做任何处理,保持原有值不变 |
|
rank_id |
职级滴滴侧ID |
string |
N |
传空或者不传不做任何处理,保持原有值不变 |
|
out_rank_id |
职级外部编号 |
string |
N |
前置要求:需为滴滴侧已创建的职级,需要与滴滴管理后台维护的职级编号一致 |
|
residentsname |
常驻地名称 |
string |
N |
不传则不做任何处理,保持原有值不变 |
|
residents_ids |
常驻地滴滴侧ID |
string |
N |
不传则不做任何处理,保持原有值不变 |
|
residents_adcode |
常驻地行政区划代码 |
string |
N |
常驻地的唯一标识,滴滴侧ID与行政区划代码二者选一必填。 |
|
total_quota |
限额 |
string |
N |
不传则不做任何处理,保持原有值不变 |
|
set_dismiss_time |
设置的员工离职日期 |
string |
N |
不传则不做任何处理,保持原有值不变 |
|
english_surname |
英文姓 |
string |
N |
不传不做任何处理,保持原有值不变 |
|
english_name |
英文名 |
string |
N |
不传不做任何处理,保持原有值不变 |
|
nickname |
昵称 |
string |
N |
不传不做任何处理,保持原有值不变 |
|
sex |
性别 |
int |
N |
不传不做任何处理,保持原有值不变 |
|
birth_date |
出生日期 |
string |
N |
仅限开通商旅的企业使用,格式为 yyyy-MM-dd |
|
card_list |
证件信息 |
[]object |
N |
仅限开通商旅的企业使用 |
|
cert_realname |
证件中文姓名 |
string |
N |
仅限开通商旅的企业使用 |
|
cert_english_surname |
证件英文姓 |
string |
N |
仅限开通商旅的企业使用 |
|
cert_english_name |
证件英文名 |
string |
N |
仅限开通商旅的企业使用 |
证件信息
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
card_type |
证件类型 |
int |
枚举值数字: |
|
card_no |
证件号码 |
string |
加密传输规则: |
|
expire_date |
证件过期日期 |
string |
格式为 yyyy-MM-dd |
请求示例
curl --location 'https://api.es.xiaojukeji.com/river/Member/edit' \
--header 'Content-Type: application/json' \
--data '{
"access_token": "1dd12f470485ba78b2c24fab3736e30c3c5ee9cc",
"client_id": "87fca1dc60c9de0a96c20fccf2ccaa40_test",
"client_secret": "481a0cd23c6d90dff1993982dc151601",
"company_id": "1125915646167936",
"data": "{\"role_ids\":\"\", \"employee_number\":\"123\",\"is_remark\":1,\"rank_id\":\"197213t912y3\"}",
"member_id": 1125921312180375,
"sign": "2e857c91066de9626a4fd5a039b45e46",
"timestamp": 1690277479
}'
响应参数
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
errno |
错误编码 |
string |
数字 0 表示成功,非0 表示失败 |
|
errmsg |
错误信息 |
string |
errno=0时为常量"SUCCESS",errno!=0时为错误信息 |
data数据格式
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
member_id |
员工滴滴侧ID |
int64 |
员工信息更新失败(请检查员工是否已离职或被删除)场景返回 |
|
phone |
员工手机号 |
string |
员工信息更新失败(请检查员工是否已离职或被删除)场景返回 |
|
status |
员工状态 |
int |
仅员工信息更新失败(请检查员工是否已离职或被删除)场景返回 |
响应示例
正常示例
{
"errno": 0,
"errmsg": "SUCCESS",
"data": null,
"request_id": "rrm1X4Eh8SFDOUKNSaITOIOvnuWH8CbjDB7lTnfa7udVJM0rFYQKmu8IGQ82WSTL"
}
异常示例
{
"errno": 50223,
"errmsg": "员工信息更新失败(请检查员工是否已离职或被删除)",
"data": {
"member_id": "1125949321799415",
"phone": "00016259467",
"status": 4
},
"request_id": "rrm1X4Eh8SERQXqOaA0BAERnBtzjt7smdWLiifNWlm/WcJxzKWrhxLkfHDd+m1es"
}
错误码
错误码对应的文案描述仅为场景化说明,会根据业务优化、场景补充、表述规范等需求进行不定期更新(如细化提示、优化措辞等),不建议将文案内容用于精准匹配逻辑,避免后续文案变更影响系统稳定性
|
错误码 |
错误码文案 |
错误原因以及处理方案 |
|---|---|---|
|
10001 |
timestamp 过期 |
原因:请求携带的时间戳超出接口有效时效,服务器拒绝处理添加员工请求;处理:生成当前最新的 timestamp 重新发起请求,确保与滴滴服务器时间误差在有效范围内 |
|
10002 |
IP 不在白名单中,本次请求 IP: |
原因:发起请求的服务器 IP 未配置在滴滴接口白名单内,接口做了 IP 访问限制;处理:在开放平台管理后台,将本次请求的实际 IP 添加至接口白名单后再请求 |
|
10003 |
member_id、employee_number、third_user_id 不能同时为空 |
原因:现有参数无法匹配到待修改的员工 |
|
10003 |
参数错误 |
原因:添加员工请求中存在未明确的参数格式、值类型、非空性等基础错误,不符合接口规范 |
|
10018 |
网络异常,请重新请求 |
原因:发起员工修改请求时出现网络连接异常,接口未正常接收请求 |
|
12001 |
参数错误 (未正确传输 company_id) |
原因:核心参数 company_id 未传、传空或格式不符合接口要求 |
|
12002 |
该托管关系不存在,无权操作 |
原因:当前请求的主体与滴滴侧的托管合作关系未建立 / 已失效,无对应操作权限 |
|
12003 |
该企业已删除,无权操作 |
原因:待修改员工所属企业已被删除,无员工修改操作权限 |
|
19998 |
系统异常 (未获取到请求参数)/ 系统异常 |
原因:滴滴侧系统内部未成功解析并获取到新增请求的参数,属于系统异常 |
|
19999 |
签名失败 |
原因:请求的 sign 签名值生成规则错误、参数拼接错误或密钥不一致,签名校验未通过 |
|
400 |
非法的 client_id |
原因:传入的 client_id 无效、未注册或与接口分配的 client_id 不匹配 |
|
410 |
client_id 不一致 |
原因:请求中携带的 client_id 与签名、access_token 关联的 client_id 不匹配 |
|
412 |
client_id 和 access_token 为必填项 |
原因:请求未传入 client_id 或 access_token,两个均为接口必填参数 |
|
415 |
不支持 http 协议 |
原因:使用 HTTP 协议发起员工修改请求,接口仅支持 HTTPS 安全协议 |
|
50221 |
该员工信息不存在 |
原因: |
|
50222 |
员工与指定的企业不匹配 |
原因:员工已被删除,或员工 id 与 company_id 未归属同一企业,归属关系不匹配 |
|
50223 |
员工信息更新失败(请检查员工是否已离职或被删除) |
原因:员工不存在、非正常状态(离职 / 删除) |
|
50223 |
员工信息更新失败(离职时间需晚于今天,请重设) |
原因:离职时间传入已过去的时间 |
|
50223 |
员工信息更新失败(已完成实名认证,初始超管不能修改姓名) |
原因:已完成实名认证的企业初始超管,不支持修改姓名 |
|
50223 |
员工信息更新失败(请求间隔不能小于 200 毫秒,请稍后重试) |
原因:连续发起添加员工请求的时间间隔小于 200 毫秒,违反接口限流规则 |
|
50224 |
员工存在未支付的订单,请先联系其支付 |
原因:员工修改前手机号下存在未支付订单,不符合修改条件 |
|
50253 |
资源不存在错误 |
原因:修改员工时依赖的员工相关资源在滴滴侧系统不存在 |
|
50402 |
部门 / 项目不存在 |
原因:关联的部门或项目在滴滴侧系统无匹配数据 |
其他参见:通用错误解决方案
版本记录
|
日期 |
更新人 |
更新内容 |
上线时间 |
|---|---|---|---|
|
2023.11.07 |
陈继诗 |
迁移文档 |
|
|
2023.11.10 |
陈继诗 |
请求增加employee_number字段,data增加immediate_superior_employee_number字段,out_budget_id,project_codes_detail json串 |
2024.01.04 |
|
2024.02.21 |
陈继诗 |
去掉dismiss_time字段 |
2024.02.21 |
|
2024.08.10 |
陈继诗 |
新加字段 clear_immediate_superior |
2024.08.10 |
|
2025.02.13 |
高洋洋 |
新增con_department_ids、out_con_department_ids兼岗字段 |
2025.02.13 |
|
2025.02.13 |
高洋洋 |
去除out_con_department_ids、修改为con_department_codes兼岗字段 |
2025.02.18 |
|
2025.03.20 |
唐腾飞 |
返回新增out_legal_entity_id |
2025.03.26 |
|
2025.03.24 |
高洋洋 |
增加证件、出生日期字段加密逻辑说明 |
2025.03.31 |
|
2025.05.15 |
杨露佳 |
返回新增residents_ids |
2025.05.15 |
|
2025.05.26 |
高洋洋 |
入参数增加project_ids、project_codes_detail的元素上限说明 |
2025.05.27 |
|
2025.07.14 |
杨露佳 |
增加card_list描述 不传或传[]不更新 |
2025.07.14 |
|
2025.11.17 |
谢朱莉 |
1.员工已存在情况下,响应参数增加员工状态;调整示例 |
2025.11.10 |
|
2026.1.21 |
谢朱莉 |
常驻地支持区县 |
2026.1.21 |
|
2026.4.10 |
谢朱莉 |
更新文档字段描述 |
|