全部产品

国际短信发送API(SendInterSms)

更新时间:2019-11-07 16:29:57

发送短信接口(SendInterSms)

步骤 1 创建阿里云账号

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

  1. 访问阿里云 官方网站,单击页面上的 免费注册 按钮。
  2. 按照屏幕提示完成注册流程并进行实名认证,短信服务只支持实名认证用户使用。为了更好地使用阿里云服务,建议尽快完成实名认证,否则部分阿里云服务将无法使用。具体实名认证流程,请参考 这里

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

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

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

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

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

步骤 3 在控制台完成模版与签名的申请,获得调用接口必备的参数

短信签名

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

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

短信模版

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

国际短信模版为全变量模版,用户可以根据自己的需要替换变量值。

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

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

一、在控制台完成短信全名与短信模版的申请,获得调用接口必备的参数

在“短信签名”页面完成签名的申请,获得短信签名的字符串 签名申请手册

在“短信模版”页面完成模版的申请,获得模版ID。模版申请手册

参数

入参列表
参数名称 参数类型 必填与否 样例取值 参数说明
PhoneNumbers String 必须 15000000000 短信接收号码,不需要添加对应国家的国家码作为前缀
countryCode String 必须 CHN 对应手机号码归属的国家或区域代码
SignName String 必须 云通信 短信签名
TemplateCode String 必须 SMS_0000 短信模版ID
TemplateParam String 可选 {“code”:”1234”,”product”:”ytx”} 短信模版变量替换JSON串
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: 编写样例程序
  1. //设置超时时间-可自行调整
  2. System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
  3. System.setProperty("sun.net.client.defaultReadTimeout", "10000");
  4. //初始化ascClient需要的几个参数
  5. final String product = "Dysmsapi";//短信API产品名称
  6. final String domain = "dysmsapi.aliyuncs.com";//短信API产品域名
  7. //替换成你的AK
  8. final String accessKeyId = "yourAccessKeyId";//你的accessKeyId,参考本文档步骤2
  9. final String accessKeySecret = "yourAccessKeySecret";//你的accessKeySecret,参考本文档步骤2
  10. //初始化ascClient,暂时不支持多region
  11. IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId,
  12. accessKeySecret);
  13. DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
  14. IAcsClient acsClient = new DefaultAcsClient(profile);
  15. //组装请求对象-具体描述见控制台-文档部分内容
  16. SendInterSmsRequest request = new SendInterSmsRequest();
  17. //必填:待发送手机号
  18. request.setPhoneNumbers("1234567");
  19. //必填:对应国家的国家编号,国家编号的获取详见国际短信国家编码获取API接口
  20. request.setCountryCode("HK");
  21. //必填:短信签名-可在短信控制台中找到(必须是国际短信模版)
  22. request.setTemplateCode("SMS_0000002");
  23. //短信签名
  24. request.setSignName("sign_test");
  25. //必填,短信内容
  26. request.setTemplateParam("{\"intlmsg\":\"kiko\"}");
  27. //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
  28. request.setOutId("your_outId");
  29. //hint 此处可能会抛出异常,注意catch
  30. SendInterSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
  31. if(sendSmsResponse.getCode() != null && sendSmsResponse.getCode().equals("OK")) {
  32. //请求成功
  33. }

错误码列表

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 账户余额不足