Short Message Service:Get started with the SMS API

• Before you use the SMS API, make sure that SMS is activated and qualifications are approved. For more information, see Get started with Alibaba Cloud SMS.

• Before you send messages, you must submit a signature and a message template for approval by using the SMS API or console. For more information, see Get started with Alibaba Cloud SMS.

1. Create a RAM user

   Go to the Create User page of the Resource Access Management (RAM) console, specify a RAM username, set the Access Mode parameter to OpenAPI Access, and then click OK. Record the AccessKey information.

2. Grant permissions to the RAM user

   Go to the Users page of the RAM console, find the RAM user, and click Add Permissions in the Actions column. In the Policy section of the panel that appears, search for and select the AliyunDysmsFullAccess policy, and then click Grant permissions.

   Note

   • AliyunDysmsFullAccess: specifies the management permissions on SMS.

   • AliyunDysmsReadOnlyAccess: specifies the read-only permissions on SMS.

   For more information about how to create a custom policy, see RAM authorization.

The Java version must be later than 8. Check the Java version by running the following command in the terminal:

java -version

If you have not deployed a Java environment or the Java version is earlier than 8, see Build a Java development environment on Windows.

You can install the SDK through Maven dependencies.

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>dysmsapi20180501</artifactId>
  <version>1.0.7</version>
</dependency>

To prevent the AccessKey pair from being leaked due to hard-coding, you must configure environment variables to obtain an AccessKey pair. For more information about how to configure environment variables, see Configure environment variables in Linux, macOS, and Windows.

In this example, the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are used. Sample code:

Config config = new Config()
        // Make sure that the environment variables are configured for code execution.
        .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
        .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));

Sample code:

config.endpoint = "dysmsapi.ap-southeast-1.aliyuncs.com";

Use an endpoint based on the network type and region. For more information, see Endpoints.

Sample code:

package com.aliyun.sample;

import com.aliyun.teaopenapi.models.Config;
import com.aliyun.dysmsapi20180501.Client;
import com.aliyun.dysmsapi20180501.models.SendMessageToGlobeRequest;
import com.aliyun.dysmsapi20180501.models.SendMessageToGlobeResponse;
import static com.aliyun.teautil.Common.toJSONString;

public class Sample {
    public static Client createClient() throws Exception {
        Config config = new Config()
                // Configure the AccessKey ID. Make sure that the environment variable ALIBABA_CLOUD_ACCESS_KEY_ID is configured. 
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // Configure the AccessKey secret. Make sure that the environment variable ALIBABA_CLOUD_ACCESS_KEY_SECRET is configured. 
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));

        Configure the endpoint
        config.endpoint = "dysmsapi.ap-southeast-1.aliyuncs.com";

        return new Client(config);
    }

    public static void main(String[] args) throws Exception {
        // Initialize the client
        Client client = Sample.createClient();

        // Construct the request object and specify the request parameters
        SendMessageToGlobeRequest sendSmsRequest = new SendMessageToGlobeRequest()
                .setTo("<YOUR_VALUE>")
                .setMessage("<YOUR_VALUE>");

        // Obtain the response object
        SendMessageToGlobeResponse sendSmsResponse = client.sendMessageToGlobe(sendSmsRequest);

        // Response body and headers
        System.out.println(toJSONString(sendSmsResponse));
    }
}