短信接口——阿里雲短信接口


代碼下載鏈接:阿里雲短信接口示例代碼及jar包

一、阿里雲短信接口

1、註冊阿里雲

(1)註冊登錄阿里雲
阿里雲官網地址如下:
https://www.aliyun.com/?spm=5176.12825654.amxosvpfn.1.1dfb2c4au3gKDP
在這裏插入圖片描述
進入阿里雲首頁後,需要註冊自己的賬號,已有帳號的可以直接登錄,組要注意的是賬號需要完成實名認證。

(2)進入短信服務
根據下面的操作進入短信服務
在這裏插入圖片描述
點擊免費開通即可開通短信服務
在這裏插入圖片描述

(3)設置短信簽名和短信模板
設置短信簽名和短信模板後,都要等系統審覈,通過之後才能使用。
短信簽名
在這裏插入圖片描述
短信模板
在這裏插入圖片描述

(4)獲取 ACCESS_KEY_IDACCESS_KEY_SECRET
點擊Accesskey進入獲取的頁面
在這裏插入圖片描述
點擊創建Accesskey沒然後根據提示完成創建申請
在這裏插入圖片描述
到此,阿里雲短信接口的準備工作就已經完成,可以編寫代碼完成接口的調用。

2、代碼實現調用接口

(1)創建一個項目
創建項目可以創建普通的java項目也可以創建maven項目,創建普通的項目就需要手動將需要的jar包添加到項目中,創建maven等項目則可以在pom文件中添加依賴完成jar包的自動導入。
這裏就以簡單的java項目爲例
在這裏插入圖片描述

(2)阿里雲短信接口依賴
在項目的pom.xml文件中添加阿里雲短信接口依賴。

<!--短信接口阿里雲依賴-->
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <version>4.0.3</version>
</dependency>
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-dysmsapi</artifactId>
    <version>1.1.0</version>
</dependency>

(3)JAVA 代碼
這裏使用了兩種方式來調用阿里雲的接口,第一種是在阿里雲官方API上面下載的Demo,經過稍微修改直接可以測試,具體代碼如下:

/**
 * 短信API產品的DEMO程序,工程中包含了一個SmsDemo類,直接通過
 * 執行main函數即可體驗短信產品API功能(只需要將AK替換成開通了雲通信-短信產品功能的AK即可)
 * 工程依賴了2個jar包(存放在工程的libs目錄下)
 * 1:aliyun-java-sdk-core.jar
 * 2:aliyun-java-sdk-dysmsapi.jar
 *
 */
public class SmsDemo {

    //產品名稱:雲通信短信API產品,開發者無需替換
    static final String product = "Dysmsapi";
    //產品域名,開發者無需替換
    static final String domain = "dysmsapi.aliyuncs.com";

    // TODO 此處需要替換成開發者自己的AK(在阿里雲訪問控制檯尋找)
    static final String accessKeyId = "***********";
    static final String accessKeySecret = "***********";
    //短信驗證碼
    private static String codes ;

    /**
     * 調用發送短信
     * @return
     * @throws ClientException
     */
    public static void main(String[] args) throws ClientException, InterruptedException {

        //發短信
        SendSmsResponse response = sendSms();
        System.out.println("短信接口返回的數據----------------");
        System.out.println("Code=" + response.getCode());
        System.out.println("Message=" + response.getMessage());
        System.out.println("RequestId=" + response.getRequestId());
        System.out.println("BizId=" + response.getBizId());

        Thread.sleep(3000L);

        //查明細
        if(response.getCode() != null && response.getCode().equals("OK")) {
            QuerySendDetailsResponse querySendDetailsResponse = querySendDetails(response.getBizId());
            System.out.println("短信明細查詢接口返回數據----------------");
            System.out.println("Code=" + querySendDetailsResponse.getCode());
            System.out.println("Message=" + querySendDetailsResponse.getMessage());
            int i = 0;
            for(QuerySendDetailsResponse.SmsSendDetailDTO smsSendDetailDTO : querySendDetailsResponse.getSmsSendDetailDTOs())
            {
                System.out.println("SmsSendDetailDTO["+i+"]:");
                System.out.println("Content=" + smsSendDetailDTO.getContent());
                System.out.println("ErrCode=" + smsSendDetailDTO.getErrCode());
                System.out.println("OutId=" + smsSendDetailDTO.getOutId());
                System.out.println("PhoneNum=" + smsSendDetailDTO.getPhoneNum());
                System.out.println("ReceiveDate=" + smsSendDetailDTO.getReceiveDate());
                System.out.println("SendDate=" + smsSendDetailDTO.getSendDate());
                System.out.println("SendStatus=" + smsSendDetailDTO.getSendStatus());
                System.out.println("Template=" + smsSendDetailDTO.getTemplateCode());
            }
            System.out.println("TotalCount=" + querySendDetailsResponse.getTotalCount());
            System.out.println("RequestId=" + querySendDetailsResponse.getRequestId());
        }

    }

    /**
     * 發送短信
     * @return
     * @throws ClientException
     */
    public static SendSmsResponse sendSms() throws ClientException {

        //可自助調整超時時間
        System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
        System.setProperty("sun.net.client.defaultReadTimeout", "10000");

        //初始化acsClient,暫不支持region化
        IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
        DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
        IAcsClient acsClient = new DefaultAcsClient(profile);
		
		/*獲取驗證碼*/
        codes = vcode();
        
        //組裝請求對象-具體描述見控制檯-文檔部分內容
        SendSmsRequest request = new SendSmsRequest();
        //必填:待發送手機號
        request.setPhoneNumbers("***********");
        //必填:短信簽名-可在短信控制檯中找到
        request.setSignName("***********");
        //必填:短信模板-可在短信控制檯中找到
        request.setTemplateCode("***********");
        //可選:模板中的變量替換JSON串,如模板內容爲"您的驗證碼爲${code}"時,此處的值爲
        request.setTemplateParam("{ \"code\":\""+codes+"\"}");

        //選填-上行短信擴展碼(無特殊需求用戶請忽略此字段)
        //request.setSmsUpExtendCode("90997");

        //可選:outId爲提供給業務方擴展字段,最終在短信回執消息中將此值帶回給調用者
        request.setOutId("yourOutId");

        //hint 此處可能會拋出異常,注意catch
        SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);

        return sendSmsResponse;
    }


    public static QuerySendDetailsResponse querySendDetails(String bizId) throws ClientException {

        //可自助調整超時時間
        System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
        System.setProperty("sun.net.client.defaultReadTimeout", "10000");

        //初始化acsClient,暫不支持region化
        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("15000000000");
        //可選-流水號
        request.setBizId(bizId);
        //必填-發送日期 支持30天內記錄查詢,格式yyyyMMdd
        SimpleDateFormat ft = new SimpleDateFormat("yyyyMMdd");
        request.setSendDate(ft.format(new Date()));
        //必填-頁大小
        request.setPageSize(10L);
        //必填-當前頁碼從1開始計數
        request.setCurrentPage(1L);

        //hint 此處可能會拋出異常,注意catch
        QuerySendDetailsResponse querySendDetailsResponse = acsClient.getAcsResponse(request);

        return querySendDetailsResponse;
    }
    
	/**
     * 生成6位隨機數驗證碼
     * @return
     */
    public static String vcode(){
        String vcode = "";
        for (int i = 0; i < 6; i++) {
            vcode = vcode + (int)(Math.random() * 9);
        }
        return vcode;
    }
}

代碼中的accessKeyId、 accessKeySecret、電話號碼、短信簽名和短信模板,我已經使用***********替換,實際使用中需要根據自己申請的key以及電話號碼等替換即可。
修改相應的代碼,然後運行main函數即可得到驗證碼。

第二種:根據官方API的示例代碼做了相應的修改,大致代碼雷同。

public class Test {
    /**
     * 手機驗證部分配置,設置超時時間-可自行調整
     */
    final static String DEFAULT_CONNECT_TIMEOUT = "sun.net.client.defaultConnectTimeout";
    final static String DEFAULT_READ_TIMEOUT = "sun.net.client.defaultReadTimeout";
    final static String TIMEOUT = "10000";
    /* 初始化ascClient需要的幾個參數*/
    /**
     * 短信API產品名稱(短信產品名固定,無需修改)
     */
    final static String PRODUCT = "Dysmsapi";
    /**
     * 短信API產品域名(接口地址固定,無需修改)
     */
    final static String DOMAIN = "dysmsapi.aliyuncs.com";
    /**
     * 你的accessKeyId,填你自己的 上文配置所得  自行配置
     */
    final static String ACCESS_KEY_ID = "***********";
    /**
     * 你的accessKeySecret,填你自己的 上文配置所得 自行配置
     */
    final static String ACCESS_KEY_SECRET = "***********";
    /**
     * 短信簽名-可在短信控制檯中找到你自己的短信簽名填入
     */
    final static String SIGN_NAME = "***********";
    /**
     * 必填:短信模板-可在短信控制檯中找到你自己的短信模板填入
     */
    final static String TEMPLATE_CODE = "***********";
    private static String code ;

    /**
     * 短信接口
     * @return
     * @throws Exception
     */
    public String msgInterface()throws Exception{
        /*此處可輸入你的手機號碼進行測試*/
        String mobile = "***********";
        /*進行正則關係校驗*/
        if (mobile == null || mobile == "") {
            System.out.println("手機號爲空");
            return "";
        }
        /**
         * 短信驗證---阿里大於工具
         */

         /*設置超時時間-可自行調整*/
        System.setProperty(DEFAULT_CONNECT_TIMEOUT, TIMEOUT);
        System.setProperty(DEFAULT_READ_TIMEOUT, TIMEOUT);
         /*初始化ascClient,暫時不支持多region*/
        IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", ACCESS_KEY_ID, ACCESS_KEY_SECRET);
        try {
            DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", PRODUCT, DOMAIN);
        } catch (ClientException e1) {
            e1.printStackTrace();
        }

        /*獲取驗證碼*/
        code = vcode();

        IAcsClient acsClient = new DefaultAcsClient(profile);
         /*組裝請求對象*/
        SendSmsRequest request = new SendSmsRequest();
         /*使用post提交*/
        request.setMethod(MethodType.POST);
         /*必填:待發送手機號。支持以逗號分隔的形式進行批量調用,批量上限爲1000個手機號碼,
         批量調用相對於單條調用及時性稍有延遲,驗證碼類型的短信推薦使用單條調用的方式*/
        request.setPhoneNumbers(mobile);
         /*必填:短信簽名-可在短信控制檯中找到*/
        request.setSignName(SIGN_NAME);
         /*必填:短信模板-可在短信控制檯中找到*/
        request.setTemplateCode(TEMPLATE_CODE);
         /*可選:模板中的變量替換JSON串,如模板內容爲"親愛的${name},您的驗證碼爲${code}"時,此處的值爲
         友情提示:如果JSON中需要帶換行符,請參照標準的JSON協議對換行符的要求,
         比如短信內容中包含\r\n的情況在JSON中需要表示成\\r\\n,否則會導致JSON在服務端解析失敗*/
        request.setTemplateParam("{ \"code\":\""+code+"\"}");
         /*可選-上行短信擴展碼(無特殊需求用戶請忽略此字段)*/
         /*request.setSmsUpExtendCode("90997");*/
         /*可選:outId爲提供給業務方擴展字段,最終在短信回執消息中將此值帶回給調用者*/
        /*request.setOutId("yourOutId");*/
         /*請求失敗這裏會拋ClientException異常*/
        SendSmsResponse sendSmsResponse;
        try {
            sendSmsResponse = acsClient.getAcsResponse(request);
            if (sendSmsResponse.getCode() != null && sendSmsResponse.getCode().equals("OK")) {
                 /*請求成功*/
                System.out.println("獲取驗證碼成功!!!");
            } else {
                /*如果驗證碼出錯,會輸出錯誤碼告訴你具體原因*/
                System.out.println(sendSmsResponse.getCode());
                System.out.println("獲取驗證碼失敗...");
            }
        } catch (ServerException e) {
            e.printStackTrace();
            return "由於系統維護,暫時無法註冊!!!";
        } catch (ClientException e) {
            e.printStackTrace();
            return "由於系統維護,暫時無法註冊!!!";
        }
        return "true";
    }

    /**
     * 生成6位隨機數驗證碼
     * @return
     */
    public static String vcode(){
        String vcode = "";
        for (int i = 0; i < 6; i++) {
            vcode = vcode + (int)(Math.random() * 9);
        }
        return vcode;
    }
}

以上就是阿里雲短信接口調用的示例,要調用阿里雲短信接口除了這兩個代碼,還有很多其他也可以實現的代碼,這裏就不一一展示。本次測試對應代碼可以在相應的連接中下載。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章