ApiBoot - ApiBoot Alibaba Sms 使用文檔

cheng10 發布于2019-08-16 16:20 / 762人閱讀

摘要：的短信服務模塊是由阿里云的國際短信服務提供的，支持國內和國際快速發送驗證碼短信通知和推廣短信。前提需要到阿里云控制臺申請開通短信服務。如果在阿里云控制臺定義的短信模板存在多個參數，可以通過方法來進行挨個添加，該方法返回值為本對象。

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使用文檔

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/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