最近更新时间:

接口说明

注意
  • 常驻地目前只支持如“北京”、“北京市”、“北京-海淀区”格式,不支持“海淀区”此类格式,如果传参中带了区县则必须把上级城市带上。
  • 人员唯一值可以在手机号,员工编号,邮箱中指定一个
  • 新建时,人员上级也传自己时,新建会成功,但是上级关系不会维护。
  • 所有字段不传不处理,传空字符串按清空。手机号不支持清空,(传空不会清空)。
  • 批量接口支持新建和修改,不支持员工删除。
说明
  • AES key 生成方式

    MD5(sprintf(“es_traveler_%s“,companyId))

    es_traveler_ + 参数中公司ID的值;然后再进行 MD5 得到 aes 的 key



基本信息

HTTP URL

/open-apis/v1/member/batchAddUpdate

HTTP Method

POST

权限要求


请求头

参数名称

参数值

Content-Type

application/json

请求参数

字段名

字段说明

字段类型

必填

备注

client_id

申请应用时分配的参数

string

Y


access_token

授权后的access token

string

Y


company_id

滴滴企业ID

string

Y


timestamp

当前时间戳(精确到秒级)

int

Y


sign

签名

string

Y


param_json

参数信息

json字符串

Y

具体参考示例 单次请求建议数量小于50,上限100,

param_json

字段名

字段说明

字段类型

必填

备注

list

参数列表

[]object

Y

人员批量信息

list

字段名

字段说明

字段类型

必填

备注

member_type

员工信息类型

int

N

枚举值数字 0:手机号,1:工号。2:邮箱;默认为0

phone

员工手机号

string

N

member_type 为0时必传 使用海外手机号时输入格式为 +90 137****0001 ,国内可以不加区号

realname

员工姓名

string

Y

姓名只支持汉字、字母、数字、下划线、正反斜杠、空格、点,且不超过50个字符

employee_number

员工工号

string

N

member_type 为1时必传 员工在公司的员工号 最多32个字符

email

邮箱

string

N

member_type 为2时必传

leader_info

直属上级信息

Object

N


role_ids

角色

array(int)

N

可以通过角色API获取对应的ID,初管和主管角色目前不支持处理,接口传递目前会忽略处理,后续视业务需求考虑支持或报错。

residentsname

常驻地中文

string

N

最多200字符
支持地级市、区县维度
如果传区县,格式为 城市-区县

residents_ids

常驻地ID

array(int)

N

滴滴侧城市id
不传不更新,传[]清空,同时传residentsname和residents_ids以residentsname为准
数量限制:≤ 30

residents_adcode

常驻地行政区划代码

string

N

支持地级市、区县维度
支持传多个常驻地,以逗号分隔
仅支持国内行政区划代码,国际依然需要传滴滴ID
支持的国内区划代码请参考民政部官网

use_company_money

是否企业支付余额

int

N

枚举值数字 0 否,1 是 不传默认为是
1 是:员工预订符合管控规则,可由企业直接支付
0 否:员工需要个人支付

total_quota

限额

string

N

单位元,需为大于 0 的正整数
不传或者传0代表不限
未升级限额管理模块,此处为【月限额】
已升级限额规则模块,限额所对应的周期为【员工限额管理】中【员工个人限额(默认)】规则的周期

is_remark

叫车时备注信息是否必填

int

N

枚举值数字 0 选填,1 必填,2 按制度填写

department_id

部门ID

int

N

滴滴内部部门ID主键

out_department_id

外部部门code

string

N

客户内部的部门业务编码department_id与out_department_id同时存在时,以department_id为准。

set_dismiss_time

设置的员工离职日期

string

N

新建人员后,可以设置离职日期,设置员工离职日期,到期后自动加入已离职名单,不传或为空时认为不设置离职时间。
不传不更新;传空更新为空。
支持格式:(1)日期:YYYY-MM-DD;(2)日期时间:YYYY-MM-DD HH:MM:SS
时间必须晚于当前时间(请务必考虑接口传输延时) 。
传入日期,将在隔天凌晨处理离职状态;传入具体时间,将在下一个定时任务时处理离职状态(延时不超过15分钟)。举例:2024.08.15 当天 传入2024.08.17 会在17日凌晨处理离职。

rule_ids

规则ID

array(int)

N

人员上绑定的制度ID

profile_id

所在公司主体ID

int

N

滴滴企业级内部的公司ID

out_legal_entity_id

所在公司业务编码

string

N

同公司档案里的业务编码,含义为客户系统中的公司编码
对于滴滴而言是外部公司ID

rank_id

职级id

int

N

滴滴企业级内部的职级ID

out_rank_id

外部职级 ID

string

N

rank_id和out_rank_id同时存在以rank_id为准

english_surname

英文姓

string

N

同lastname

english_name

英文名

string

N

同firstname 有middlename时 english_name=firstname middlename english_surname+english_name 合计不超过26个字符含空格

nickname

昵称

string

N


sex

性别

int

N

枚举值数字 0 未知 1 男 2 女 默认 0

birth_date

出生日期

string

N

格式2000-01-01(已用AES算法加密)

card_list

证件信息

[]object

N

全量覆盖。传空全部清空,包括ES后台维护的已有证件。

cert_realname

证件中文姓名

string

N

证件上的真实中文姓名,不超过50个字符

cert_english_surname

证件英文姓

string

N

证件上的真实英文姓,不超过50个字符

cert_english_name

证件英文名

string

N

证件上的真实英文名,不超过50个字符

send_sme

是否发送创建短信

int

N

枚举值数字 0 不发送 1 发送 默认 0 不发

leader_info

字段名

字段说明

字段类型

备注

type

上级领导主键类型

string

枚举值英文 phone employee_number email

value

主键对应值

string

使用海外手机号时输入格式为 +90 137****0001 ,国内可以不加区号

card_list

字段名

字段说明

字段类型

备注

card_type

证件类型

int

枚举值数字 1. 身份证,2. 护照,3. 港澳台居民居住证,4. 台胞证,5. 军官证,6. 回乡证,7. 外国人永久居留身份证 8.往来港澳通行证 9.公务护照 10.外交护照 11.其他 12.台湾通行证

card_no

证件号码

string

证件号码(已用AES算法加密)

expire_date

证件过期日期

string

格式:2050-01-01(已用AES算法加密)

请求示例

{
    "access_token": "c0ade0d0bbf520dc5bdf1b5a53b7f2a14126c20c",
    "company_id": "1125933732216782",
    "param_json": "{\"list\":[{\"member_type\":2,\"realname\":\"新增 员工\",\"phone\":\"000****6190\",\"employee_number\":\"16\",\"email\":\"yuan16@didi.com\",\"role_ids\":[1125937068906402],\"leader_info\":{\"type\":\"employee_number\",\"value\":\"1\"},\"residentsname\":\"北京市,成都市\",\"residents_ids\":[1,17],\"residents_adcode\":\"110000,510100\",\"use_company_money\":1,\"total_quota\":\"340\",\"is_remark\":1,\"department_id\":1125937069763343,\"out_department_id\":\"1\",\"set_dismiss_time\":\"\",\"rule_ids\":[1125933732693534,1125933752397998],\"profile_id\":1125937237886269,\"out_legal_entity_id\":\"002\",\"rank_id\":1125934334887004,\"out_rank_id\":\"3\",\"english_surname\":\"KlMyTn 7ebKU1\",\"english_name\":\"ULTv Hm_ng\",\"sex\":1,\"birth_date\":\"6H0xV1OFO3jNuvcd0bCk4A==\",\"card_list\":[{\"card_type\":1,\"card_no\":\"2fZxd+gSCsAMQQT7vObcY2yxvzmdU9CCkIY3nYUMMnw=\",\"expire_date\":\"7RblwOM1dSp9LESxh8ZN9w==\"}],\"send_sme\":1}]}",
    "sign": "ec74ff65e89dc2f93a834dd6a9b417ca",
    "client_id": "88b789167ce2ba416dcb3645956d54bc_test",
    "sign_key": "20ec7860c8e8E3A7a6f7",
    "timestamp": 1724048534
}

美化格式后:


{
    "access_token": "c0ade0d0bbf520dc5bdf1b5a53b7f2a14126c20c",
    "company_id": "1125933732216782",
    "param_json": {
        "list": [
            {
                "member_type": 2,
                "realname": "新增 员工",
                "phone": "000****6190",
                "employee_number": "16",
                "email": "yuan16@didi.com",
                "role_ids": [
                    1125937068906402
                ],
                "leader_info": {
                    "type": "employee_number",
                    "value": "1"
                },
                "residentsname": "北京市,成都市",
                "residents_ids": [
                    1,
                    17
                ],
                "residents_adcode":"110000,510100",
                "use_company_money": 1,
                "total_quota": "340",
                "is_remark": 1,
                "department_id": 1125937069763343,
                "out_department_id": "1",
                "set_dismiss_time": "",
                "rule_ids": [
                    1125933732693534,
                    1125933752397998
                ],
                "profile_id": 1125937237886269,
                "out_legal_entity_id":"002",
                "rank_id": 1125934334887004,
                "out_rank_id": "3",
                "english_surname": "KlMyTn 7ebKU1",
                "english_name": "ULTv Hm_ng",
                "sex": 1,
                "birth_date": "6H0xV1OFO3jNuvcd0bCk4A==",
                "card_list": [
                    {
                        "card_type": 1,
                        "card_no": "2fZxd+gSCsAMQQT7vObcY2yxvzmdU9CCkIY3nYUMMnw=",
                        "expire_date": "7RblwOM1dSp9LESxh8ZN9w=="
                    }
                ],
                "send_sme": 1
            }
        ]
    },
    "sign": "ec74ff65e89dc2f93a834dd6a9b417ca",
    "client_id": "88b789167ce2ba416dcb3645956d54bc_test",
    "sign_key": "20ec7860c8e8E3A7a6f7",
    "timestamp": 1724048534
}

响应参数

字段名

字段说明

字段类型

备注

errno

错误编码

string

数字 0 表示成功,非0 表示失败

errmsg

错误信息

string

errno=0时为常量"SUCCESS",errno!=0时为错误信息

data

返回值对象

object


request_id

请求查询主键

string

用于查询请求的主键


data数据格式

字段名

字段说明

字段类型

备注

insert_count

添加成功数量

int


update_count

修改成功数量

int


failure_count

失败员工数量

int


error_info_list

报错信息信息

array



erro_info_list结构

字段名

字段说明

字段类型

备注

index

与传入参数相对应的下标

int


err_no

错误码

int


err_msg

报错信息

string


identifier

员工信息类型

string

member_type为手机号,返回报错员工的手机号member_type为工号,返回报错员工的工号member_type为邮箱,返回报错员工的邮箱

member_type

员工唯一标识

int

枚举值 0:手机号,1:工号。2:邮箱

realname

员工姓名

string


响应示例

正常示例

{
    "errno": 0,
    "errmsg": "SUCCESS",
    "data": {
        "insert_count": 0,
        "update_count": 94,
        "failure_count": 6,
        "error_info_list": [
            {
                "index": 0,
                "err_no": 20002,
                "err_msg": "操作失败",
                "identifier":"00016265966@didi.com",
                "member_type": 2, 
                "realname": "00016265966"
            }
        ]
    },
    "request_id": "DFth2PDGtdDjTD0Y7LycXhT2VetSV2qYGmTDj8y6tthIYu8Lk8H2OBEjxaoV4Uq8"
}


错误码

通用错误解决方案

错误码

错误描述

10003

param is error

10004

unsupport origin

230000

重复请求

230001

操作失败(预处理失败)

230002

员工数量超过100

230003

校验公司信息失败



error_info_list报错代码

错误码

错误描述

20001

重复请求

20002

操作失败

20003

员工数量超过100

20004

校验公司信息失败

20005

获取员工信息失败

20006

获取职级信息失败

20007

获取部门信息失败

20008

获取项目信息失败

20009

获取所属公司信息失败

20010

获取角色信息失败

20011

员工不存在

20012

获取制度信息失败

20013

设置限额失败

20014

查询限额失败

20015

生日格式校验不合法

20016

邮箱格式校验不合法

20017

邮箱敏感词校验不合法

20018

邮箱已绑定

20019

姓名为空

20020

姓名敏感词校验不合法

20021

姓名格式校验不合法

20022

获取员工数量失败

20023

员工数量添加上限

20024

邮箱长度超限

20025

部门code

20026

员工编号已存在

20027

英文名格式校验不合法

20028

英文姓格式校验不合法

20029

绑定leader失败

20030

leader不存在

20031

角色不存在

20032

员工离职时间设置错误

20033

员工离职时间设置不能小于当前时间

20034

昵称敏感词校验不合法

20035

身份证类型设置错误

20036

身份证内容不能为空

20037

解密身份证失败

20038

解密身份证失效时间失败

20039

身份证校验失败

20040

获取公司余额失败

20041

设置总额度失败

20042

设置城市名称失败

20043

职级不存在

20044

检查是否为备注失败

20045

检查性别失败

20046

手机号校验失败

20047

手机号被列入系统黑名单

20048

手机号已绑定

20049

一人多企业获取失败

20050

手机号为空

20051

查询邀请记录失败

20052

创建邀请记录失败

20053

员工编号超限

20054

英文姓名总长度超过26个字符

20055

公司不存在

20056

身份证号格式有误

20057

昵称长度超限

20058

台湾居民来往内地通行证格式有误

20059

台湾通行证格式有误

20060

回乡证格式有误

20061

军官证格式有误

20062

证件类型有误

20063

港澳通行证格式有误

20064

护照格式有误

20065

公务护照格式有误

20066

外交护照格式有误

20067

港澳台居民居住证证格式有误

20068

外国永久身份证格式有误

20069

生日不能晚于当前时间

20070

初管的角色不可操作

20071

手机号重复

20072

工号重复

20073

邮箱重复

20074

工号为空

20075

邮箱为空

20076

类型异常

21001

关系类型设置错误

21002

关系值类型异常

21003

关系值不存在


版本记录

日期

更新人

更新内容

上线时间

2024.08.12

陈继诗

新建文档

2024.10.31

2025.05.15

杨露佳

新增residents_ids

2025.05.15

2025.09.05

李青龙

调整文档param_json数据结构

2025.09.05

2025.11.17

谢朱莉

增加证件姓名相关字段

2025.11.10

2026.1.26

杨露佳

增加响应参数,identifier,member_type,realname

2026.1.22

2026.1.21

谢朱莉

常驻地支持区县

2026.1.21

2026.3.24

谢朱莉

新增昵称、公司业务编码、常驻地行政区划代码

2026.3.24