一、业务背景

乐创者平台默认提供了对阿里云短信的支持，如果项目需要支持其他的短信发送服务商，可以通过乐创者平台开放的标准短信发送接口进行扩充。

支持版本： v7.3.0+

二、接口定义

准备工作

从项目依赖lczServer/WEB-INF/lib/hr-toolkit-x.x.x.jar

扩展类实现

实现CustomSendSMS接口，接口定义如下：

public interface CustomSendSMS {

    /**
     * 初始化参数
     * @param initParam
     */
    void init(String initParam);

    /**
     * 单个手机发送短信
     * @param phone    手机号
     * @param message  短信消息
     * @param params   短信参数（后续业务扩展）
     * @param smsCheckType   短信发送类型
     * @return
     * @throws Exception
     */
    SmsSendResult send(String phone, String message, Map<String, String> params, SmsCheckType smsCheckType) throws Exception;

    /**
     * 多个手机发送同一信息
     * @param phones    手机号列表
     * @param message   短信消息
     * @param params    短信参数（后续业务扩展）
     * @param smsCheckType  短信发送类型
     * @return
     * @throws Exception
     */
    SmsSendResult sends(List<String> phones, String message, Map<String, String> params, SmsCheckType smsCheckType) throws Exception;

    /**
     * 系统销毁和发短信配置改变时会触发销毁
     * @throws Exception
     */
    void destroy() throws Exception;
}

相关的枚举定义：

/**
 * 业务类型枚举ding'yi
 */
public enum SmsCheckType {
    userRegister("userregister"), //用户注册
    modifyPhone("modify_phone"),  //修改手机
    forgetPwd("forgetpw"),        //忘记密码
    login("login"),               //短信登录
    alarm("alarm"),               //告警
    secondCheck("login_s_c"),   //二次验证
    template_event("template_event"),  // 模版发短信事件
    template_verify_code("template_verify_code"),   // 模版短信验证码
    collection_task("collection_task"),    //采集任务
    workflow_notify("workflow_notify"),  // 工作流短信通知
    ;

    private String name;

    SmsCheckType(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

相关的返回对象定义如下：

public class SmsSendResult {
    /**
     * 短信是否发送成功
     */
    private boolean success;
    /**
     *  短信发送后信息
     */
    private String msg;
    /**
     *   短信发送后编码
     */
    private String code;
    /**
     *   短信发送后自定义回调参数（预留）
     */
    private Map<String, Object> content;

    public boolean isSuccess() {
        return success;
    }

    public void setSuccess(boolean success) {
        this.success = success;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public Map<String, Object> getContent() {
        return content;
    }

    public void setContent(Map<String, Object> content) {
        this.content = content;
    }
}