通过API/SDK使用短信服务

调用方式

• OpenAPI开发者门户示例：如果您经常使用交互式操作界面，或者您是初次使用阿里云产品的开发者用户，可选用此方式。您可以在OpenAPI开发者门户中调试和获取SDK请求示例，详情请参见阿里云 OpenAPI 开发者门户是什么。

• Java SDK示例：适用于SDK编码场景。使用升级版Java SDK要求您已提前安装Java 8或以上版本，安装详情请参见安装与使用教程。其他编程语言SDK，请参见短信服务SDK。

使用须知

• 仅当短信签名的适用场景为通用时，国内短信和国际/港澳台短信可以共用此签名，无需分别添加。
• 国内短信模板与国际/港澳台短信模板不通用，请根据实际业务情况分别添加、使用。
• 填写签名、模板申请信息时，请正确选择签名适用场景、模板类型，详细描述已上线业务的使用场景，并提供可以验证这些业务的网站链接、已备案域名地址、应用市场下载链接、公众号或小程序全称等信息。对于登录场景，还需提供测试账号密码。信息完善的申请说明会提高签名、模板的审核效率。
• 短信签名和短信模板均需审核通过后方可使用。

准备工作

1. 注册账号与实名认证。
   说明

   • 实名认证的类型包括个人认证和企业认证。个人认证表示账号持有者是个人、以个人身份使用短信服务；企业认证表示账号持有者是企业或政府部门，以企业身份使用短信服务。个人认证和企业认证可使用的功能不完全相同。更多信息，请参见认证模式。
   • 发送推广短信、国际/港澳台短信必须为企业实名认证用户。
   • 如果您未注册阿里云账号，请先完成账号注册和实名认证。
   • 如果您已有实名认证的阿里云账号，请直接进行下一步操作，开通短信服务。
2. 开通短信服务。

   登录短信服务控制台，勾选开通协议，单击开通服务。

3. 获取AccessKey。
   阿里云访问密钥（AccessKey）是调用API访问云资源的安全口令，支持阿里云账号和RAM用户方式访问。调用API前，您需要先创建AccessKey。具体操作，请参见创建AccessKey。

OpenAPI开发者门户示例

调用API发送短信的全流程如下所示：

1. 通过AddSmsSign添加短信签名。

2. 通过AddSmsTemplate添加短信模板。

3. 分别通过QuerySmsSign、QuerySmsTemplate查看短信签名和短信模板的审核状态。

4. 通过SendSms发送短信，您也可以通过SendBatchSms批量发送短信。

5. 通过QuerySendDetails查询短信发送详情。

短信发送后，通过配置MNS消息队列消费模式和HTTP批量推送模式，可以接收短信发送状态的结果和用户回复的短信内容，帮助您掌握短信的发送成功率，为其他业务提供支持。更多信息，请参见回执消息简介与配置流程。

Java SDK示例

以AddSmsTemplate为例，演示如何通过阿里云SDK调用短信服务API。示例代码中的下列参数需要您根据实际情况自行填写。

• AccessKeyId：您的AccessKey ID。

• AccessKeySecret：您的AccessKey Secret。

• TemplateType：短信模板类型。

• TemplateName：短信模板名称。

• TemplateContent：短信模板内容。

• Remark：短信模板申请说明。

import com.alibaba.fastjson.JSONObject;
import com.aliyun.dysmsapi20170525.models.*;
import com.aliyun.teaopenapi.models.*;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.http.HttpResponse;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;

public class AddSmsTemplate {

  /**
   * 此处通过从环境变量中读取AccessKey，初始化云呼叫中心Client
   * @return Client
   * @throws Exception
   */
  public static com.aliyun.dysmsapi20170525.Client createCCClient()
    throws Exception {
    // 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维，请登录RAM控制台创建RAM用户
    // 此处以把AccessKey 和 AccessKeySecret 保存在环境变量为例说明。您也可以根据业务需要，保存到配置文件里
    // 强烈建议不要把 AccessKey 和 AccessKeySecret 保存到代码里，会存在密钥泄漏风险
    com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
      .setAccessKeyId(System.getenv("SMS_ACCESS_KEY_ENV"))
      .setAccessKeySecret(System.getenv("SMS_ACCESS_KEY_SECRET_ENV"));
    // 访问的域名
    config.endpoint = "dysmsapi.aliyuncs.com";
    return new com.aliyun.dysmsapi20170525.Client(config);
  }

  public static void main(String[]args_) throws Exception {
    java.util.List<String> args = java.util.Arrays.asList(args_);
    com.aliyun.dysmsapi20170525.Client client = createCCClient();

    AddSmsTemplateRequest addSmsTemplateRequest = new AddSmsTemplateRequest()
      .setTemplateType(0)
      .setTemplateName("content3")
      .setTemplateContent("您正在申请手机注册，验证码为：${code}，5分钟内有效!")
      .setRemark("用于文件下载时的验证码");
    // 复制代码运行请自行打印API的返回值
    client.addSmsTemplate(addSmsTemplateRequest);
    AddSmsTemplateResponse response = client.addSmsTemplate(
      addSmsTemplateRequest
    );
    System.out.println(JSONObject.toJSONString(response));
  }
}

更多示例，请参见OpenAPI开发者门户。

原版SDK的安装流程及代码示例，请参见Java SDK。