滴滴企业版

接口说明

说明

接口用途：批量查询企业下符合条件的员工信息列表。
注意：如果需查询项目信息，需使用员工明细接口。

注意

员工工号、手机号是精确查询；员工姓名为模糊查询。
如果传了 last_id，除了 status，其他检索条件会失效，首次查询时需传0。
当 status 为空或者没传，返回的为正常、离职和未绑定手机号的员工。

基本信息

HTTP URL	/river/Member/get
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	根据规则生成的接口签名，用于校验请求合法性与完整性；生成方式参见【接口认证-授权认证】
phone	员工手机号	string	N	格式限制：1. 大陆手机号：可直接传输 11 位号码，或是按照海外手机号格式加区号2. 港澳台与海外手机号：按照「区号 + 空格 + 号码」格式传递。示例：+86 12345678910 精确查询
employee_number	员工工号	string	N	精确查询
email	员工邮箱	string	N
realname	员工姓名	string	N	模糊查询
status	员工状态	string	N	枚举值数字： 1：正常 4：离职 6：未绑定手机号查询多种状态时以英文逗号分隔，示例：1,4 为空或者没传，返回的为正常、离职和未绑定手机号的员工
offset	数据开始位置	int	Y	数据分页起始位置，从 0 开始计数，后续查询需为 length 的倍数
length	数据条数（最大100条）	int	Y	每页返回数据条数，最大值为 100
last_id	数据标志位	string	N	如果贵企业员工数量较多（例如10w+），查询时offset较大，需使用last_id查询。例如，传"1125902545811111"，会从这个last_id的下一条数据开始查询。首次查询时需传0 如果传了 last_id，除了 status，其他检索条件会失效

集团账户使用说明

如果采用集团账户方案，并且配置了由【上级公司统一对接】（具体配置请咨询滴滴侧对接人），对接路径、请求参数有如下变化：

HTTP URL：/open-apis/v2/member/get

新增参数：

字段名	字段名称	类型	是否必填	备注
belong_enterprise_name	归属企业名称	string	N	company_id传集团公司ID时，可通过该字段确定处理哪个子公司的数据 company_id传子公司ID时，该字段可以不传该字段与taxpayer_no任选一个传值该字段需要与企业开户时认证名称一致
taxpayer_no	纳税人识别号	string	N	company_id传集团公司ID时，可通过该字段确定处理哪个子公司的数据 company_id传子公司ID时，该字段可以不传该字段与belong_enterprise_name任选一个传值需要与集团公司的公司档案里的纳税人识别号一致
query_sub_company	是否查询下级公司数据	boolean	N	true：查询当前公司以及下级公司数据 false：仅查询当前公司数据（默认值）
next_token	下一页的token	string	N	首次查询不需要传，首次后的每一次查询需要从上一次查询的响应（data.next_token)中获取拿到该值

请求示例

curl -X GET -H "Content-Type: application/x-www-form-urlencoded" https://api.es.xiaojukeji.com/river/Member/get?client_id=client_id_test&access_token=141ea31466478eab2f1c1ddcca2675b989a16552&timestamp=1566764837&company_id=12345678980&offset=0&length=10&sign=091cf244ad5ab16935cfe44fc698bc58

响应参数

字段名	字段说明	字段类型	备注
errno	错误编码	string	数字 0 表示成功，非0 表示失败
errmsg	错误信息	string	errno=0时为常量"SUCCESS"，errno!=0时为错误信息
data	员工列表信息	object
request_id	接口调用唯一标识	string	用于问题排查、日志追踪，每次调用返回唯一值

data数据格式

字段名	字段说明	字段类型	备注
total	此次查询符合条件的员工总数	int
records	员工集合	array

records数组元素格式

字段名	字段说明	字段类型	备注
status	员工状态	string	枚举值数字： 1：正常 4：离职 6：未绑定手机号
source	员工加入滴滴企业平台的渠道	int	枚举值数字： 0：未知 1：PC逐一添加 2：PC批量导入 3：邮件邀请 4：API添加
id	员工滴滴侧ID	bigint	员工在滴滴企业平台的ID
realname	员工姓名	string
phone	员工手机号	string
employee_number	员工工号	string
email	员工邮箱	string
use_company_money	企业支付状态	int	设置是否为员工开启企业支付枚举值数字： 0：否（默认值） 1：是，即员工预订符合管控规则，可由企业直接支付
regulation_id	员工制度ID数组	array	通过制度列表、制度详情接口查询制度详情
use_car_config	用车规则ID数组	array
is_remark	用车备注信息		设置员工在发单前是否需要填写说明枚举值数字： 0：无需填写 1：需填写 2：按制度填写
system_role	系统角色	int	枚举值数字： 1：员工 2：超级管理员
role_ids	角色	string	员工所属角色的滴滴侧ID 可以通过角色查询API获取对应的信息
immediate_superior_phone	直属上级手机号	string
immediate_superior_eid	直属上级员工编号	string
budget_center_id	主部门滴滴侧ID	bigint	员工归属的主部门，可用于拆账、审批等场景；可通过部门或项目查询接口获取，类型为1
con_department_ids	兼岗部门滴滴侧ID	array	员工的兼岗部门
legal_entity_id	所属公司滴滴侧ID	string
out_legal_entity_id	所属公司外部编号	string	与滴滴管理后台维护的公司编号一致
rank_id	职级滴滴侧ID	string
out_rank_id	职级外部编号	string	与滴滴管理后台维护的职级编号一致
residentsname	常驻地名称	string	支持地级市、区县维度如果传区县，格式为城市-区县。
residents_list	常驻地列表	[]object	参见residents_list
total_quota	限额	string	员工的个人限额，单位元该字段所对应的周期为【员工限额管理】中【员工个人限额（默认）】规则的周期
available_quota	员工可用限额	string	该字段为历史字段，建议使用limit_rule_list限额规则查询单位元，精确到小数点后两位
limit_rule_list	限额规则	[]object	参见limit_rule_list
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	枚举值数字 0：未知 1：男 2：女
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	该字段为历史字段，用于存储人员身上的自定义备注信息
home_address	家庭住址	[]object	家庭住址信息，用于用车管控

card_list

字段名	字段说明	字段类型	备注
card_type	证件类型	int	枚举值数字： 1：身份证 2：护照 3：港澳台居民居住证 4：台胞证 5：军官证 6：回乡证 7：外国人永久居留身份证
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	枚举值数字： 0：不限额 1：自然月 2：自然季度 3：自然年 4：一次性 5：自然日 6：自定义 7：使用原部门的周期
is_accumulative	是否累计	int	枚举值数字： 0：不可累计 1：可累计
total_quota	限额	number	单位元，精确到两位小数 0 表示不限额度
available_quota	剩余额度	number	单位元，精确到两位小数
freeze_quota	冻结金额	number	单位元，精确到两位小数

home_address

字段名	字段说明	字段类型	备注/规则
city	城市名称	string	家庭住址所属城市名称
city_id	滴滴城市ID	int32
city_adcode	国内城市行政区划代码	string
address_name	家庭住址详细名称	string	为地址的展示名称，而非具体的门牌号

说明

如果采用集团账户方案，并且配置了由【上级公司统一对接】（具体配置请咨询滴滴侧对接人），响应参数有如下变化：

字段名	字段说明	字段类型	备注
next_token	下一页的token	string	下一次请求需要的next_token为空字符串或空指针（null）说明没有下一页

响应示例

{
    "data": {
        "records": [
            {
                "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",
                    "1125920865383421"
                ],
                "residents_list": [
                    {
                        "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
                    }
                ]
            }
        ],
        "total": 78
    },
    "errmsg": "SUCCESS",
    "errno": 0,
    "request_id": "i+2SqRl3AcnS5Pi2KXWdxmg2e0lfei3pChBPvy/LuvjTkLo9LWXpUj4Jf2du2ZwE"
}

错误码

注意

错误码对应的文案描述仅为场景化说明，会根据业务优化、场景补充、表述规范等需求进行不定期更新（如细化提示、优化措辞等），不建议将文案内容用于精准匹配逻辑，避免后续文案变更影响系统稳定性

错误码	错误信息	错误原因以及处理方案
10001	timestamp 过期	原因：请求携带的时间戳超出有效时效，接口拒绝处理处理：生成当前最新的 timestamp重新发起请求，确保时间戳与服务器时间误差在有效范围内
10002	IP 不在白名单中，本次请求 IP：	原因：发起请求的服务器 IP 未配置在滴滴接口白名单内，接口做了 IP 访问限制处理：在开放平台管理后台，将本次请求的实际 IP 添加至接口白名单后再请求
10003	参数错误	原因：请求传入的参数存在格式、值类型、必填项缺失等错误处理：核对接口文档的参数规范，检查所有传参的格式、类型、非空要求，修正后重新请求
10003	offset或length不合法	原因：offset 参数不是 length 的倍数，数值不符合接口分页规则处理：调整 offset 数值，确保 offset 是 length 的整数倍后重新请求
12001	client_id和access_token为必填项	原因：请求未传入 client_id 或 access_token，两个均为接口必填参数处理：补充传入有效且匹配的 client_id 和 access_token后重新请求
12002	该托管关系不存在，无权操作	原因：当前请求的主体与滴滴侧的托管合作关系未建立 / 已失效，无对应操作权限处理：核实并确认托管关系的有效性后再操作
19999	签名失败	原因：请求的 sign 签名值生成规则错误、参数拼接错误或密钥不一致，签名校验未通过处理：严格按照接口文档的签名生成规则重新计算 sign，核对密钥、参数拼接顺序是否正确
400	非法的 client_id	原因：传入的 client_id 无效、未注册或与接口分配的 client_id 不匹配处理：核对开放平台管理后台的有效 client_id，替换为正确值后重新请求
403	无权访问该接口	原因：当前 client_id 未获取该接口的访问权限，接口做了权限管控处理：联系滴滴侧对接人，为该 client_id 开通当前接口的访问权限
408	参数错误，未正确传输 timestamp	原因：timestamp 参数未传、传空或格式不符合接口要求（如非数字、位数错误）处理：按文档规范正确传值 timestamp（非空、匹配格式），建议生成当前最新时间戳
410	client_id 不一致	原因：请求中携带的 client_id 与签名、access_token 关联的 client_id 不匹配处理：确保请求的 client_id、签名生成、access_token 使用的是同一个有效 client_id
412	client_id和access_token为必填项	原因：请求未传入 client_id 或 access_token，两个均为接口必填参数处理：补充传入有效且匹配的 client_id 和 access_token后重新请求
415	不支持 http 协议	原因：使用了 HTTP 协议发起请求，接口仅支持 HTTPS 安全协议处理：将请求协议替换为HTTPS，确保请求地址以 https:// 开头
50235	获取员工信息失败(公司已停用)	原因：接口内部调用公司的服务失败处理：① 先检查租户状态；② 若参数无误，稍作等待后重试，仍失败则联系滴滴侧对接人排查服务问题

其他参见：通用错误解决方案

版本记录

日期	更新内容	上线时间
2023.11.07	迁移文档
2024.01.26	增加source字段
2024.02.19	返回增加immediate_superior_eid	2024.04.26
2025.02.13	返回新增兼岗部门ID	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.响应参数增加员工状态 2.增加证件姓名相关字段	2025.11.10
2026.1.21	常驻地支持区县	2026.1.21
2026.02.09	限额接口升级	2026.02.09
2026.03.24	新增常驻地行政区划代码	2026.03.24
2026.4.21	更新文档字段描述
2026.06.30	新增员工家庭住址