网易云信短信发送

最新推荐文章于 2022-12-23 14:17:31 发布

Henry_Lin_Wind

最新推荐文章于 2022-12-23 14:17:31 发布

阅读量2.9k

点赞数 1

分类专栏：第三方接口文章标签：网易云通信短信发送

本文链接：https://blog.csdn.net/Henry_Lin_Wind/article/details/88190605

版权

第三方接口专栏收录该内容

1 篇文章

订阅专栏

1、账号申请

通过网易云通信平台发短信，需要几个重要的参数。Appkey，Appsecret 需要申请，新建模板以及签名

申请网易云账号：https://app.yunxin.163.com/index?clueFrom=nim&from=nim#/

（1）、申请成功后，务必申请AppKey和AppSecret。

（2）、申请短信模板，由于通知类和运营类的模板必须申请签名才能使用。个人测试可以申请验证类的短信模板。

（3）、官方短信接入示例：

https://dev.yunxin.163.com/docs/product/%E7%9F%AD%E4%BF%A1/%E7%9F%AD%E4%BF%A1%E6%8E%A5%E5%85%A5%E7%A4%BA%E4%BE%8B

2、接口开发

在完成账号申请以及相关设置后，接下来正式开发

（1）、先创建一个校验码生成类，用于计算并生成checkSum

public class CheckSumBuilder {

    //计算并获取checkSum
    public static String getCheckSum(String appSecret,String nonce,String curTime){
        return encode("SHA",appSecret+nonce+curTime);
    }

    private static String encode(String algorithm,String value){
        if(value==null){
            return null;
        }

        try {
            MessageDigest messageDigest=MessageDigest.getInstance(algorithm);
            messageDigest.update(value.getBytes());
            return getFormattedText(messageDigest.digest());
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    private static String getFormattedText(byte[] bytes){
        int len=bytes.length;
        StringBuilder sb=new StringBuilder(len*2);
        for(int $i=0;$i<len;$i++){
            sb.append(HEX_DIGITS[(bytes[$i]>>4)&0x0f]);
            sb.append(HEX_DIGITS[bytes[$i]&0x0f]);
        }
        return sb.toString();
    }

    private static final char[] HEX_DIGITS={'0','1','2','3','4','5','6',
            '7','8','9','a','b','c','d','e','f'};

}

（2）、创建发送类，填写对应的发送参数：Appkey，Appsecret，电话号码，短信模板，请求路径URL

通知类短信，请求的URL（https://api.netease.im/sms/sendtemplate.action ）
运营类短信，请求的URL（https://api.netease.im/sms/sendtemplate.action ）
验证码短信，请求的URL（https://api.netease.im/sms/sendcode.action ）

通知类短信和运营类短信的请求url都是https://api.netease.im/sms/sendtemplate.action，而验证码短信请求的url 是https://api.netease.im/sms/sendcode.action 。验证类的短信的验证码是由系统自动生成，然后返回给请求者，而不是请求者自己生成。

A。通知类短信和运营类短信的发送

package com.netease.code;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

import org.apache.http.HttpResponse;
import org.apache.http.NameValuePair;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;

/**
 * 发送模板短信请求
 * @author liuxuanlin
 *
 */
public class SendCode {
    //发送验证码的请求路径URL
    private static final String
            SERVER_URL="https://api.netease.im/sms/sendtemplate.action";
    //网易云信分配的账号，请替换你在管理后台应用下申请的Appkey
    private static final String
            APP_KEY="fd460d34e786e7754e505bc4fab0f027";
    //网易云信分配的密钥，请替换你在管理后台应用下申请的appSecret
    private static final String APP_SECRET="xxxxxxxx";
    //随机数
    private static final String NONCE="123456";
    //短信模板ID
    private static final String TEMPLATEID="3057527";
    //手机号，接收者号码列表，JSONArray格式，限制接收者号码个数最多为100个
    private static final String MOBILES="['13888888888','13666666666']";
    //短信参数列表，用于依次填充模板，JSONArray格式，每个变量长度不能超过30字,对于不包含变量的模板，不填此参数表示模板即短信全文内容
    private static final String PARAMS="['xxxx','xxxx']";

    public static void main(String[] args) throws Exception {

        DefaultHttpClient httpClient = new DefaultHttpClient();
        HttpPost httpPost = new HttpPost(SERVER_URL);
        String curTime = String.valueOf((new Date()).getTime() / 1000L);
        /*
         * 参考计算CheckSum的java代码，在上述文档的参数列表中，有CheckSum的计算文档示例
         */
        String checkSum = CheckSumBuilder.getCheckSum(APP_SECRET, NONCE, curTime);

        // 设置请求的header
        httpPost.addHeader("AppKey", APP_KEY);
        httpPost.addHeader("Nonce", NONCE);
        httpPost.addHeader("CurTime", curTime);
        httpPost.addHeader("CheckSum", checkSum);
        httpPost.addHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");

        // 设置请求的的参数，requestBody参数
        List<NameValuePair> nvps = new ArrayList<NameValuePair>();
        /*
         * 1.如果是模板短信，请注意参数mobile是有s的，详细参数配置请参考“发送模板短信文档”
         * 2.参数格式是jsonArray的格式，例如 "['13888888888','13666666666']"
         * 3.params是根据你模板里面有几个参数，那里面的参数也是jsonArray格式
         */
        nvps.add(new BasicNameValuePair("templateid", TEMPLATEID));
        nvps.add(new BasicNameValuePair("mobiles", MOBILES));
        nvps.add(new BasicNameValuePair("params", PARAMS));

        httpPost.setEntity(new UrlEncodedFormEntity(nvps, "utf-8"));

        // 执行请求
        HttpResponse response = httpClient.execute(httpPost);
        /*
         * 1.打印执行结果，打印结果一般会200、315、403、404、413、414、500
         * 2.具体的code有问题的可以参考官网的Code状态表
         */
        System.out.println(EntityUtils.toString(response.getEntity(), "utf-8"));

    }
}

网易云通信的通知类接口返回格式如下：

{"code":200,"msg":"sendid","obj":29006} 发送成功

{"code":404,"msg":"template id not exist"} 发送失败

成功则在obj中返回此次发送的sendid(long),用于查询发送结果

B。验证码短信的发送（与其他类相比主要是新增了验证码长度、取消了参数以及请求路径url的不同）

    //发送验证码的请求路径URL
    private static final String SERVER_URL="https://api.netease.im/sms/sendcode.action";
    //网易云信分配的账号，请替换你在管理后台应用下申请的Appkey
    private static final String APP_KEY="";
    //网易云信分配的密钥，请替换你在管理后台应用下申请的appSecret
    private static final String APP_SECRET="";
    //随机数
    private static final String NONCE="123456";
    //短信模板ID
    private static final String TEMPLATEID="9771234";
    //手机号，接收者号码列表，JSONArray格式，限制接收者号码个数最多为100个 
    private static final String MOBILE="13800138000";
    //短信参数列表，用于依次填充模板，JSONArray格式，每个变量长度不能超过30字,对于不包含变量的模板，不填此参数表示模板即短信全文内容 
    private static final String CODELEN="6";//验证码长度

    public static void main(String[] args) throws Exception {
        DefaultHttpClient httpClient = new DefaultHttpClient();
        HttpPost httpPost = new HttpPost(SERVER_URL);
        String curTime = String.valueOf((new Date()).getTime() / 1000L);    
        String checkSum = CheckSumBuilder.getCheckSum(APP_SECRET, NONCE, curTime);
        // 设置请求的header
        httpPost.addHeader("AppKey", APP_KEY);
        httpPost.addHeader("Nonce", NONCE);
        httpPost.addHeader("CurTime", curTime);
        httpPost.addHeader("CheckSum", checkSum);
        httpPost.addHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");

        // 设置请求的的参数，requestBody参数
        List<NameValuePair> nvps = new ArrayList<NameValuePair>();
        /*
         * 1.如果是模板短信，请注意参数mobile是有s的，详细参数配置请参考“发送模板短信文档”
         * 2.参数格式是jsonArray的格式，例如 "['13888888888','13666666666']"
         * 3.params是根据你模板里面有几个参数，那里面的参数也是jsonArray格式
         */
        nvps.add(new BasicNameValuePair("templateid", TEMPLATEID));
        nvps.add(new BasicNameValuePair("mobile", MOBILE));//验证码类
        nvps.add(new BasicNameValuePair("codeLen", CODELEN));
        httpPost.setEntity(new UrlEncodedFormEntity(nvps, "utf-8"));
        // 执行请求
        HttpResponse response = httpClient.execute(httpPost);
        /*
         * 1.打印执行结果，打印结果一般会200、315、403、404、413、414、500
         * 2.具体的code有问题的可以参考官网的Code状态表
         */
        System.out.println(EntityUtils.toString(response.getEntity(), "utf-8"));


    }

网易云通信的验证类接口返回格式如下：

{"code":200,"msg":"4","obj":"906224"}

{"code":414,"msg":"checksum"}

code表示发送状态，msg字段表示此次发送的sendid，即该账号发的第四条短信（失败则表示失败原因）；obj字段表示此次发送的验证码

附：为了更好的处理接口返回的数据，我个人使用谷歌的Gson来转换接口数据。Gson是Google公司发布的一个开放源代码的Java库，主要用途为序列化Java对象为JSON字符串，或反序列化JSON字符串成Java象

Gson gson = new Gson();
String responseEntity = EntityUtils.toString(response.getEntity(), "utf-8");
System.out.println(responseEntity);
NeteaseResponse res = gson.fromJson(responseEntity, NeteaseResponse.class);

NeteaseResponse 是我建立的POJO类m，根据接口的格式和内容来设计。

public class NeteaseResponse {
    public String code;
    public String msg;
    public int obj;
    public String getCode() {
        return code;
    }
    public void setCode(String code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public int getObj() {
        return obj;
    }
    public void setObj(int obj) {
        this.obj = obj;
    }

}

这样就可以根据接口的返回结果来做出相应的处理。

  if (res.getCode().equals("200")){
      System.out.println("发送成功");
      System.out.println("验证码："+res.getObj());
  }else{
      System.out.println("发送失败：" + res.getMsg());
      System.out.println("错误代码："+res.getCode());
   }

生成短信日志时用到字符串的提取和替换，可以参考我的博客 https://blog.csdn.net/Henry_Lin_Wind/article/details/88639535