# Java | 样例 | [发送短信] [发送分批短信] [接收状态报告]、[接收上行短信] | |---|---| | **环境要求** | JDK 1.6及以上版本。 | | **引用库** | [httpclient](https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient)、[httpcore](https://mvnrepository.com/artifact/org.apache.httpcomponents/httpcore)、[commons-codec](https://mvnrepository.com/artifact/commons-codec/commons-codec)、[commons-logging](https://mvnrepository.com/artifact/commons-logging/commons-logging)、[org.json](https://mvnrepository.com/artifact/org.json/json) | ![](https://support.huaweicloud.com/devg-msgsms/public_sys-resources/notice_3.0-zh-cn.png) - 发送短信为单模板群发短信示例，发送分批短信为多模板群发短信示例。 - 本文档所述Demo在提供服务的过程中，可能会涉及个人数据的使用，建议您遵从国家的相关法律采取足够的措施，以确保用户的个人数据受到充分的保护。 - 本文档所述Demo仅用于功能演示，不允许客户直接进行商业使用。 - 本文档信息仅供参考，不构成任何要约或承诺。 #### 发送短信 ``` import java.io.BufferedReader; import java.io.InputStream; import java.io.InputStreamReader; import java.io.OutputStreamWriter; import java.io.UnsupportedEncodingException; import java.io.Writer; import java.net.URL; import java.net.URLEncoder; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import java.security.cert.CertificateException; import java.security.cert.X509Certificate; import java.text.SimpleDateFormat; //如果JDK版本是1.8,可使用原生Base64类 import java.util.Base64; import java.util.Date; import java.util.HashMap; import java.util.Map; import java.util.UUID; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.HttpsURLConnection; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLSession; import javax.net.ssl.TrustManager; import javax.net.ssl.X509TrustManager; //如果JDK版本低于1.8,请使用三方库提供Base64类 //import org.apache.commons.codec.binary.Base64; public class SendSms { //无需修改,用于格式化鉴权头域,给"X-WSSE"参数赋值 private static final String WSSE_HEADER_FORMAT = "UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\""; //无需修改,用于格式化鉴权头域,给"Authorization"参数赋值 private static final String AUTH_HEADER_VALUE = "WSSE realm=\"SDP\",profile=\"UsernameToken\",type=\"Appkey\""; public static void main(String[] args) throws Exception { //必填,请参考"开发准备"获取如下数据,替换为实际值 String url = "https://smsapi.cn-north-4.myhuaweicloud.com:443/sms/batchSendSms/v1"; //APP接入地址(在控制台"应用管理"页面获取)+接口访问URI // 认证用的appKey和appSecret硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全； String appKey = "c8RWg3ggEcyd4D3p94bf3Y7x1Ile"; //APP_Key String appSecret = "q4Ii87Bh************80SfD7Al"; //APP_Secret String sender = "csms12345678"; //国内短信签名通道号 String templateId = "8ff55eac1d0b478ab3c06c3c6a492300"; //模板ID //条件必填,国内短信关注,当templateId指定的模板类型为通用模板时生效且必填,必须是已审核通过的,与模板类型一致的签名名称 String signature = "华为云短信测试"; //签名名称 //必填,全局号码格式(包含国家码),示例:+8615123456789,多个号码之间用英文逗号分隔 String receiver = "+86151****6789,+86152****7890"; //短信接收人号码 //选填,短信状态报告接收地址,推荐使用域名,为空或者不填表示不接收状态报告 String statusCallBack = ""; /** * 选填,使用无变量模板时请赋空值 String templateParas = ""; * 单变量模板示例:模板内容为"您的验证码是${1}"时,templateParas可填写为"[\"369751\"]" * 双变量模板示例:模板内容为"您有${1}件快递请到${2}领取"时,templateParas可填写为"[\"3\",\"人民公园正门\"]" * 模板中的每个变量都必须赋值，且取值不能为空 * 查看更多模板规范和变量规范:产品介绍>短信模板须知和短信变量须知 */ String templateParas = "[\"369751\"]"; //模板变量，此处以单变量验证码短信为例，请客户自行生成6位验证码，并定义为字符串类型，以杜绝首位0丢失的问题（例如：002569变成了2569）。 //请求Body,不携带签名名称时,signature请填null String body = buildRequestBody(sender, receiver, templateId, templateParas, statusCallBack, signature); if (null == body || body.isEmpty()) { System.out.println("body is null."); return; } //请求Headers中的X-WSSE参数值 String wsseHeader = buildWsseHeader(appKey, appSecret); if (null == wsseHeader || wsseHeader.isEmpty()) { System.out.println("wsse header is null."); return; } Writer out = null; BufferedReader in = null; StringBuffer result = new StringBuffer(); HttpsURLConnection connection = null; InputStream is = null; HostnameVerifier hv = new HostnameVerifier() { @Override public boolean verify(String hostname, SSLSession session) { return true; } }; trustAllHttpsCertificates(); try { URL realUrl = new URL(url); connection = (HttpsURLConnection) realUrl.openConnection(); connection.setHostnameVerifier(hv); connection.setDoOutput(true); connection.setDoInput(true); connection.setUseCaches(true); //请求方法 connection.setRequestMethod("POST"); //请求Headers参数 connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); connection.setRequestProperty("Authorization", AUTH_HEADER_VALUE); connection.setRequestProperty("X-WSSE", wsseHeader); connection.connect(); out = new OutputStreamWriter(connection.getOutputStream()); out.write(body); //发送请求Body参数 out.flush(); out.close(); int status = connection.getResponseCode(); if (200 == status) { //200 is = connection.getInputStream(); } else { //400/401 is = connection.getErrorStream(); } in = new BufferedReader(new InputStreamReader(is, "UTF-8")); String line = ""; while ((line = in.readLine()) != null) { result.append(line); } System.out.println(result.toString()); //打印响应消息实体 } catch (Exception e) { e.printStackTrace(); } finally { try { if (null != out) { out.close(); } if (null != is) { is.close(); } if (null != in) { in.close(); } } catch (Exception e) { e.printStackTrace(); } } } /** * 构造请求Body体 * @param sender * @param receiver * @param templateId * @param templateParas * @param statusCallBack * @param signature | 签名名称,使用国内短信通用模板时填写 * @return */ static String buildRequestBody(String sender, String receiver, String templateId, String templateParas, String statusCallBack, String signature) { if (null == sender || null == receiver || null == templateId || sender.isEmpty() || receiver.isEmpty() || templateId.isEmpty()) { System.out.println("buildRequestBody(): sender, receiver or templateId is null."); return null; } Map map = new HashMap(); map.put("from", sender); map.put("to", receiver); map.put("templateId", templateId); if (null != templateParas && !templateParas.isEmpty()) { map.put("templateParas", templateParas); } if (null != statusCallBack && !statusCallBack.isEmpty()) { map.put("statusCallback", statusCallBack); } if (null != signature && !signature.isEmpty()) { map.put("signature", signature); } StringBuilder sb = new StringBuilder(); String temp = ""; for (String s : map.keySet()) { try { temp = URLEncoder.encode(map.get(s), "UTF-8"); } catch (UnsupportedEncodingException e) { e.printStackTrace(); } sb.append(s).append("=").append(temp).append("&"); } return sb.deleteCharAt(sb.length()-1).toString(); } /** * 构造X-WSSE参数值 * @param appKey * @param appSecret * @return */ static String buildWsseHeader(String appKey, String appSecret) { if (null == appKey || null == appSecret || appKey.isEmpty() || appSecret.isEmpty()) { System.out.println("buildWsseHeader(): appKey or appSecret is null."); return null; } SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'"); String time = sdf.format(new Date()); //Created String nonce = UUID.randomUUID().toString().replace("-", ""); //Nonce MessageDigest md; byte[] passwordDigest = null; try { md = MessageDigest.getInstance("SHA-256"); md.update((nonce + time + appSecret).getBytes()); passwordDigest = md.digest(); } catch (NoSuchAlgorithmException e) { e.printStackTrace(); } //如果JDK版本是1.8,请加载原生Base64类,并使用如下代码 String passwordDigestBase64Str = Base64.getEncoder().encodeToString(passwordDigest); //PasswordDigest //如果JDK版本低于1.8,请加载三方库提供Base64类,并使用如下代码 //String passwordDigestBase64Str = Base64.encodeBase64String(passwordDigest); //PasswordDigest //若passwordDigestBase64Str中包含换行符,请执行如下代码进行修正 //passwordDigestBase64Str = passwordDigestBase64Str.replaceAll("[\\s*\t\n\r]", ""); return String.format(WSSE_HEADER_FORMAT, appKey, passwordDigestBase64Str, nonce, time); } /*** @throws Exception */ static void trustAllHttpsCertificates() throws Exception { TrustManager[] trustAllCerts = new TrustManager[] { new X509TrustManager() { public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException { return; } public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException { return; } public X509Certificate[] getAcceptedIssuers() { return null; } } }; SSLContext sc = SSLContext.getInstance("SSL"); sc.init(null, trustAllCerts, null); HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); } } ``` #### 发送分批短信 ``` import java.io.BufferedReader; import java.io.InputStream; import java.io.InputStreamReader; import java.io.OutputStreamWriter; import java.io.Writer; import java.net.URL; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import java.security.cert.CertificateException; import java.security.cert.X509Certificate; import java.text.SimpleDateFormat; import java.util.ArrayList; //如果JDK版本是1.8,可使用原生Base64类 import java.util.Base64; import java.util.Date; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.UUID; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.HttpsURLConnection; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLSession; import javax.net.ssl.TrustManager; import javax.net.ssl.X509TrustManager; //如果JDK版本低于1.8,请使用三方库提供Base64类 //import org.apache.commons.codec.binary.Base64; import org.json.JSONArray; import org.json.JSONObject; public class SendDiffSms { //无需修改,用于格式化鉴权头域,给"X-WSSE"参数赋值 private static final String WSSE_HEADER_FORMAT = "UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\""; //无需修改,用于格式化鉴权头域,给"Authorization"参数赋值 private static final String AUTH_HEADER_VALUE = "WSSE realm=\"SDP\",profile=\"UsernameToken\",type=\"Appkey\""; public static void main(String[] args) throws Exception { //必填,请参考"开发准备"获取如下数据,替换为实际值 String url = "https://smsapi.cn-north-4.myhuaweicloud.com:443/sms/batchSendDiffSms/v1"; //APP接入地址(在控制台"应用管理"页面获取)+接口访问URI // 认证用的appKey和appSecret硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全； String appKey = "c8RWg3ggEcyd4D3p94bf3Y7x1Ile"; //APP_Key String appSecret = "q4Ii87Bh************80SfD7Al"; //APP_Secret String sender = "csms12345678"; //国内短信签名通道号 String templateId1 = "8ff55eac1d0b478ab3c06c3c6a492300"; //模板ID1 String templateId2 = "8ff55eac1d0b478ab3c06c3c6a492300"; //模板ID2 //条件必填,国内短信关注,当templateId指定的模板类型为通用模板时生效且必填,必须是已审核通过的,与模板类型一致的签名名称 String signature1 = "华为云短信测试"; //签名名称1 String signature2 = "华为云短信测试"; //签名名称2 //必填,全局号码格式(包含国家码),示例:+8615123456789,多个号码之间用英文逗号分隔 String[] receiver1 = {"+86151****6789", "+86152****7890"}; //模板1的接收号码 String[] receiver2 = {"+86151****6789", "+86152****7890"}; //模板2的接收号码 //选填,短信状态报告接收地址,推荐使用域名,为空或者不填表示不接收状态报告 String statusCallBack = ""; /** * 选填,使用无变量模板时请赋空值 String[] templateParas = {}; * 单变量模板示例:模板内容为"您的验证码是${1}"时,templateParas可填写为{"369751"} * 双变量模板示例:模板内容为"您有${1}件快递请到${2}领取"时,templateParas可填写为{"3","人民公园正门"} * ${DATE}${TIME}变量不允许取值为空,${TXT_20}变量可以使用英文空格或点号替代空值,${NUM_6}变量可以使用0替代空值 * 查看更多模板规范和变量规范:产品介绍>短信模板须知和短信变量须知 */ String[] templateParas1 = {"123456"}; //模板1变量，此处以单变量验证码短信为例，请客户自行生成6位验证码，并定义为字符串类型，以杜绝首位0丢失的问题（例如：002569变成了2569）。 String[] templateParas2 = {"234567"}; //模板2变量，此处以单变量验证码短信为例，请客户自行生成6位验证码，并定义为字符串类型，以杜绝首位0丢失的问题（例如：002569变成了2569）。 //smsContent,不携带签名名称时,signature请填null List> smsContent = new ArrayList>(); Map item1 = initDiffSms(receiver1, templateId1, templateParas1, signature1); Map item2 = initDiffSms(receiver2, templateId2, templateParas2, signature2); if (null != item1 && !item1.isEmpty()) { smsContent.add(item1); } if (null != item2 && !item2.isEmpty()) { smsContent.add(item2); } //请求Body String body = buildRequestBody(sender, smsContent, statusCallBack); if (null == body || body.isEmpty()) { System.out.println("body is null."); return; } //请求Headers中的X-WSSE参数值 String wsseHeader = buildWsseHeader(appKey, appSecret); if (null == wsseHeader || wsseHeader.isEmpty()) { System.out.println("wsse header is null."); } Writer out = null; BufferedReader in = null; StringBuffer result = new StringBuffer(); HttpsURLConnection connection = null; InputStream is = null; HostnameVerifier hv = new HostnameVerifier() { @Override public boolean verify(String hostname, SSLSession session) { return true; } }; trustAllHttpsCertificates(); try { URL realUrl = new URL(url); connection = (HttpsURLConnection) realUrl.openConnection(); connection.setHostnameVerifier(hv); connection.setDoOutput(true); connection.setDoInput(true); connection.setUseCaches(true); //请求方法 connection.setRequestMethod("POST"); //请求Headers参数 connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Authorization", AUTH_HEADER_VALUE); connection.setRequestProperty("X-WSSE", wsseHeader); connection.connect(); out = new OutputStreamWriter(connection.getOutputStream()); out.write(body); //发送请求Body参数 out.flush(); out.close(); int status = connection.getResponseCode(); if (200 == status) { //200 is = connection.getInputStream(); } else { //400/401 is = connection.getErrorStream(); } in = new BufferedReader(new InputStreamReader(is, "UTF-8")); String line = ""; while ((line = in.readLine()) != null) { result.append(line); } System.out.println(result.toString()); //打印响应消息实体 } catch (Exception e) { e.printStackTrace(); } finally { try { if (null != out) { out.close(); } if (null != is) { is.close(); } if (null != in) { in.close(); } } catch (Exception e) { e.printStackTrace(); } } } /** * 构造smsContent参数值 * @param receiver * @param templateId * @param templateParas * @param signature | 签名名称,使用国内短信通用模板时填写 * @return */ static Map initDiffSms(String[] receiver, String templateId, String[] templateParas, String signature) { if (null == receiver || null == templateId || receiver.length == 0 || templateId.isEmpty()) { System.out.println("initDiffSms(): receiver or templateId is null."); return null; } Map map = new HashMap(); map.put("to", receiver); map.put("templateId", templateId); if (null != templateParas && templateParas.length > 0) { map.put("templateParas", templateParas); } if (null != signature && !signature.isEmpty()) { map.put("signature", signature); } return map; } /** * 构造请求Body体 * @param sender * @param smsContent * @param statusCallBack * @return */ static String buildRequestBody(String sender, List> smsContent, String statusCallBack) { if (null == sender || null == smsContent || sender.isEmpty() || smsContent.isEmpty()) { System.out.println("buildRequestBody(): sender or smsContent is null."); return null; } JSONArray jsonArr = new JSONArray(); for(Map it: smsContent){ jsonArr.put(it); } Map data = new HashMap(); data.put("from", sender); data.put("smsContent", jsonArr); if (null != statusCallBack && !statusCallBack.isEmpty()) { data.put("statusCallback", statusCallBack); } return new JSONObject(data).toString(); } static String buildWsseHeader(String appKey, String appSecret) { if (null == appKey || null == appSecret || appKey.isEmpty() || appSecret.isEmpty()) { System.out.println("buildWsseHeader(): appKey or appSecret is null."); return null; } SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'"); String time = sdf.format(new Date()); //Created String nonce = UUID.randomUUID().toString().replace("-", ""); //Nonce MessageDigest md; byte[] passwordDigest = null; try { md = MessageDigest.getInstance("SHA-256"); md.update((nonce + time + appSecret).getBytes()); passwordDigest = md.digest(); } catch (NoSuchAlgorithmException e) { e.printStackTrace(); } //如果JDK版本是1.8,请加载原生Base64类,并使用如下代码 String passwordDigestBase64Str = Base64.getEncoder().encodeToString(passwordDigest); //PasswordDigest //如果JDK版本低于1.8,请加载三方库提供Base64类,并使用如下代码 //String passwordDigestBase64Str = Base64.encodeBase64String(passwordDigest); //PasswordDigest //若passwordDigestBase64Str中包含换行符,请执行如下代码进行修正 //passwordDigestBase64Str = passwordDigestBase64Str.replaceAll("[\\s*\t\n\r]", ""); return String.format(WSSE_HEADER_FORMAT, appKey, passwordDigestBase64Str, nonce, time); } /** * @throws Exception */ static void trustAllHttpsCertificates() throws Exception { TrustManager[] trustAllCerts = new TrustManager[] { new X509TrustManager() { public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException { return; } public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException { return; } public X509Certificate[] getAcceptedIssuers() { return null; } } }; SSLContext sc = SSLContext.getInstance("SSL"); sc.init(null, trustAllCerts, null); HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); } } ``` #### 接收状态报告 需要引入的maven依赖为：org.springframework:spring-web:5.3.21（样例版本） ``` import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; @RestController public class DemoController { /** * 同步短信回执 */ @PostMapping("/report") public void smsHwReport(@RequestParam String smsMsgId, //发送短信成功时返回的短信唯一标识。 @RequestParam(required = false) String total, //长短信拆分后的短信条数。当短信未拆分时该参数取值为1。 @RequestParam(required = false) String sequence, //长短信拆分后的短信序号，当total参数取值大于1时，该参数才有效。当短信未拆分时该参数取值为1。 @RequestParam String status, //短信状态报告枚举值，常见取值请参考“API参考” @RequestParam(required = false) String source, //短信状态报告来源：1：短信平台自行产生的状态报告。2：短信中心返回的状态报告。3：华为平台产生的状态报告。 @RequestParam(required = false) String updateTime,//短信资源的更新时间，通常为短信平台接收短信状态报告的时间，为UTC时间，格式为：yyyy-MM-dd'T'HH:mm:ss'Z'，该时间会通过urlencode转义为%3a。//当短信平台未收到短信中心上报的状态报告时，会自行构造状态报告，该状态报告中不携带“updateTime”参数。 @RequestParam(required = false) String orgCode, //透传南向网元状态码，仅国际/港澳台短信状态报告携带，国内短信不涉及。//当南向网元未返回状态码时不携带该参数。 @RequestParam(required = false) String extend, //扩展字段，由用户在发送短信的请求中携带。若用户发送短信时未携带extend参数，则状态报告中也不会携带extend参数。 @RequestParam(required = false) String to) { //本条状态报告对应的短信的接收方号码，仅当状态报告中携带了extend参数时才会同时携带该参数。 System.out.println(" ================receive smsStatusReport ======================"); System.out.println("smsMsgId: " + smsMsgId); System.out.println("total: " + total); System.out.println("sequence: " + sequence); System.out.println("status: " + status); System.out.println("source: " + source); System.out.println("updateTime: " + updateTime); System.out.println("orgCode: " + orgCode); System.out.println("extend: " + extend); System.out.println("to: " + to); } } ``` #### 接收上行短信 需要引入的maven依赖为：org.springframework:spring-web:5.3.21（样例版本） ``` import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.bind.annotation.PostMapping; @RestController public class DemoController { /* * @param smsMsgId 上行短信的唯一标识。 * @param from 上行短信发送方的号码。 * @param to 上行短信接收方的号码。 * @param body 上行短信发送的内容。 * @param createTime //上行短信创建时间，即短信平台接收到用户发送的上行短信的时间（采用标准UTC格式，例如：2018-02-12T15:30:20Z。不同编程语言中的时间格式转换方式不同，部分语言可参考表 不同编程语言的时间格式）。 * //在控制台创建应用时配置需要“接收上行短信回复时间”后，平台才会在Body中附带此字段，该字段只对http协议的短信生效。 */ @PostMapping("/upSMS") public void receiveHwSms(@RequestParam String smsMsgId, @RequestParam String from, @RequestParam String to, @RequestParam String body, @RequestParam(required = false) String createTime) { System.out.println(" ================receive upSMS ======================"); // 打印上面的RequestParam System.out.println(" smsMsgId: " + smsMsgId); System.out.println(" from: " + from); System.out.println(" to: " + to); System.out.println(" body: " + body); System.out.println(" createTime: " + createTime); } } ``` #### 相关推荐 | 相关文档 | 相关产品 | |:---|:---| | - 代码样例：[PHP](https://support.huaweicloud.com/devg-msgsms/sms_04_0003.html)/[Python](https://support.huaweicloud.com/devg-msgsms/sms_04_0004.html)/[C#](https://support.huaweicloud.com/devg-msgsms/sms_04_0005.html)/[Node.js](https://support.huaweicloud.com/devg-msgsms/sms_04_0008.html)/[Go](https://support.huaweicloud.com/devg-msgsms/sms_04_0012.html) - [发送短信API](https://support.huaweicloud.com/api-msgsms/sms_05_0001.html) - [发送分批短信API](https://support.huaweicloud.com/api-msgsms/sms_05_0002.html) - [接收状态报告API](https://support.huaweicloud.com/api-msgsms/sms_05_0003.html) - [接收上行短信API](https://support.huaweicloud.com/api-msgsms/sms_05_0004.html) - [调测问题处理](https://support.huaweicloud.com/api-msgsms/sms_05_0050.html) | [语音通话](https://www.huaweicloud.com/product/voice.html) [隐私保护通话](https://www.huaweicloud.com/product/privatenumber.html) |