接口说明
- 接口用途:用于删除已维护的员工信息。
- 删除操作不可逆,删除后,后续若添加信息一致的员工,会作为新账号处理,原历史信息无法恢复。请确认业务需求后再执行,避免误操作。
- 删除数量上限:单次请求最多删除100个员工。
- 当前租户的初始管理员不能删除。如需删除,请将管理员权限转让给其他人,然后再删除。
- 员工如果有未结束、或未支付的订单无法通过接口删除。此时将会把员工设为离职,离职员工不能继续企业支付。
- 已离职、处于待确认状态(未加入企业)的员工无法通过接口删除。
基本信息
|
HTTP URL |
/river/Member/del |
|---|---|
|
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 |
string |
N |
员工新增/查询接口的响应中返回,用于定位要删除的员工 |
|
employee_number |
员工工号 |
string |
N |
员工工号,需要与滴滴管理后台的员工工号一致 |
|
employee_phone |
员工手机号 |
string |
N |
员工手机号,需要与滴滴管理后台的手机号一致 |
|
employee_email |
员工邮箱 |
string |
N |
员工邮箱,需要与滴滴管理后台的邮箱一致 |
请求示例
按member_id删除
curl -X POST -H "content-type:application/json" \
-d '{
"client_id":"client_id_test",
"access_token":"access_token_test",
"timestamp":1565875844,
"company_id":"12345678980",
"member_id":"4595547807125341222_4596091316915930212",
"sign":"7473eb9bff6e1aa352dd2e433ed1924a"
}' \
https://api.es.xiaojukeji.com/river/Member/del
按手机号删除
curl -X POST -H "content-type:application/json" \
-d '{
"client_id":"client_id_test",
"access_token":"access_token_test",
"timestamp":1565875844,
"company_id":"12345678980",
"employee_phone":"[\"18012345678\",\"+86 00012014076\"]",
"sign":"7473eb9bff6e1aa352dd2e433ed1924a"
}' \
https://api.es.xiaojukeji.com/river/Member/del
按工号删除
curl -X POST -H "content-type:application/json" \
-d '{
"client_id":"client_id_test",
"access_token":"access_token_test",
"timestamp":1565875844,
"company_id":"12345678980",
"employee_number":"[\"D1001\", \"D1002\", \"D1003\"]",
"sign":"7473eb9bff6e1aa352dd2e433ed1924a"
}' \
https://api.es.xiaojukeji.com/river/Member/del
响应参数
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
errno |
错误编码 |
string |
数字 0 表示成功,非0 表示失败 |
|
errmsg |
错误信息 |
string |
errno=0时为常量"SUCCESS",errno!=0时为错误信息 |
|
data |
返回值对象 |
object |
成功删除的员工标识列表 |
|
request_id |
接口调用唯一标识 |
string |
用于问题排查、日志追踪,每次调用返回唯一值 |
响应示例
全部删除成功
{
"errno":0,
"errmsg":"success",
"data":[
2992137043884639000,
2992137043884639000,
2992137043884639000
]
}
部分删除成功
{
"errno":0,
"errmsg":"以下员工有未结束或未支付订单:2992137043884639250_2992137043884639251_2992137043884639252",
"data":[
2992137043884639000,//成功的数据
2992137043884639000,
2992137043884639000
]
}
使用手机号作为主键,部分删除成功
{
"errno": 0,
"errmsg": "以下员工删除失败:我们已将00012014076设为离职,离职员工不能继续企业支付用车, 原因:有1笔用车订单未完结,不能删除(+86 00012014076)",
"data": [
"18012345678"//成功的数据
],
"request_id": "+xvHWIzBGl3h+v3n4ZG7gxrQYgQg+7rQwsZNk06\/oPFPTiaKdPRtB6tJtD2PlcXR"
}
错误码
错误码对应的文案描述仅为场景化说明,会根据业务优化、场景补充、表述规范等需求进行不定期更新(如细化提示、优化措辞等),不建议将文案内容用于精准匹配逻辑,避免后续文案变更影响系统稳定性
|
错误码 |
错误码文案 |
错误原因以及处理方案 |
|---|---|---|
|
10001 |
timestamp 过期 |
原因:请求携带的时间戳超出有效时效,接口拒绝处理 |
|
10002 |
IP 不在白名单中,本次请求 IP: |
原因:发起请求的服务器 IP 未配置在滴滴接口白名单内,接口做了 IP 访问限制 |
|
10003 |
member_id 和 employee_number 和 third_user_id 和 employee_email 和 employee_phone 不能同时为空 |
原因:删除操作中未传入任何定位目标数据的参数,缺少核心必要参数 |
|
10003 |
employee_phone 的长度需大于 0 小于 100 |
原因:单次请求最少删除1人,最多删除100人 |
|
10003 |
employee_number 的长度需大于 0 小于 100 |
原因:单次请求最少删除1人,最多删除100人 |
|
10003 |
employee_email 的长度需大于 0 小于 100 |
原因:单次请求最少删除1人,最多删除100人 |
|
10003 |
参数错误 |
原因:请求传入的参数存在格式、值类型、必填项缺失等错误 |
|
10003 |
删除待确认员工失败 |
原因:无法删除待确认的员工 |
|
19999 |
签名失败 |
原因:请求的 sign 签名值生成规则错误、参数拼接错误或密钥不一致,签名校验未通过 |
|
400 |
非法的 client_id |
原因:传入的 client_id 无效、未注册或与接口分配的 client_id 不匹配 |
|
403 |
无权访问该接口 |
原因:当前 client_id 未获取该接口的访问权限,接口做了权限管控 |
|
412 |
client_id 和 access_token 为必填项 |
原因:请求未传入 client_id 或 access_token,两个均为接口必填参数 |
|
415 |
不支持 http 协议 |
原因:使用了 HTTP 协议发起请求,接口仅支持 HTTPS 安全协议 |
|
50231 |
系统异常或该员工原来已是删除状态 |
原因:(1)系统异常:网络波动、接口超时、数据库异常、权限校验失败、数据状态同步错误等,导致操作无法正常执行。(2)当前操作的员工此前已执行过删除 |
其他信息参见:通用错误解决方案
版本记录
|
日期 |
更新人 |
更新内容 |
上线时间 |
|---|---|---|---|
|
2023.11.07 |
陈继诗 |
迁移文档 |
|
|
2023.11.10 |
陈继诗 |
请求增加employee_number字段 |
2024.01.04 |
|
2025.06.18 |
杨露佳 |
请求增加employee_phone,employee_email |
2025.06.18 |
|
2026.4.21 |
谢朱莉 |
更新文档字段描述 |
|