阿里云短信使用总结

た入场券 2022-12-29 01:50 624阅读 0赞

### 阿里云短信 ###

*  官方文档地址
 *  单条短信发送
 *   *  1、官方api
     *  2、实例使用
     *  3、注意事项
     *   *  1）、addEndpoint方法过时
 *  批量短信发送api
 *   *  官网api
     *  实例使用
     *  注意事项
     *   *  1）、传入短信模板参数设置
         *  2）、短信签名参数设置
         *  3）、批量参数一一对应
         *  4）、短信的发送号码问题
 *  短信日志
 *   *  1）、设置Http消息回执推送的接口

# 官方文档地址 #

**阿里云短信服务官方帮助文档**：https://help.aliyun.com/product/44282.html?spm=5176.12207334.0.0.37941cbeBR3aFY

打开阿里云官网注册账号，并免费开通短信服务，再往账户里冲点钱就完事了。转载一个比较详细的教程供参考：https://blog.csdn.net/qq\_37529302/article/details/105495326

# 单条短信发送 #

单条发送短信比较简单，一般用于发送短信验证码居多，其他的相似的短信可以使用批量发送的api进行发送。

## 1、官方api ##

//设置超时时间-可自行调整
    System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
    System.setProperty("sun.net.client.defaultReadTimeout", "10000");
    //初始化ascClient需要的几个参数
    final String product = "Dysmsapi";//短信API产品名称（短信产品名固定，无需修改）
    final String domain = "dysmsapi.aliyuncs.com";//短信API产品域名（接口地址固定，无需修改）
    //替换成你的AK
    final String accessKeyId = "yourAccessKeyId";//你的accessKeyId,参考本文档步骤2
    final String accessKeySecret = "yourAccessKeySecret";//你的accessKeySecret，参考本文档步骤2
    //初始化ascClient,暂时不支持多region（请勿修改）
    IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId,
    accessKeySecret);
    DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
    IAcsClient acsClient = new DefaultAcsClient(profile);
    
     //组装请求对象
     SendSmsRequest request = new SendSmsRequest();
     //使用post提交
     request.setMethod(MethodType.POST);
     //必填:待发送手机号。支持以逗号分隔的形式进行批量调用，批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式；发送国际/港澳台消息时，接收号码格式为国际区号+号码，如“85200000000”
     request.setPhoneNumbers("1500000000");
     //必填:短信签名-可在短信控制台中找到
     request.setSignName("云通信");
     //必填:短信模板-可在短信控制台中找到，发送国际/港澳台消息时，请使用国际/港澳台短信模版
     request.setTemplateCode("SMS_1000000");
     //可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
     //友情提示:如果JSON中需要带换行符,请参照标准的JSON协议对换行符的要求,比如短信内容中包含\r\n的情况在JSON中需要表示成\\r\\n,否则会导致JSON在服务端解析失败
    //参考：request.setTemplateParam("{\"变量1\":\"值1\",\"变量2\":\"值2\",\"变量3\":\"值3\"}")
     request.setTemplateParam("{\"name\":\"Tom\", \"code\":\"123\"}");
     //可选-上行短信扩展码(扩展码字段控制在7位或以下，无特殊需求用户请忽略此字段)
     //request.setSmsUpExtendCode("90997");
    
     //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
     request.setOutId("yourOutId");
    
    //请求失败这里会抛ClientException异常
    SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
    if(sendSmsResponse.getCode() != null && sendSmsResponse.getCode().equals("OK")) {
    //请求成功
    }

## 2、实例使用 ##

/**
     * 发送修改密码的验证码
     *
     * @param phone 手机号码
     * @throws Exception
     */
    @Override
    public void sendWithChangePasswd(String phone) throws Exception {
        //1,生成验证码
        String code = RandomUtils.getFourBitRandom();
        Map<String, Object> param = new HashMap<>();
        param.put("code", code);
        //2.从nacos上读取配置信息
        String regionId = smsProperties.getRegionId();
        String keyId = smsProperties.getKeyId();
        String keySecret = smsProperties.getKeySecret();
        //创建配置对象
        DefaultProfile profile = DefaultProfile.getProfile(
                regionId,
                keyId,
                keySecret);
        //创建client对象
        IAcsClient client = new DefaultAcsClient(profile);
        //创建参数对象
        CommonRequest request = new CommonRequest();
        //组装参数对象
        request.setSysMethod(MethodType.POST);
        request.setSysDomain("dysmsapi.aliyuncs.com");
        request.setSysVersion("2017-05-25");
        request.setSysAction("SendSms");
        request.putQueryParameter("PhoneNumbers", phone);
        request.putQueryParameter("SignName", smsProperties.getSignName());
        request.putQueryParameter("TemplateCode", smsProperties.getTemplateCodeByAuthCode());
        //手机号码，转换json数据传递
        request.putQueryParameter("TemplateParam", JSONObject.toJSONString(param));
        //发送短信
        CommonResponse response = client.getCommonResponse(request);
    
        //得到返回结果,一个json字符串,把它转化为Map对象
        String data = response.getData();
        HashMap responseMap = JSON.parseObject(data, HashMap.class);
        //返回结果不等于"OK"则出错了
        if (!"OK".equals(responseMap.get("Code"))) {
            log.error(data);
            throw new MoocException(ResultCodeEnum.SMS_SEND_ERROR);
        }
        if ("isv.MOBILE_NUMBER_ILLEGAL".equals(responseMap.get("Code"))) {
            throw new MoocException(ResultCodeEnum.LOGIN_PHONE_ERROR);
        }
        if ("isv.BUSINESS_LIMIT_CONTROL".equals(code)) {
            throw new MoocException(ResultCodeEnum.SMS_SEND_ERROR_BUSINESS_LIMIT_CONTROL);
        }
        //存入Redis，以分钟为单位,5分钟有效
        redisTemplate.opsForValue().set(phone, code, 5, TimeUnit.MINUTES);
    }

## 3、注意事项 ##

### 1）、addEndpoint方法过时 ###

官方api的这个方法已经过时了，只需要将两个 "cn-hangzhou"保留一个即可。

DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);

# 批量短信发送api #

## 官网api ##

//设置超时时间-可自行调整
    System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
    System.setProperty("sun.net.client.defaultReadTimeout", "10000");
    //初始化ascClient需要的几个参数
    final String product = "Dysmsapi";//短信API产品名称（短信产品名固定，无需修改）
    final String domain = "dysmsapi.aliyuncs.com";//短信API产品域名（接口地址固定，无需修改）
    //替换成你的AK
    final String accessKeyId = "yourAccessKeyId";//你的accessKeyId,参考本文档步骤2
    final String accessKeySecret = "yourAccessKeySecret";//你的accessKeySecret，参考本文档步骤2
    //初始化ascClient,暂时不支持多region（请勿修改）
    IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId,
    accessKeySecret);
    DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
    IAcsClient acsClient = new DefaultAcsClient(profile);
    
     //组装请求对象
     SendBatchSmsRequest request = new SendBatchSmsRequest();
     //使用post提交
     request.setMethod(MethodType.POST);
     //必填:待发送手机号。支持JSON格式的批量调用，批量上限为100个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
     request.setPhoneNumberJson("[\"1500000000\",\"1500000001\"]");
     //必填:短信签名-支持不同的号码发送不同的短信签名
     request.setSignNameJson("[\"云通信\",\"云通信\"]");
     //必填:短信模板-可在短信控制台中找到
     request.setTemplateCode("SMS_1000000");
     //必填:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
     //友情提示:如果JSON中需要带换行符,请参照标准的JSON协议对换行符的要求,比如短信内容中包含\r\n的情况在JSON中需要表示成\\r\\n,否则会导致JSON在服务端解析失败
     request.setTemplateParamJson("[{\"name\":\"Tom\", \"code\":\"123\"},{\"name\":\"Jack\", \"code\":\"456\"}]");
     //可选-上行短信扩展码(扩展码字段控制在7位或以下，无特殊需求用户请忽略此字段)
     //request.setSmsUpExtendCodeJson("[\"90997\",\"90998\"]");
    
    //请求失败这里会抛ClientException异常
    SendBatchSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
    if(sendSmsResponse.getCode() != null && sendSmsResponse.getCode().equals("OK")) {
    //请求成功
    }

## 实例使用 ##

/**
     * 批量发送平台通知
     *
     * @param sendByMsgVo
     */
    @Override
    public void sendByMsg(SendByMsgVo sendByMsgVo) throws Exception {
        //设置超时时间-可自行调整
        System.setProperty("sun.net.client.defaultConnectTimeout", smsProperties.getDefaultConnectTimeout());
        System.setProperty("sun.net.client.defaultReadTimeout", smsProperties.getDefaultReadTimeout());
        //初始化ascClient需要的几个参数
        final String product = "Dysmsapi";
        final String domain = "dysmsapi.aliyuncs.com";
        //1.从nacos上读取配置信息
        final String regionId = smsProperties.getRegionId();
        final String accessKeyId = smsProperties.getKeyId();
        final String accessKeySecret = smsProperties.getKeySecret();
        IClientProfile profile = DefaultProfile.getProfile(regionId, accessKeyId,
                accessKeySecret);
        DefaultProfile.addEndpoint(regionId, product, domain);
        IAcsClient acsClient = new DefaultAcsClient(profile);
        //创建请求参数
        SendBatchSmsRequest request = new SendBatchSmsRequest();
        //使用post提交
        request.setSysMethod(MethodType.POST);
        //传入要发送的手机号码list集合
        request.setPhoneNumberJson(JSONObject.toJSONString(sendByMsgVo.getPhones()));
        //短信签名,个数必须与手机号码的个数保持一致
        List<String> list4signName = new ArrayList<>();
        int size = sendByMsgVo.getPhones().size();
        for (int i = 0; i < size; i++) {
            list4signName.add(smsProperties.getSignName());
        }
        request.setSignNameJson(JSONObject.toJSONString(list4signName));
        //设置templateCode,根据传入的消息类型字符串获取相应的模板码
        request.setTemplateCode(smsProperties.getTemplateCodeByPlatAnno());
        //短信模板
        List<String> list4param = new ArrayList<>();
        for (int i = 0; i < size; i++) {
            list4param.add("{\"name\":\"" + sendByMsgVo.getNames().get(i) + "\",\"type\":\"" + sendByMsgVo.getType() + "\"}");
        }
        request.setTemplateParamJson(JSONObject.toJSONString(list4param));
        //请求失败这里会抛ClientException异常
        SendBatchSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
        if (sendSmsResponse.getCode() != null && sendSmsResponse.getCode().equals("OK")) {
            return;
        } else {
            throw new MoocException(ResultCodeEnum.SMS_SEND_ERROR);
        }
    }

## 注意事项 ##

### 1）、传入短信模板参数设置 ###

由于在传入短信的参数时是以key-value的形式，并且以map集合的json格式传入由阿里云解析，所以要注意转义字符""的使用，需要对key值保留一个”引号。

### 2）、短信签名参数设置 ###

//短信签名,个数必须与手机号码的个数保持一致
        List<String> list4signName = new ArrayList<>();
        int size = sendByMsgVo.getPhones().size();
        for (int i = 0; i < size; i++) {
            list4signName.add(smsProperties.getSignName());
        }

### 3）、批量参数一一对应 ###

由于批量发送短信所带的短信内容或者短信签名可能都不一样，所以在定义参数的时候要注意参数对应的位置，因为底层是通过for循环来进行参数的一一绑定的。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70_pic_center]

### 4）、短信的发送号码问题 ###

使用阿里云短信服务多次发送到用一个手机同一个内容可能不是同一个号码，这是阿里云那边的一个机制，它是随机的。

# 短信日志 #

短信日志需要设置官网中的两个方法，一个是http消息回执推送，一个是QuerySendDetails这个api，  
流程图如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70_pic_center 1]

## 1）、设置Http消息回执推送的接口 ##

在项目中定义一个接口用来接收这个消息回执，并定义一个vo类来接收回执参数  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70 1]

**回执vo类**

/**
     * @Author sdl
     * @Date 2020/12/10
     * @escription：短信发送日志的vo
     */
    @Data
    @ApiModel(value = "SmsReportVo对象",description = "日志回执信息类")
    public class SmsReportVo {
    
    
        @ApiModelProperty(value = "手机号码")
        @JsonProperty("phone_number")
        private String phoneNumber;
    
        @ApiModelProperty(value = "发送时间")
        @JsonProperty("send_time")
        private String sendTime;
    
        @ApiModelProperty(value = "报告时间")
        @JsonProperty("report_time")
        private String reportTime;
    
        @ApiModelProperty(value = "是否成功")
        private String success;
    
        @ApiModelProperty(value = "错误码")
        @JsonProperty("err_code")
        private String errCode;
    
        @ApiModelProperty(value = "错误信息")
        @JsonProperty("err_msg")
        private String errMsg;
    
        @ApiModelProperty(value = "信息长度")
        @JsonProperty("sms_size")
        private String smsSize;
    
        @ApiModelProperty(value = "发送序列号")
        @JsonProperty("biz_id")
        private String bizId;
    
        @ApiModelProperty(value = "用户序列号")
        @JsonProperty("out_id")
        private String outId;
    
    }

按照流程图，在接口中接收这个参数之后就要获取回执参数并调用QuerySendDetails这个方法。

**官网api**

//设置超时时间
        System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
        System.setProperty("sun.net.client.defaultReadTimeout", "10000");
    
        //云通信产品-短信API服务产品名称（短信产品名固定，无需修改）
        final String product = "Dysmsapi";
        //云通信产品-短信API服务产品域名（接口地址固定，无需修改）
    
        final String domain = "dysmsapi.aliyuncs.com";
    
        //此处需要替换成开发者自己的AK信息
        final String accessKeyId = "yourAccessKeyId";
        final String accessKeySecret = "yourAccessKeySecret";
    
        //初始化ascClient
        IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
        DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
        IAcsClient acsClient = new DefaultAcsClient(profile);
    
        //组装请求对象
        QuerySendDetailsRequest request = new QuerySendDetailsRequest();
        //必填-号码
        request.setPhoneNumber("150000000");
        //可选-调用发送短信接口时返回的BizId
        request.setBizId("1234567^8901234");
        //必填-短信发送的日期 支持30天内记录查询（可查其中一天的发送数据），格式yyyyMMdd
        request.setSendDate("20170513");
        //必填-页大小
        request.setPageSize(10L);
        //必填-当前页码从1开始计数
        request.setCurrentPage(1L);
    
        //hint 此处可能会抛出异常，注意catch
        QuerySendDetailsResponse querySendDetailsResponse = acsClient.getAcsResponse(request);
    
        //获取返回结果
       if(querySendDetailsResponse.getCode() != null && querySendDetailsResponse.getCode().equals("OK")){
        //代表请求成功
      }

**存入数据库**

/获取返回结果
        if(querySendDetailsResponse.getCode() != null && querySendDetailsResponse.getCode().equals("OK")){
            //查询短信发送详情请求成功
            log.info("进入查询QueryDetailResponse成功");
            List<QuerySendDetailsResponse.SmsSendDetailDTO> smsSendDetailDTOs = querySendDetailsResponse.getSmsSendDetailDTOs();
            //生成QuerySendDetail对象存入数据库
            for(QuerySendDetailsResponse.SmsSendDetailDTO smsSendDetailDTO:smsSendDetailDTOs){
                //组装参数
                QuerySendDetail querySendDetail = new QuerySendDetail();
                querySendDetail.setBizId(smsReportVo.getBizId());
                querySendDetail.setOutId(smsSendDetailDTO.getOutId());
                querySendDetail.setContent(smsSendDetailDTO.getContent());
                querySendDetail.setErrCode(smsSendDetailDTO.getErrCode());
                querySendDetail.setTemplateCode(smsSendDetailDTO.getTemplateCode());
                querySendDetail.setPhone(smsSendDetailDTO.getPhoneNum());
                querySendDetail.setSendDate(smsSendDetailDTO.getSendDate());
                querySendDetail.setReceiveDate(smsSendDetailDTO.getReceiveDate());
                querySendDetail.setStatus(smsSendDetailDTO.getSendStatus());
    
                log.info("发送详情信息=======>"+querySendDetail.toString());
                //插入数据库
                aliyunSmsLogMapper.insert(querySendDetail);
            }
    
        }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70]: /images/20221120/f4d59a84e22449cebfface5507ae99f6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/100c50c2959e495facb5278df81e6363.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/4b65d873b91b41038338dc8ef4763079.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTY4MDk2Mg_size_16_color_FFFFFF_t_70 1]: /images/20221120/83538a80dfc14cdd986eadfba1c57678.png