# SMS短信服务

# 概述

短信服务是广大企业客户快速触达手机用户所优选使用的通信能力。调用API或用群发助手，即可发送验证码、通知类和营销类短信；主要功能包含：发短信、短信配置。

目前短信服务默认支持的服务商分别为：阿里云sms、腾讯sms、容联云sms、七牛sms；短信服务还支持扩展服务商，只需自定义短信发送逻辑即可。

# 短信功能使用

# 发送短信

发送短信时只需要使用SmsSendUtil.send()方法发送短信即可:

  /**
     *@Description: 发送短信
     * @param key:短信配置的编码
     * @param smsSendParam:封装的短信参数
     * @return: null
     *@auth:whh
     *@date 2022/8/17
     **/
    public static BaseResponse send(String key, SmsSendParam smsSendParam){
}

send方法有两个参数分别为：

key:短信配置中的短信配置编码
smsSendParam：封装的实体类SmsSendParam

# 实体类SmsSendParam

public class SmsSendParam {

    /**
    *@Description:短信签名,使用时可传配置的code
    *@auth:whh
    *@date 2022/8/17
     **/
    private  String signCode;

    /**
     *@Description:模板id
     *@auth:whh
     *@date 2022/8/17
     **/
    private  String templeId;

    /**
     *@Description:接收者电话
     *@auth:whh
     *@date 2022/8/17
     **/
    private  String phones;

    /**
     *@Description:模板参数,要按顺序来维护
     *@auth:whh
     *@date 2022/8/17
     **/
    private LinkedHashMap<String,String> params;

    /**
     *@Description:短信内容
     *@auth:whh
     *@date 2022/8/17
     **/
    private  String context;

    /**
     *@Description:
     *@auth:whh
     *@date 2022/8/17
     **/
    private  String appId ;

    /**
     *@Description:具体签名，可不需要传，会根据签名code去查询
     *@auth:whh
     *@date 2022/8/17
     **/
    private  String sign;

# 短信配置

# 1. 概述

由于不同的短信服务商在发送短信验证码、系统通知以及活动通知等多种短信服务时存在不同的要求差异，导致用户使用不同短信服务商发送短信步骤复杂,不利于维护；因此短信服务提供了短信配置功能，发送短信时只需简单的配置必要参数即可实现不同短信服务商的短信发送。

短信配置的功能主要包含有：查询短信配置、新增短信配置、编辑短信配置、停/启用短信配置、删除短信配置、维护短信签名、维护短信模板、查看、数据日志、数据生命周期。

【菜单路径】：系统管理—->认证管理-->短信配置

短信配置

# 2. 查询短信配置

根据 编码、名称、短信服务商检索数据。

短信配置

# 3. 新增短信配置

点击表格上方【新增】按钮,跳转新增短信配置页面，如下图所示：

新增短信配置

短信配置参数信息说明

属性名	属性说明
服务商	提供短信发送服务的厂商
编码	短信配置编码，唯一标识
名称	短信配置名称
处理类	自定义短信发送时配置的类，该类需继承SmsSender
短信服务字段	不同服务商配置客户端以及发送短信时的必要字段，例如阿里的：accessKey，secretKey，regionId等
备注	备注信息

SmsSender短信发送接口

/**
 * @program: hos-app
 * @author: whh
 * @create: 2022-08-17 15:05
 */
public interface SmsSender {


    /**
    *@Description:发送短信
    * @param smsSendParam:
    * @return: void
    *@auth:whh
    *@date 2022/8/17
     **/
   BaseResponse send(SmsSendParam smsSendParam);


   /**
   *@Description: 传入的是短信配置实体
   * @param sms:
   * @return: com.mediway.hos.app.config.handler.SmsSender
   *@auth:whh
   *@date 2022/8/20
    **/
    SmsSender createSmsSender(Sms sms);

}