# 员工删除接口

# 1.概述

员工批量删除接口,支持通过美团企业版员工唯一标识(staffId)、企业唯一标识(手机号、工号、邮箱)删除,单次最大删除员工数量为50

注:员工A删除后,再次同步到美团,会按照新增逻辑处理,历史申请单和订单会消失。

# 2.接口基本信息

名称 描述
请求方式 POST
调用地址 测试环境:https://waimai-openapi.apigw.test.meituan.com/api/sqt/open/staff/batch/delete
正式环境:https://bep-openapi.meituan.com/api/sqt/open/staff/batch/delete
调用方 客户平台
响应方 美团企业版
响应超时时间 15秒
调用限频 每分钟访问不超过100次,每天累计访问不超过100000次

# 2.1.请求体

名称 类型 是否必填 示例 说明
accessKey String 美团企业版分配给客户的接入秘钥
content String UgxoCGPQIzoP 请求体内容,将请求参数JSON序列化后进行加密的结果值,
参照:签名实例

# content加密前数据结构

名称 类型 是否必填 示例 说明
ts Long 1617085650321 13位时间戳。若请求发起时间与平台接受请求时间相差大于10分钟,平台将直接拒绝本次请求
entId Long 46574 企业ID
staffIdList List<Long> [1,2,3] 要删除的员工的列表,staffId含义为美团侧存储的员工唯一标识,staffIdList和staffIdentifierList必传其一,都不为空时,只处理staffIdList
staffIdentifierList List<String> ["staff1","staff2"] 要删除的员工的列表,staffIdentifier含义为企业的唯一标识(手机号或者工号或者邮箱,可和客户经理确认),staffIdList和staffIdentifierList必传其一,都不为空时,只处理staffIdList

# 2.2.响应参数

名称 类型 是否必填 示例 说明
traceId String 56a0af18ae30a168d4006c7c 日志查询ID,用于排查问题
status Integer 0 接口响应编码,编码枚举值和解决方案详见第四章错误码
msg String 错误描述信息
data String UgxoCGPQIzoP 响应数据,将响应参数JSON序列化后进行加密的结果值,解密秘钥使用secretKey参数

# data解密后数据结构

类型 是否必填 示例 说明
List<StaffDeleteItem> StaffDeleteItem 返回结果

StaffDeleteItem字段说明

名称 类型 是否必填 示例 说明
result Integer 0 针对每个员工删除结果的响应编码,编码枚举值和解决方案详见第四章错误码
itemMsg String 成功 描述
staffId Long 397374 美团企业版员工ID
staffIdentifier String 39WNRUYJC1Z6 企业的唯一标识(手机号或者工号或者邮箱,可和客户经理确认)

# 3.示例

# 3.1.请求示例

# 3.1.1.请求示例

{
  "accessKey":"B3KSWLDSKSKDMJ",
  "content":"UgxoCGPQIzoP"
}

# 3.1.2.请求参数content解析

{
  "ts": 123123,
  "entId": 100746,
  "staffIdList": [
    1,
    2,
    3
  ]
}

# 3.2.响应示例

# 3.2.1.响应结果

{
    "traceId":"56a0af18ae30a168d4006c7c",
    "status":0,
    "data":"UgJn07uNgW7S7fJK0R0xVbaLxoCGPQIzoP"
}

# 3.2.2.响应参数data解析

[
    {
      "result": 0,
      "itemMsg": "成功",
      "staffId": 6877151,
      "staffIdentifier": "D0920150125"
    },
    {
      "result": 0,
      "itemMsg": "成功",
      "staffId": 397375,
      "staffIdentifier": ""
    },
    {
      "result": 0,
      "itemMsg": "成功",
      "staffId": 397376,
      "staffIdentifier": ""
    }
]

# 4.错误码

# 4.1.status错误码

错误码 错误描述 解决方案
10010002 企业已停止合作,请联系客户经理进行确认 将接口调用的entId参数给到客户经理,由客户经理确认企业状态是否在合作中
10010003 content不合法 详细阅读content参数加密说明(签名实例),确认content加密方式和content解密前传参是否正确
10010004 ts缺失或ts时间已过期 确认ts是否传值并为13位时间戳,如果正确传值,则确认请求发起时间与美团企业版接受请求的时间差是否超过10分钟
10010005 entId不能为空 entId参数不可为空,如果未拿到entId参数,可以咨询客户经理获取
20010001 accessKey不合法 检查accessKey是否为客户经理给到的值,如果accessKey值正确,确认调用环境是否和accessKey一致,如使用测试环境的accessKey调用线上的接口
20010002 请求path不合法 检查接口调用地址是否正确,如是否有非法字符
20010003 鉴权失败,无接口访问权限 将接口调用地址给到客户经理,由客户经理检查接口权限是否开通并保存成功
20010004 越权访问,无法访问该企业数据,请检查entId的正确性 检查accessKey和entId两个参数的对应关系是否正确
30010001 访问频率过高 请确认接口访问频率,每个接口默认调用限频为每分钟不超过100次,超出调用频率会调用此错误
30010002 访问次数超过配额 请确认接口的累计访问次数,每个接口的默认累计调用量为10w次,超出限额则会报错
10110001 staffIdList和staffIdentifierList为空 请检查staffIdList和staffIdentifierList字段是否为空,员工删除接口中二者必传其一
10110002 staffIdList超出限定长度 请检查staffIdList字段传参,单次删除员工上限为50个
10110003 staffIdentifierList超出限定长度 请检查staffIdentifierList字段传参,单次删除员工上限为50个
10110004 xx字段传值异常,数据类型不匹配 请检查字段传值情况,如:是否出现Integer类型字段传值'aaa'
40110000 部分员工删除失败 请查看响应结果中的result和itemMsg信息,根据解决方案进行调整
40110001 未知错误,请联系美团侧研发 请提供响应结果中的traceId参数,联系客户经理进行排查

# 4.2.result错误码

错误码 错误描述 解决方案
10111001 删除员工不存在 请检查删除员工是否存在
10111002 该员工为上级,不能删除! 请检查员工是否为上级,如为上级,请先调整其下级节点
10111003 该员工为消费接收人,不能删除! 请检查员工是否为消费通知人,如为消费通知人,取消其消费通知人的身份
10111004 员工资产校验失败,不能删除 请根据错误描述中的信息,先删除员工拥有资产(如打车进行中订单),再删除员工

# 5.代码实例

依赖SDK包地址:SDK下载地址

import com.meituan.sqt.client.SqtClient;
import com.meituan.sqt.constant.CommonConstants;
import com.meituan.sqt.enums.ResponseStatusEnum;
import com.meituan.sqt.exception.MtSqtException;
import com.meituan.sqt.request.in.staff.StaffDeleteRequest;
import com.meituan.sqt.response.in.BaseApiResponse;
import com.meituan.sqt.response.in.staff.StaffDeleteResultItem;

import java.util.Arrays;
import java.util.List;
import java.util.Objects;

/**
 * @description: 删除员工请求示例代码
 * @author: xinghaiming@meituan.com
 * @data: 2023/4/11 15:32
 */
public class StaffDeleteDemo {
    private static final String invokeUrl = "https://waimai-openapi.apigw.test.meituan.com/api/sqt/open/staff/batch/delete";

    private static SqtClient sqtClient = null;

    static {
        // 初始化SqtClient,只需要初始化一次即可
        // entId,accessKey,secretKey需要根据不同环境动态的设置获取
        sqtClient = new SqtClient.Builder()
                .setEntId(CommonConstants.entId)
                .setAccessKey(CommonConstants.accessKey)
                .setSecretKey(CommonConstants.secretKey)
                .build();
    }

    public static void main(String[] args) throws MtSqtException {
        // 1. 构建请求对象
        StaffDeleteRequest staffDeleteRequest = new StaffDeleteRequest();
        staffDeleteRequest.setTs(System.currentTimeMillis());
        staffDeleteRequest.setEntId(sqtClient.getEntId());
        //staffIdList和staffIdentifierList不需要同时提供,提供一个即可(ps:若staffIdList不为空,以staffIdList为准)
        staffDeleteRequest.setStaffIdList(Arrays.asList(1L, 2L, 3L));
        //staffDeleteRequest.setStaffIdentifierList(Arrays.asList("Test001", "Test002", "Test003"));
        // 2. API调用
        // 注意:超时时间默认以请求对象中注解ApiMeta上设置的为准,也可以自定义传递对应的超时时间
        BaseApiResponse<List<StaffDeleteResultItem>> response = sqtClient.invokeApi(invokeUrl, staffDeleteRequest, null, null);
        // 3. 响应结果为空处理
        if (Objects.isNull(response)) {
            // 处理响应结果为空情况

        }
        // 4. 获取请求结果
        if(Objects.equals(ResponseStatusEnum.SUCCESS.getCode(), response.getStatus())) {
            // 4.1 请求成功,获取员工删除结果,处理业务逻辑
            List<StaffDeleteResultItem> resultItemList = response.getRealData();


        } else {
            // 4.2 处理请求失败场景
            handleRespFailResult(response);
        }
    }

    private static void handleRespFailResult(BaseApiResponse<List<StaffDeleteResultItem>> response) {
        // 访问频率过高
        if (ResponseStatusEnum.HIGH_FREQUENCY_ACCESS.getCode().intValue() == response.getStatus()) {
            // 解决方案参照:https://h5.dianping.com/app/bep-docs/open-platform-doc/guide/rate_limiting.html
        }
        // 访问次数超过配额
        if (ResponseStatusEnum.EXCEED_ACCESS_NUMBER.getCode().intValue() == response.getStatus()) {
            // 解决方案参照:https://h5.dianping.com/app/bep-docs/open-platform-doc/guide/rate_limiting.html
        }
        // 其它失败场景,解决方案参考:https://h5.dianping.com/app/bep-docs/open-platform-doc/staff/staff_delete.html#_4-1-status%E9%94%99%E8%AF%AF%E7%A0%81

    }
}

# 6.版本记录

版本号 版本日期 更新内容
v1.0 2022-10-28 新增员工删除接口
v1.1 2023-11-09 新增错误码(10110004:字段传值异常,数据类型不匹配)
上次更新: 6/29/2026, 7:56:38 PM