全部产品
Search
文档中心

JAVA

更新时间: 2019-11-26

入参列表

参数名称 参数类型 必填与否 样例取值 参数说明
To String 必填 452220121 接收方的手机号码;说明:号码格式为 国家码+号码
From String 选填 XXCompany 发送方标识;说明:发往中国时,该参数为短信签名
TemplateCode String 必填 SMS_0000 短信模板ID。请在控制台中查看
TemplateParam String 选填 {“code”:”1234”,”product”:”ytx”} 短信模板变量对应的实际值,JSON格式;说明:如果JSON中需要带换行符,请参照标准的JSON协议处理。
SmsUpExtendCode String 选填 90999 上行短信扩展码,无特殊需要此字段的用户请忽略此字段。

出参列表

出参名称 出参类型 样例取值 参数说明
To String 452220121 接收方的手机号码;说明:号码格式为 国家码+号码
MessageId String 10080303003003 短信发送ID,可根据该ID在接口QueryMessage中查询具体的发送状态。
ResponseCode String OK 请求状态码,返回OK代表请求成功,其他错误码详见错误码列表。
ResponseDescription String 短信接收成功 状态码的描述。
Segments String 1 短信计费条数

技术对接步骤

1.Core-sdk引用

方法1,maven:

  1. <dependency>
  2. <groupId>com.aliyun</groupId>
  3. <artifactId>aliyun-java-sdk-core</artifactId>
  4. <version>4.4.6</version>
  5. </dependency>

方法2,core-sdk下载地址:Java API SDK

2.编写样例程序

调用接口时,请注意:

  • 构造DefaultProfile时,第一个参数(regionId)必须为ap-southeast-1,请勿修改。
  • domain必须为sms-intl.ap-southeast-1.aliyuncs.com,请勿修改。
  • version必须为2018-05-01,请勿修改。
  1. package com.alicom.dysms.api;
  2. import com.aliyuncs.CommonRequest;
  3. import com.aliyuncs.CommonResponse;
  4. import com.aliyuncs.DefaultAcsClient;
  5. import com.aliyuncs.IAcsClient;
  6. import com.aliyuncs.exceptions.ClientException;
  7. import com.aliyuncs.exceptions.ServerException;
  8. import com.aliyuncs.http.MethodType;
  9. import com.aliyuncs.profile.DefaultProfile;
  10. /*
  11. pom.xml
  12. <dependency>
  13. <groupId>com.aliyun</groupId>
  14. <artifactId>aliyun-java-sdk-core</artifactId>
  15. <version>4.4.6</version>
  16. </dependency>
  17. */
  18. public class CommonRpc {
  19. public static void main(String[] args) {
  20. //初始化acsClient,<accessKeyId>和"<accessSecret>"在短信控制台查询即可。
  21. DefaultProfile profile = DefaultProfile.getProfile("ap-southeast-1", "<accessKeyId>", "<accessSecret>");
  22. IAcsClient client = new DefaultAcsClient(profile);
  23. CommonRequest request = new CommonRequest();
  24. request.setMethod(MethodType.POST);
  25. //域名,请勿修改
  26. request.setDomain("sms-intl.ap-southeast-1.aliyuncs.com");
  27. //API版本号,请勿修改
  28. request.setVersion("2018-05-01");
  29. //API名称
  30. request.setAction("SendMessageWithTemplate");
  31. //接收号码,格式为:国际码+号码,必填
  32. request.putQueryParameter("To", "8615200000000");
  33. request.putQueryParameter("From", "云通信签名");
  34. request.putQueryParameter("TemplateCode", "SMS_225001");
  35. request.putQueryParameter("TemplateParam", "{\"code\":\"1234\"}");
  36. request.putQueryParameter("SmsUpExtendCode", "12345");
  37. try {
  38. CommonResponse response = client.getCommonResponse(request);
  39. System.out.println(response.getData());
  40. } catch (ServerException e) {
  41. e.printStackTrace();
  42. } catch (ClientException e) {
  43. e.printStackTrace();
  44. }
  45. }
  46. }