ApiBoot - ApiBoot Alibaba Sms 使用文档

cheng10 发布于2019-08-16 16:20 / 709人阅读

摘要：的短信服务模块是由阿里云的国际短信服务提供的，支持国内和国际快速发送验证码短信通知和推广短信。前提需要到阿里云控制台申请开通短信服务。如果在阿里云控制台定义的短信模板存在多个参数，可以通过方法来进行挨个添加，该方法返回值为本对象。

ApiBoot是一款基于SpringBoot1.x，2.x的接口服务集成基础框架，内部提供了框架的封装集成、使用扩展、自动化完成配置，让接口开发者可以选着性完成开箱即用，不再为搭建接口框架而犯愁，从而极大的提高开发效率。

ApiBoot的短信服务模块是由阿里云的国际短信服务提供的，支持国内和国际快速发送验证码、短信通知和推广短信。

前提：需要到阿里云控制台申请开通短信服务。

引入ApiBoot Alibaba Sms

在pom.xml配置文件内添加如下：



  org.minbox.framework
  api-boot-starter-alibaba-sms

ApiBoot所提供的依赖都不需要添加版本号，具体查看ApiBoot版本依赖

配置参数列表

配置参数	参数介绍	默认值	是否必填
api.boot.sms.access-key-id	RAM账号的AccessKey ID	空	是
api.boot.sms.access-key-secret	RAM账号Access Key Secret	空	是
api.boot.sms.sign-name	短信签名	空	是
api.boot.sms.connection-timeout	短信发送连接超时时长	10000	否
api.boot.sms.read-timeout	短信接收消息连接超时时长	10000	否
api.boot.sms.profile	短信区域环境	default	否

发送短信

在ApiBoot Alibaba Sms模块内置了ApiBootSmsService接口实现类，通过send方法即可完成短信发送，如下所示：

        /**
     * logger instance
     */
    static Logger logger = LoggerFactory.getLogger(ApiBootSmsTest.class);

    @Autowired
    private ApiBootSmsService apiBootSmsService;

    @Test
    public void sendSms() {

        // 参数
        ApiBootSmsRequestParam param = new ApiBootSmsRequestParam();
        param.put("code", "192369");

        // 请求对象
        ApiBootSmsRequest request = ApiBootSmsRequest.builder().phone("171xxxxx").templateCode("SMS_150761253").param(param).build();

        // 发送短信
        ApiBootSmsResponse response = apiBootSmsService.send(request);
        logger.info("短信发送反馈，是否成功：{}", response.isSuccess());
    }

短信模板code自行从阿里云控制台获取。

如果在阿里云控制台定义的短信模板存在多个参数，可以通过ApiBootSmsRequestParam#put方法来进行挨个添加，该方法返回值为ApiBootSmsRequestParam本对象。

多参数

多参数调用如下所示：

// 参数
ApiBootSmsRequestParam param = new ApiBootSmsRequestParam();
param.put("code", "192369").put("name", "测试名称");

发送结果反馈

执行短信发送后会返回ApiBootSmsResponse实例，通过该实例即可判断短信是否发送成功。

本章源码地址：https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-alibaba-sms

云服务器 GPU云服务器 ApiBoot sms短信平台阿里巴巴 cdn使用文档 js使用文档

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/74057.html

ApiBoot - ApiBoot Alibaba Oss 使用文档

摘要：添加快速集成的对象存储服务，提供常用的文件操作方法，当然也提供自定义扩展，以致于满足绝大数业务场景，并且通过扩展可以实现上传文件进度条下载文件进度条存储空间操作静态网站托管访问日志防盗链分片上传追加上传断点续传等等。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服务集成基础框架，内部提供了框架的封装集成、使用扩展、自动化完成配置，让接口开发者可以选...

fengxiuping 2019-08-16 16:20 评论0 收藏0
ApiBoot 2.0.4.RELEASE版本发布

摘要：是一款基于的接口服务集成基础框架，内部提供了框架的封装集成，让接口开发者完成开箱即用，不再为搭建接口框架而犯愁，从而极大的提高开发效率。 ApiBoot是一款基于SpringBoot1.x、SpringBoot2.x的接口服务集成基础框架，内部提供了框架的封装集成，让接口开发者完成开箱即用，不再为搭建接口框架而犯愁，从而极大的提高开发效率。通过在我的SpringBoot系列教程中得到的...

JellyBool 2019-08-16 16:43 评论0 收藏0
ApiBoot - ApiBoot Swagger 使用文档

摘要：相关配置配置参数参数介绍默认值是否启用文档标题快速集成文档文档描述通过自动化配置快速集成文档，仅需一个注解一个依赖即可。注意通过所获取的类型都为。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服务集成基础框架，内部提供了框架的封装集成、使用扩展、自动化完成配置，让接口开发者可以选着性完成开箱即用，不再为搭建接口框架而犯愁，从而极大...

yuanxin 2019-08-16 16:20 评论0 收藏0
ApiBoot - ApiBoot Security Oauth 依赖使用文档

摘要：如果全部使用默认值的情况话不需要做任何配置方式前提项目需要添加数据源依赖。获取通过获取启用在使用格式化时非常简单的，配置如下所示开启转换转换时所需加密，默认为恒宇少年于起宇默认不启用，签名建议进行更换。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服务集成基础框架，内部提供了框架的封装集成、使用扩展、自动化完成配置，让接口开发者可以选着性完成开箱即...

Tonny 2019-08-16 16:20 评论0 收藏0
ApiBoot - ApiBoot Http Converter 使用文档

摘要：如下所示不配置默认使用自定义是的概念，用于自定义转换实现，比如自定义格式化日期自动截取小数点等。下面提供一个的简单示例，具体的使用请参考官方文档。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服务集成基础框架，内部提供了框架的封装集成、使用扩展、自动化完成配置，让接口开发者可以选着性完成开箱即用，不再为搭建接口框架而犯愁，从而极大...

dance 2019-08-16 16:20 评论0 收藏0