短信接口——阿里云短信接口


代码下载链接: 阿里云短信接口示例代码及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;
    }
}

以上就是阿里云短信接口调用的示例,要调用阿里云短信接口除了这两个代码,还有很多其他也可以实现的代码,这里就不一一展示。本次测试对应代码可以在相应的连接中下载。

发布了104 篇原创文章 · 获赞 58 · 访问量 7521

猜你喜欢

转载自blog.csdn.net/baidu_27414099/article/details/104439702