发送短信接口(SendSms)
主要适用于短信单发场景,特殊场景下可支持群发(最多可向1000个手机号码发送同样内容的短信),但群发会有一定延迟。
步骤1:创建阿里云账号
为了访问短信服务,您需要有一个阿里云账号。如果没有,可首先按照如下步骤创建阿里云账号:
-
访问阿里云官方网站,单击页面上的免费注册按钮。
-
按照屏幕提示完成注册流程并进行实名认证, 短信服务只支持实名认证用户使用。 为了更好地使用阿里云服务,建议尽快完成实名认证,否则部分阿里云服务将无法使用。具体实名认证流程,请参见实名认证。
步骤2:获取阿里云访问密钥
为了使用短信发送API-JAVA SDK,您必须申请阿里云的访问密钥。
阿里云访问密钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。
该访问密钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个阿里云用户可以创建多对访问密钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问密钥对。
您可以通过阿里云控制台的密钥管理页面创建、管理所有的访问密钥对,且保证它处于“启用”状态。由于访问密钥是阿里云对 API 请求进行安全验证的关键因子,请妥善保管你的访问密钥。如果某些密钥对出现泄露风险,建议及时删除该密钥对并生成新的替代密钥对。
步骤3:申请模板和签名
短信签名
根据用户属性来创建符合自身属性的签名信息。企业用户需要上传相关企业资质证明,个人用户需要上传证明个人身份的证明。
重要 短信签名需要审核通过后才可以使用。
短信模板
短信模板,即具体发送的短信内容。
短信模板可以支持验证码、短信通知、推广短信、国际/中国香港、中国澳门和中国台湾消息四种模式。验证码和短信通知,通过变量替换实现个性短信定制。推广短信不支持在模板中添加变量。国际/中国香港、中国澳门和中国台湾消息只能使用国际/港澳台短信模板发送短信。
说明 短信模板需要审核通过后才可以使用。
为了成功发送一条短信通知,您至少需要完成以下步骤
-
在控制台完成短信签名与短信模板的申请,获得调用接口必备的参数。
-
在“短信签名”页面完成签名的申请,获得短信签名的字符串。
-
在“短信模板”页面完成模板的申请,获得模板ID。
下载SDK工具包
SDK工具包中一共包含了2个类库,一个aliyun-java-sdk-core包,另外一个是alicom-dysms-api包,将这两个包执行mvn package命令或者mvn deploy命令打包出相应的jar包,添加到工程类库中依赖使用。
SDK和DEMO下载:下载地址。
短信API产品的DEMO程序,工程中包含了一个SmsDemo类,直接通过
执行main函数即可体验短信产品API功能(只需要将AK替换成开通了云通信-短信产品功能的AK即可)
备注:Demo工程编码采用UTF-8
国际短信发送请勿参照此DEMO
package com.ddm.baseService.tools.alSms;
import com.alibaba.fastjson.JSONObject;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;
import com.jfinal.plugin.activerecord.Record;
import com.ddm.baseService.tools.JsonTools;
import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Service;
@Service
@Scope("prototype")
public class SmsDemo {
private static Logger logger = Logger.getLogger(SmsDemo.class);
//产品名称:云通信短信API产品,开发者无需替换
static final String product = "Dysmsapi";
//产品域名,开发者无需替换
static final String domain = "dysmsapi.aliyuncs.com";
// TODO 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
@Value("${ddm.aly.accessKeyId:''}")
public String accessKeyId;
@Value("${ddm.aly.accessKeySecret:''}")
public String accessKeySecret;
@Value("${ddm.aly.signName:''}")
public String signName;
public SmsDemo() {
}
public SmsDemo(String accessKeyId, String accessKeySecret, String signName) {
this.accessKeyId = accessKeyId;
this.accessKeySecret = accessKeySecret;
this.signName = signName;
}
public SendSmsResponse sendSms(String phoneNumbers, JSONObject obj, String templateCode) 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);
//组装请求对象-具体描述见控制台-文档部分内容
SendSmsRequest request = new SendSmsRequest();
//必填:待发送手机号
request.setPhoneNumbers(phoneNumbers);
//必填:短信签名-可在短信控制台中找到
request.setSignName(signName);
//必填:短信模板-可在短信控制台中找到
request.setTemplateCode(templateCode);
//可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
//尊敬的用户,您的注册会员动态密码为:${code},请勿泄漏于他人!
//JSONObject obj=new JSONObject();
//obj.accumulate("code",code);
request.setTemplateParam(obj.toString());
//选填-上行短信扩展码(无特殊需求用户请忽略此字段)
//request.setSmsUpExtendCode("90997");
//可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
request.setOutId("yourOutId");
//hint 此处可能会抛出异常,注意catch
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
if(sendSmsResponse.getCode()!= null && sendSmsResponse.getCode().equals("OK")){
System.out.println("短信发送成功!");
}else {
System.out.println("短信发送失败!");
}
return sendSmsResponse;
}
public SendSmsResponse sendMtSms(JSONObject obj, String templateCode) throws ClientException {
logger.info("读取到的accessKeyId欣慰为:"+accessKeyId);
//可自助调整超时时间
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);
//组装请求对象-具体描述见控制台-文档部分内容
SendSmsRequest request = new SendSmsRequest();
//必填:待发送手机号
request.setPhoneNumbers(obj.getString("mobile"));
//必填:短信签名-可在短信控制台中找到
request.setSignName(signName);
//必填:短信模板-可在短信控制台中找到
request.setTemplateCode(templateCode);
//可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
//TemplateParam={“name”:”Tom”,”code”:”123”}
//code==={"name":"15334489768","pwd":"000000"}
request.setTemplateParam(obj.getJSONObject("code").toString());
request.setOutId("yourOutId");
//hint 此处可能会抛出异常,注意catch
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
return sendSmsResponse;
}
public static void main(String[] args) throws Exception {
String accessKeyId ="XXXXXX";// "yourAccessKeyId";
String accessKeySecret = "XXXXXXXXXX";//"yourAccessKeySecret";
Record obj = new Record().set("mobile", "139XXXXXXXX").set("code", new Record().set("code", "验证码"));
SendSmsResponse result = new SmsDemo(accessKeyId,accessKeySecret,signName).sendMtSms(JsonTools.objToJson(obj),
"SMS_147195354");
System.out.println( result.getMessage());
}
}
手机接收到的短信会有延迟