阿里云首页

短信发送API(SendSms)---Java

本文为您介绍Java调用短信发送API的操作流程。

发送短信接口(SendSms)

注意

使用短信服务新版SDK调用API接口,请查看新版SDK参考和API参考。

本接口主要适用于短信单发场景,特殊场景下可支持群发(最多可向1000个手机号码发送同样内容的短信),但群发会有一定延迟。

步骤1:创建阿里云账号

为了访问短信服务,您需要有一个阿里云账号。如果没有,可首先按照如下步骤创建阿里云账号:

  1. 访问阿里云官方网站,单击页面上的免费注册按钮。

  2. 按照屏幕提示完成注册流程并进行实名认证, 短信服务只支持实名认证用户使用。 为了更好地使用阿里云服务,建议尽快完成实名认证,否则部分阿里云服务将无法使用。具体实名认证流程,请参见实名认证

步骤2:获取阿里云访问密钥

为了使用短信发送API-JAVA SDK,您必须申请阿里云的访问密钥。

阿里云访问密钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。

该访问密钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个阿里云用户可以创建多对访问密钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问密钥对。

您可以通过阿里云控制台的密钥管理页面创建、管理所有的访问密钥对,且保证它处于“启用”状态。由于访问密钥是阿里云对 API 请求进行安全验证的关键因子,请妥善保管你的访问密钥。如果某些密钥对出现泄漏风险,建议及时删除该密钥对并生成新的替代密钥对。

步骤3:申请模板和签名

短信签名

根据用户属性来创建符合自身属性的签名信息。企业用户需要上传相关企业资质证明,个人用户需要上传证明个人身份的证明。

注意

短信签名需要审核通过后才可以使用。

短信模板

短信模板,即具体发送的短信内容。

短信模板可以支持验证码、短信通知、推广短信、国际/港澳台消息四种模式。验证码和短信通知,通过变量替换实现个性短信定制。推广短信不支持在模板中添加变量。国际/港澳台消息只能使用国际/港澳台短信模版发送短信。

说明

短信模板需要审核通过后才可以使用。

为了成功发送一条短信通知,您至少需要完成以下步骤

  1. 在控制台完成短信签名与短信模板的申请,获得调用接口必备的参数。

  2. 在“短信签名”页面完成签名的申请,获得短信签名的字符串。短信签名简介

  3. 在“短信模板”页面完成模板的申请,获得模板ID。短信模板简介

参数

入参列表

参数名称

参数类型

必填与否

样例取值

参数说明

PhoneNumbers

String

必须

1500000****

短信接收号码,支持以逗号分隔的形式进行批量调用,批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式;发送国际/港澳台消息时,接收号码格式为:国际区号+号码,如“8520000****”。

SignName

String

必须

云通信

短信签名。

TemplateCode

String

必须

SMS_0000

短信模板ID,发送国际/港澳台消息时,请使用国际/港澳台短信模版。

TemplateParam

String

可选

{"code":"1234","product":"ytx"}

短信模板变量替换JSON串,友情提示:如果JSON中需要带换行符,请参照标准的JSON协议。

SmsUpExtendCode

String

可选

90999

上行短信扩展码,无特殊需要此字段的用户请忽略此字段。

OutId

String

可选

abcdefgh

外部流水扩展字段。

出参列表

出参名称

出参类型

样例取值

参数说明

RequestId

String

8906582E-6722

请求ID。

Code

String

OK

状态码。返回OK代表请求成功,其他错误码详见错误码列表。

Message

String

请求成功

状态码的描述。

BizId

String

134523^4351232

发送回执ID,可根据该ID查询具体的发送状态。

技术对接步骤

1:下载SDK工具包

SDK工具包中一共包含了2个类库,一个aliyun-java-sdk-core包,另外一个是alicom-dysms-api包,将这两个包执行mvn package命令或者mvn deploy命令打包出相应的jar包,添加到工程类库中依赖使用。

SDK和DEMO下载:下载地址

2:编写样例程序

说明

有备注无需修改的位置请勿改动。

//设置超时时间-可自行调整
System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
System.setProperty("sun.net.client.defaultReadTimeout", "10000");
//初始化ascClient需要的几个参数
final String product = "Dysmsapi";//短信API产品名称(短信产品名固定,无需修改)
final String domain = "dysmsapi.aliyuncs.com";//短信API产品域名(接口地址固定,无需修改)
//替换成你的AK
final String accessKeyId = "yourAccessKeyId";//你的accessKeyId,参考本文档步骤2
final String accessKeySecret = "yourAccessKeySecret";//你的accessKeySecret,参考本文档步骤2
//初始化ascClient,暂时不支持多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();
 //使用post提交
 request.setMethod(MethodType.POST);
 //必填:待发送手机号。支持以逗号分隔的形式进行批量调用,批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式;发送国际/港澳台消息时,接收号码格式为国际区号+号码,如“85200000000”
 request.setPhoneNumbers("1500000000");
 //必填:短信签名-可在短信控制台中找到
 request.setSignName("云通信");
 //必填:短信模板-可在短信控制台中找到,发送国际/港澳台消息时,请使用国际/港澳台短信模版
 request.setTemplateCode("SMS_1000000");
 //可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
 //友情提示:如果JSON中需要带换行符,请参照标准的JSON协议对换行符的要求,比如短信内容中包含\r\n的情况在JSON中需要表示成\\r\\n,否则会导致JSON在服务端解析失败
//参考:request.setTemplateParam("{\"变量1\":\"值1\",\"变量2\":\"值2\",\"变量3\":\"值3\"}")
 request.setTemplateParam("{\"name\":\"Tom\", \"code\":\"123\"}");
 //可选-上行短信扩展码(扩展码字段控制在7位或以下,无特殊需求用户请忽略此字段)
 //request.setSmsUpExtendCode("90997");
 //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
 request.setOutId("yourOutId");
//请求失败这里会抛ClientException异常
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
if(sendSmsResponse.getCode() != null && sendSmsResponse.getCode().equals("OK")) {
//请求成功
}
            

错误码列表

Code

描述

OK

请求成功。

isp.RAM_PERMISSION_DENY

RAM权限DENY。

isv.OUT_OF_SERVICE

业务停机。

isv.PRODUCT_UN_SUBSCRIPT

未开通云通信产品的阿里云客户。

isv.PRODUCT_UNSUBSCRIBE

产品未开通。

isv.ACCOUNT_NOT_EXISTS

账户不存在。

isv.ACCOUNT_ABNORMAL

账户异常。

isv.SMS_TEMPLATE_ILLEGAL

短信模板不合法。

isv.SMS_SIGNATURE_ILLEGAL

短信签名不合法。

isv.INVALID_PARAMETERS

参数异常。

isp.SYSTEM_ERROR

系统错误。

isv.MOBILE_NUMBER_ILLEGAL

非法手机号。

isv.MOBILE_COUNT_OVER_LIMIT

手机号码数量超过限制。

isv.TEMPLATE_MISSING_PARAMETERS

模板缺少变量。

isv.BUSINESS_LIMIT_CONTROL

业务限流。

isv.INVALID_JSON_PARAM

JSON参数不合法,只接受字符串值。

isv.BLACK_KEY_CONTROL_LIMIT

黑名单管控。

isv.PARAM_LENGTH_LIMIT

参数超出长度限制。

isv.PARAM_NOT_SUPPORT_URL

不支持URL。

isv.AMOUNT_NOT_ENOUGH

账户余额不足。

说明

查询所有错误码及解决办法,请参见短信接口调用错误码

首页 短信发送API(SendSms)---Java