首次调用API

• 在通过API使用短信服务前，请确保您已开通短信服务并已完成资质申请，具体操作请参见新手指引。

• 在通过API发送短信前，您还需要完成短信签名、短信模板的申请，并等待审核通过。短信签名、短信模板的申请可通过控制台或API完成。具体操作请参见新手指引。

1. 创建RAM用户

   访问创建RAM用户，完成相关名称设置，并选择访问方式为OpenAPI 调用访问，单击确定后即可完成RAM用户的创建。请及时保存AccessKey信息。

2. 为RAM用户授权

   访问RAM用户列表，找到您所创建的RAM用户，单击操作列的添加权限。通过文本框搜索，选择AliyunDysmsFullAccess，单击确认新增授权，完成授权操作。

   说明

   • AliyunDysmsFullAccess：管理短信服务的权限。

   • AliyunDysmsReadOnlyAccess：只读访问短信服务的权限。

   如果您需要新建自定义权限，请参见授权信息。

为使用SDK进行短信服务API的调用，您的Java版本需高于Java 8。您可以通过在终端运行以下命令，来检查您的Java环境：

java -version

若您尚未完成Java环境的配置或Java版本低于Java 8，请参见在Windows搭建Java开发环境。

您可以通过配置Maven依赖来安装SDK。

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>dysmsapi20170525</artifactId>
  <version>3.0.0</version>
</dependency>

为避免在代码中硬编码访问密钥（AccessKey）而造成泄露，请通过配置环境变量的方式获取AccessKey。环境变量配置方法，请参见在Linux、macOS和Windows系统配置环境变量。

本文以环境变量名ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET为例，进行后续操作。通过环境变量获取AccessKey的代码示例如下：

Config config = new Config()
        // 请确保代码运行环境配置了相应环境变量
        .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
        .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));

配置服务接入点代码示例如下：

config.endpoint = "dysmsapi.aliyuncs.com";

请根据您的地域填入相应地址，参见服务接入点。

完整代码示例如下：

package com.aliyun.sample;

import com.aliyun.teaopenapi.models.Config;
import com.aliyun.dysmsapi20170525.Client;
import com.aliyun.dysmsapi20170525.models.SendSmsRequest;
import com.aliyun.dysmsapi20170525.models.SendSmsResponse;
import static com.aliyun.teautil.Common.toJSONString;

public class Sample {
    public static Client createClient() throws Exception {
        Config config = new Config()
                // 配置 AccessKey ID，请确保代码运行环境配置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 配置 AccessKey Secret，请确保代码运行环境配置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        
        // 配置 Endpoint
        config.endpoint = "dysmsapi.aliyuncs.com";

        return new Client(config);
    }

    public static void main(String[] args) throws Exception {
        // 初始化请求客户端
        Client client = Sample.createClient();

        // 构造请求对象，请填入请求参数值
        SendSmsRequest sendSmsRequest = new SendSmsRequest()
                .setPhoneNumbers("<YOUR_VALUE>")
                .setSignName("<YOUR_VALUE>")
                .setTemplateCode("<YOUR_VALUE>")
                .setTemplateParam("<YOUR_VALUE>");

        // 获取响应对象
        SendSmsResponse sendSmsResponse = client.sendSms(sendSmsRequest);

        // 响应包含服务端响应的 body 和 headers
        System.out.println(toJSONString(sendSmsResponse));
    }
}