接口说明
- 接口用途:根据员工唯一标识,单条查询员工的精细化信息
基本信息
|
HTTP URL |
/river/Member/detail |
|---|---|
|
HTTP Method |
GET |
|
权限要求 |
|
请求头
|
参数名称 |
参数值 |
|---|---|
|
Content-Type |
application/x-www-form-urlencoded |
请求参数
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
client_id |
应用唯一标识 |
string |
Y |
滴滴开放平台创建应用时,由平台分配的唯一标识,用于识别调用方身份 |
|
access_token |
接口调用授权凭证 |
string |
Y |
授权认证后获取的访问令牌,用于校验接口调用权限;授权认证方式参见【接口认证-授权认证】 |
|
company_id |
租户唯一标识 |
string |
Y |
滴滴企业版租户唯一 ID,代表当前操作的企业主体 |
|
timestamp |
当前时间戳 |
int |
Y |
当前时间戳,精确到秒级 |
|
sign |
签名 |
string |
Y |
根据规则生成的接口签名,用于校验请求合法性与完整性;生成方式参见【接口认证-授权认证】 |
|
member_id |
员工滴滴侧ID |
bigint |
N |
员工在滴滴企业平台的ID |
|
employee_number |
员工工号 |
string |
N |
|
|
phone |
员工手机号 |
string |
N |
格式限制:1. 大陆手机号:可直接传输 11 位号码,或是按照海外手机号格式加区号2. 港澳台与海外手机号:按照 「区号 + 空格 + 号码」 格式传递。示例:+86 12345678910 |
请求示例
curl -X GET -H "Content-Type: application/x-www-form-urlencoded" https://api.es.xiaojukeji.com/river/Member/detail?client_id=client_id_test&access_token=141ea31466478eab2f1c1ddcca2675b989a16552×tamp=1566764837&company_id=12345678980&member_id=112345678980&sign=091cf244ad5ab16935cfe44fc698bc58
响应参数
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
errno |
错误编码 |
string |
数字 0 表示成功,非0 表示失败 |
|
errmsg |
错误信息 |
string |
errno=0时为常量"SUCCESS",errno!=0时为错误信息 |
|
data |
员工信息 |
object |
|
|
request_id |
接口调用唯一标识 |
string |
用于问题排查、日志追踪,每次调用返回唯一值 |
data数据格式
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
status |
员工状态 |
string |
枚举值数字: |
|
source |
员工加入滴滴企业平台的渠道 |
int |
枚举值数字: |
|
member_id |
员工滴滴侧ID |
bigint |
员工在滴滴企业平台的ID |
|
realname |
员工姓名 |
string |
|
|
phone |
员工手机号 |
string |
|
|
employee_number |
员工工号 |
string |
|
|
|
员工邮箱 |
string |
|
|
use_company_money |
企业支付状态 |
int |
设置是否为员工开启企业支付 |
|
regulation_id |
员工制度ID数组 |
array |
|
|
use_car_config |
用车规则ID数组 |
array |
|
|
is_remark |
用车备注信息 |
|
设置员工在发单前是否需要填写说明 |
|
system_role |
系统角色 |
int |
枚举值数字: |
|
role_ids |
角色 |
string |
员工所属角色的滴滴侧ID |
|
immediate_superior_phone |
直属上级手机号 |
string |
|
|
immediate_superior_eid |
直属上级员工编号 |
string |
|
|
budget_center_id |
主部门滴滴侧ID |
bigint |
员工归属的主部门,可用于拆账、审批等场景;可通过部门或项目查询接口获取,类型为1 |
|
con_department_ids |
兼岗部门滴滴侧ID |
array |
员工的兼岗部门 |
|
project_ids |
所属项目滴滴侧ID |
string |
|
|
legal_entity_id |
所属公司滴滴侧ID |
string |
|
|
out_legal_entity_id |
所属公司外部编号 |
string |
与滴滴管理后台维护的公司编号一致 |
|
rank_id |
职级滴滴侧ID |
string |
|
|
out_rank_id |
职级外部编号 |
string |
与滴滴管理后台维护的职级编号一致 |
|
residentsname |
常驻地名称 |
string |
支持地级市、区县维度 |
|
residents_list |
常驻地列表 |
[]object |
|
|
total_quota |
限额 |
string |
员工的个人限额,单位元 |
|
available_quota |
员工可用限额 |
string |
该字段为历史字段,建议使用limit_rule_list限额规则查询 |
|
limit_rule_list |
限额规则 |
[]object |
|
|
set_dismiss_time |
设置的员工离职日期 |
string |
为空时表示未设置离职日期,格式为 yyyy-MM-dd |
|
dismiss_time |
员工实际离职日期 |
string |
为空时表示未离职,格式为 格式:yyyy-MM-dd HH:mm:ss |
|
english_surname |
英文姓 |
string |
|
|
english_name |
英文名 |
string |
|
|
nickname |
昵称 |
string |
|
|
sex |
性别 |
int |
枚举值数字 |
|
birth_date |
出生日期 |
string |
用AES算法加密,原始格式为yyyy-MM-dd |
|
card_list |
证件信息 |
[]object |
参见 card_list |
|
cert_realname |
证件中文姓名 |
string |
证件上的真实中文姓名 |
|
cert_english_surname |
证件英文姓 |
string |
证件上的真实英文姓 |
|
cert_english_name |
证件英文名 |
string |
证件上的真实英文名 |
|
invoice_info |
备注信息 |
string |
该字段为历史字段,用于存储人员身上的自定义备注信息 |
card_list
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
card_type |
证件类型 |
int |
枚举值数字: |
|
card_no |
证件号码 |
string |
证件号码(已用AES算法加密) |
|
expire_date |
证件过期日期 |
string |
原始格式:2050-01-01(已用AES算法加密) |
residents_list
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
id |
常驻地ID |
int |
|
|
name |
常驻地名称 |
string |
|
|
adcode |
常驻地行政区划代码 |
string |
|
limit_rule_list
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
rule_name |
限额规则名称 |
string |
限额规则员工侧展示名称 |
|
budget_cycle |
预算周期 |
int |
枚举值数字: |
|
is_accumulative |
是否累计 |
int |
枚举值数字: |
|
total_quota |
限额 |
number |
单位元,精确到两位小数 |
|
available_quota |
剩余额度 |
number |
单位元,精确到两位小数 |
|
freeze_quota |
冻结金额 |
number |
单位元,精确到两位小数 |
响应示例
{
"data": {
"available_quota": "0.00",
"birth_date": "",
"budget_center_id": "1125915646135311",
"card_list": [],
"con_department_ids": [
"1125920823148798",
"1125928765383351"
],
"email": "",
"employee_number": "",
"english_name": "",
"english_surname": "",
"id": "1125922289295589",
"immediate_superior_phone": "",
"is_remark": "0",
"legal_entity_id": "",
"nickname": "",
"phone": "00016189857",
"rank_id": "",
"realname": "ZHOUZH",
"regulation_id": [
"1125920826148759"
],
"residents_list": [
{
"id": 14,
"name": "大连",
"adcode": "210200"
},
{
"id": 13,
"name": "青岛",
"adcode": "370200"
}
],
"role_ids": "1125915646090887_1125915646107623",
"set_dismiss_time": "",
"sex": 0,
"system_role": 2,
"total_quota": "0.00",
"use_car_config": [
"1125920826148759"
],
"use_company_money": 1,
"limit_rule_list": [
{
"rule_name": "员工个人限额(默认)",
"budget_cycle": 1,
"is_accumulative": 0,
"total_quota": 50000,
"limit_management_scope": 0,
"available_quota": 50000,
"freeze_quota": 0
}
]
},
"errmsg": "SUCCESS",
"errno": 0,
"request_id": "i+2SqRl3AcnS5Pi2KXWdxmg2e0lfei3pChBPvy/LuvjTkLo9LWXpUj4Jf2du2ZwE"
}
错误码
错误码对应的文案描述仅为场景化说明,会根据业务优化、场景补充、表述规范等需求进行不定期更新(如细化提示、优化措辞等),不建议将文案内容用于精准匹配逻辑,避免后续文案变更影响系统稳定性
|
错误码 |
错误信息 |
错误原因以及处理方案 |
|---|---|---|
|
10001 |
timestamp 过期 |
原因:请求携带的时间戳超出有效时效,接口拒绝处理 |
|
10002 |
IP 不在白名单中,本次请求 IP: |
原因:发起请求的服务器 IP 未配置在滴滴接口白名单内,接口做了 IP 访问限制 |
|
10003 |
参数错误 |
原因:请求传入的参数存在格式、值类型、必填项缺失等错误 |
|
10003 |
member_id、phone、employee_number、third_user_id 必传一个 |
原因:查询操作中未传入任何定位目标数据的参数,缺少核心必要参数 |
|
12001 |
client_id和access_token为必填项 |
原因:请求未传入 client_id 或 access_token,两个均为接口必填参数 |
|
12002 |
该托管关系不存在,无权操作 |
原因:当前请求的主体与滴滴侧的托管合作关系未建立 / 已失效,无对应操作权限 |
|
19999 |
签名失败 |
原因:请求的 sign 签名值生成规则错误、参数拼接错误或密钥不一致,签名校验未通过 |
|
400 |
非法的 client_id |
原因:传入的 client_id 无效、未注册或与接口分配的 client_id 不匹配 |
|
403 |
无权访问该接口 |
原因:当前 client_id 未获取该接口的访问权限,接口做了权限管控 |
|
408 |
参数错误,未正确传输 timestamp |
原因:timestamp 参数未传、传空或格式不符合接口要求(如非数字、位数错误) |
|
410 |
client_id 不一致 |
原因:请求中携带的 client_id 与签名、access_token 关联的 client_id 不匹配 |
|
412 |
client_id和access_token为必填项 |
原因:请求未传入 client_id 或 access_token,两个均为接口必填参数 |
|
415 |
不支持 http 协议 |
原因:使用了 HTTP 协议发起请求,接口仅支持 HTTPS 安全协议 |
|
50235 |
获取员工信息失败(公司已停用) |
原因:接口内部调用公司的服务失败 |
|
50235 |
员工详情获取失败 |
详见 msg 信息 |
其他参见:通用错误解决方案
版本记录
|
日期 |
更新人 |
更新内容 |
上线时间 |
|---|---|---|---|
|
2023.11.07 |
陈继诗 |
迁移文档 |
|
|
2024.01.26 |
陈继诗 |
增加source字段 |
2024.04.26 |
|
2023.11.07 |
陈继诗 |
增加employee_number请求字段,返回增加immediate_superior_eid |
2024.04.26 |
|
2025.02.13 |
高洋洋 |
返回新增con_department_ids兼岗部门 |
2025.02.13 |
|
2025.03.20 |
唐腾飞 |
返回新增out_legal_entity_id |
2025.03.26 |
|
2025.05.15 |
杨露佳 |
返回新增 residents_list |
2025.05.15 |
|
2025.11.17 |
谢朱莉 |
1.响应参数增加员工状态 |
2025.11.10 |
|
2026.1.21 |
谢朱莉 |
常驻地支持区县 |
2026.1.21 |
|
2026.02.09 |
郭相均、谢朱莉 |
限额接口升级 |
2026.02.09 |
|
2026.03.24 |
谢朱莉 |
新增常驻地行政区划代码 |
2026.03.24 |
|
2026.4.21 |
谢朱莉 |
更新文档字段描述 |
|