Send SMS messages using Alibaba Cloud API and SDK - Short Message Service

Llame a la API de SMS mediante OpenAPI Explorer o un SDK para enviar mensajes y consultar el estado de entrega.

Antes de empezar

Complete las siguientes preparaciones:

Cree una cuenta y complete la verificación de identidad empresarial: SMS requiere una cuenta empresarial. Complete la verificación de identidad empresarial.

Si usted es un usuario final de un revendedor (End User), el sistema también valida la verificación de identidad empresarial de todas las cuentas de revendedores superiores en la cadena cuando activa SMS. Asegúrese de que todos los niveles de cuentas en la cadena de revendedores hayan completado la verificación de identidad empresarial. De lo contrario, la activación de SMS fallará.

Activar SMS: Inicie sesión en SMS console y active el servicio.
Comprar un paquete de recursos: SMS utiliza paquetes de recursos prepagados de forma predeterminada. Compre un paquete de recursos antes de usarlo.
- Agregue una tarjeta de crédito o una cuenta de PayPal a su cuenta de Alibaba Cloud.
- Elija un paquete según sus destinos y package specifications. Para utilizar la facturación pay-as-you-go, contacte al equipo de ventas para habilitarla.
Configurar el entorno de desarrollo: Este proceso implica crear un RAM User, otorgar permisos y obtener un par de AccessKey. Para más detalles, consulte Configure credentials.
Los requisitos de cumplimiento varían según el destino. Complete los procedimientos obligatorios:
- Para enviar mensajes a China continental (Go China), complete create an SMS signature y message template. Estos deben aprobarse antes de usarse.
- Para enviar mensajes a regiones fuera de China continental (Go Globe), compruebe si el país o la región de destino requiere sender ID registration.

Usar OpenAPI Explorer

OpenAPI Explorer ofrece una interfaz interactiva para depurar llamadas a la API. Permite previsualizar respuestas en tiempo real, validar parámetros y generar código de ejemplo en varios lenguajes.

Haga clic en el botón Test de cualquier página de referencia de la API para abrir OpenAPI Explorer.

Go Globe

SendMessageToGlobe: envía un mensaje a regiones fuera de China continental, incluidas Hong Kong (China), Macao (China) y Taiwán (China).
BatchSendMessageToGlobe: envía mensajes por lotes a regiones fuera de China continental, incluidas Hong Kong (China), Macao (China) y Taiwán (China).
QueryMessage: consulta el estado de un mensaje enviado.

Go China

SendMessageWithTemplate: envía un mensaje a China continental.
QueryMessage: consulta el estado de un mensaje enviado.

Integrar el SDK de SMS

Utilice el SDK oficial para llamar a la API de SMS. Este ejemplo llama a SendMessageToGlobe con el SDK de Java. Para otros lenguajes, consulte SDK reference.

Compruebe el entorno de Java: se requiere Java 8 o una versión posterior. Para obtener instrucciones, consulte Set up a Java development environment on Windows.

Instale el SDK: agregue una dependencia de Maven a su proyecto.

Agregue a continuación el código en su archivo pom.xml, dentro de la etiqueta <dependencies>. Reemplace the-latest-version por el número de versión más reciente y vuelva a cargar las dependencias de Maven.

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>dysmsapi20180501</artifactId>
    <!-- Replace 'the-latest-version' with the latest version number: https://mvnrepository.com/artifact/com.aliyun/dysmsapi20180501 -->
    <version>the-latest-version</version>
</dependency>

Consulte el código de ejemplo: llame a SendMessageToGlobe mediante el SDK de Java. Complete los parámetros según lo indican los comentarios.

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 ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // Configure the AccessKey secret. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
                .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 request client.
        Client client = Sample.createClient();

        // Construct the request object. Fill in the parameter values.
        SendMessageToGlobeRequest sendSmsRequest = new SendMessageToGlobeRequest()
                .setTo("<YOUR_VALUE>")
                .setMessage("<YOUR_VALUE>");

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

        // The response contains the body and headers from the server.
        System.out.println(toJSONString(sendSmsResponse));
    }
}

También puede descargar el código de ejemplo y ejecutarlo directamente.
1. En la pestaña Parameters, introduzca los valores de parámetro obligatorios.
2. En la pestaña SDK Sample Code, del lado derecho, seleccione V2.0 como versión del SDK y Java como lenguaje. Después, haga clic en Download Project para descargar el paquete con el código de ejemplo.
3. Descomprima el paquete y abra el proyecto en su IDE. Una vez que se carguen las dependencias, abra src/main/java/com/aliyun/sample/Sample.java.

Revise la respuesta: una llamada exitosa devuelve un resultado similar al siguiente:

{
  "headers": {
    "date": "Tue, 24 Oct 2023 07:47:17 GMT",
    "content-type": "application/json;charset=utf-8",
    "content-length": "263",
    "connection": "keep-alive",
    "keep-alive": "timeout=25",
    "access-control-allow-origin": "*",
    "access-control-expose-headers": "*",
    "x-acs-request-id": "97B1D7B6-F2F6-3A50-97BC-A90B43EC962F",
    "x-acs-trace-id": "29c11fe4c778b74774d5f5602f0e7975",
    "etag": "2a+mcDRTDkXqx9VF7b6U57Q3"
  },
  "statusCode": 200,
  "body": {
    "ResponseCode": "OK",
    "NumberDetail": {
    "Region": "Taiwan",
    "Country": "Taiwan, Province of China",
    "Carrier": "FarEasTone"
  },
    "RequestId": "97B1D7B6-F2F6-3A50-97BC-A90B43EC962F",
    "Segments": "1",
    "ResponseDescription": "OK",
    "To": "88691567****",
    "MessageId": "191921698133637273"
  }
}

Acuses de entrega

Reciba los informes de entrega y las respuestas de los usuarios mediante la configuración de un consumidor de Simple Message Queue (anteriormente MNS) o de un endpoint webhook para envíos HTTP por lotes. Esto permite habilitar el monitoreo de entregas y la comunicación bidireccional.

Para obtener más información, consulte Configure delivery receipts.

Referencias

API overview: Describe las operaciones de la API, los parámetros y los límites.
International error codes: Enumera los códigos de error que devuelven las llamadas a la API o los acuses de entrega, junto con sus soluciones.
Make your first API call: Explica la configuración del entorno, el proceso de llamada y el código de ejemplo.

Tutorial en video

Cómo activar SMS.