La Guida di riferimento dell'API AWS SDK for JavaScript V3 descrive in dettaglio tutte le operazioni API per la AWS SDK for JavaScript versione 3 (V3).

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Invio di messaggi SMS con Amazon SNS

Questo esempio di codice di Node.js illustra:

Lo scenario

Puoi utilizzare Amazon SNS; per inviare messaggi SMS a dispositivi abilitati. Puoi inviare un messaggio direttamente a un numero di telefono oppure inviarlo a più numeri contemporaneamente sottoscrivendo quei numeri a un argomento e inviando il messaggio all'argomento.

In questo esempio, utilizzi una serie di moduli Node.js per pubblicare messaggi di testo SMS da Amazon SNS a dispositivi abilitati agli SMS. I moduli Node.js utilizzano l'SDK per JavaScript pubblicare messaggi SMS utilizzando questi metodi della classe client: SNS

Attività prerequisite

Per configurare ed eseguire questo esempio, è necessario completare queste attività:

Recupero degli attributi SMS

Usa Amazon SNS per specificare le preferenze per la messaggistica SMS, ad esempio il modo in cui le consegne sono ottimizzate (in termini di costi o per una consegna affidabile), il limite di spesa mensile, il modo in cui vengono registrate le consegne dei messaggi e se abbonarsi ai report giornalieri sull'utilizzo degli SMS. Queste preferenze vengono recuperate e impostate come attributi SMS per Amazon SNS.

In questo esempio, usa un modulo Node.js per ottenere gli attributi SMS correnti in Amazon SNS.

Crea una libs directory e crea un modulo Node.js con il nome snsClient.js del file. Copia e incolla il codice seguente, che crea l'oggetto client Amazon SNS. Sostituisci REGION con la tua AWS regione.

import { SNSClient } from "@aws-sdk/client-sns";

// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});

Questo codice di esempio può essere trovato qui GitHub.

Crea un modulo Node.js con il nome del file get-sms-attributes.js.

Configura l'SDK come mostrato in precedenza, incluso il download dei client e dei pacchetti richiesti. Crea un oggetto contenente i parametri per ottenere attributi SMS, inclusi i nomi dei singoli attributi da recuperare. Per i dettagli sugli attributi SMS disponibili, consulta setSMSAttributes nel riferimento all'API di Amazon Simple Notification Service.

Questo esempio recupera l'attributo DefaultSMSType, che controlla se i messaggi SMS vengono inviati come Promotional per ottimizzare il recapito dei messaggi e permettere di contenere i costi, oppure come Transactional per ottimizzare il recapito dei messaggi e ottenere la massima affidabilità. Trasferisci i parametri al metodo SetTopicAttributesCommand della classe client SNS. Per chiamare il SetSMSAttributesCommand metodo, crea una funzione asincrona che richiama un oggetto del servizio client Amazon SNS, passando l'oggetto parameters.

import { GetSMSAttributesCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";

export const getSmsAttributes = async () => {
  const response = await snsClient.send(
    // If you have not modified the account-level mobile settings of SNS,
    // the DefaultSMSType is undefined. For this example, it was set to
    // Transactional.
    new GetSMSAttributesCommand({ attributes: ["DefaultSMSType"] }),
  );

  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: '67ad8386-4169-58f1-bdb9-debd281d48d5',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   },
  //   attributes: { DefaultSMSType: 'Transactional' }
  // }
  return response;
};

Per eseguire l'esempio, immettere quanto segue al prompt dei comandi.

node get-sms-attributes.js

Questo codice di esempio può essere trovato qui su GitHub.

Impostazione degli attributi SMS

In questo esempio, usa un modulo Node.js per ottenere gli attributi SMS correnti in Amazon SNS.

Crea una libs directory e crea un modulo Node.js con il nome snsClient.js del file. Copia e incolla il codice seguente, che crea l'oggetto client Amazon SNS. Sostituisci REGION con la tua AWS regione.

import { SNSClient } from "@aws-sdk/client-sns";

// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});

Questo codice di esempio può essere trovato qui GitHub.

Crea un modulo Node.js con il nome del file set-sms-attribute-type.js. Configura l'SDK come mostrato in precedenza, inclusa l'installazione dei client e dei pacchetti richiesti. Crea un oggetto contenente i parametri per impostare gli attributi SMS, inclusi i nomi dei singoli attributi da impostare e i valori da impostare per ciascuno di essi. Per i dettagli sugli attributi SMS disponibili, consulta setSMSAttributes nel riferimento all'API di Amazon Simple Notification Service.

Questo esempio imposta l'attributo DefaultSMSType su Transactional, ottimizzando il recapito dei messaggi per ottenere la massima affidabilità. Trasferisci i parametri al metodo SetTopicAttributesCommand della classe client SNS. Per chiamare il SetSMSAttributesCommand metodo, crea una funzione asincrona che richiama un oggetto del servizio client Amazon SNS, passando l'oggetto parameters.

import { SetSMSAttributesCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";

/**
 * @param {"Transactional" | "Promotional"} defaultSmsType
 */
export const setSmsType = async (defaultSmsType = "Transactional") => {
  const response = await snsClient.send(
    new SetSMSAttributesCommand({
      attributes: {
        // Promotional – (Default) Noncritical messages, such as marketing messages.
        // Transactional – Critical messages that support customer transactions,
        // such as one-time passcodes for multi-factor authentication.
        DefaultSMSType: defaultSmsType,
      },
    }),
  );
  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: '1885b977-2d7e-535e-8214-e44be727e265',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   }
  // }
  return response;
};

Per eseguire l'esempio, inserisci quanto segue al prompt dei comandi.

node set-sms-attribute-type.js 

Questo codice di esempio può essere trovato qui su GitHub.

Controllare se un numero di telefono è stato disattivato

In questo esempio, utilizza un modulo Node.js per controllare un numero di telefono per verificare se è stata disattivata la ricezione di messaggi SMS.

Crea una libs directory e crea un modulo Node.js con il nome del filesnsClient.js. Copia e incolla il codice seguente, che crea l'oggetto client Amazon SNS. Sostituisci REGION con la tua AWS regione.

import { SNSClient } from "@aws-sdk/client-sns";

// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});

Questo codice di esempio può essere trovato qui GitHub.

Crea un modulo Node.js con il nome del file check-if-phone-number-is-opted-out.js. Configura l'SDK come mostrato in precedenza. Crea un oggetto contenente il numero di telefono da controllare come parametro.

Questo esempio imposta il parametro PhoneNumber per specificare il numero di telefono da verificare. Trasferisci l'oggetto al metodo CheckIfPhoneNumberIsOptedOutCommand della classe client SNS: Per chiamare il CheckIfPhoneNumberIsOptedOutCommand metodo, crea una funzione asincrona che richiama un oggetto del servizio client Amazon SNS, passando l'oggetto parameters.

import { CheckIfPhoneNumberIsOptedOutCommand } from "@aws-sdk/client-sns";

import { snsClient } from "../libs/snsClient.js";

export const checkIfPhoneNumberIsOptedOut = async (
  phoneNumber = "5555555555",
) => {
  const command = new CheckIfPhoneNumberIsOptedOutCommand({
    phoneNumber,
  });

  const response = await snsClient.send(command);
  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: '3341c28a-cdc8-5b39-a3ee-9fb0ee125732',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   },
  //   isOptedOut: false
  // }
  return response;
};

Per eseguire l'esempio, immettere quanto segue al prompt dei comandi.

node check-if-phone-number-is-opted-out.js 

Questo codice di esempio può essere trovato qui su GitHub.

Elenco di numeri di telefono disattivati

In questo esempio, utilizza un modulo Node.js per ottenere un elenco di numeri di telefono per cui è stata disattivata la ricezione di messaggi SMS.

Crea una libs directory e crea un modulo Node.js con il nome del filesnsClient.js. Copia e incolla il codice seguente, che crea l'oggetto client Amazon SNS. Sostituisci REGION con la tua AWS regione.

import { SNSClient } from "@aws-sdk/client-sns";

// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});

Questo codice di esempio può essere trovato qui GitHub.

Crea un modulo Node.js con il nome del file list-phone-numbers-opted-out.js. Configura l'SDK come mostrato in precedenza. Crea un oggetto vuoto come parametro.

Trasferisci l'oggetto al metodo ListPhoneNumbersOptedOutCommand della classe client SNS: Per chiamare il ListPhoneNumbersOptedOutCommand metodo, crea una funzione asincrona che richiama un oggetto del servizio client Amazon SNS, passando l'oggetto parameters.

import { ListPhoneNumbersOptedOutCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";

export const listPhoneNumbersOptedOut = async () => {
  const response = await snsClient.send(
    new ListPhoneNumbersOptedOutCommand({}),
  );
  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: '44ff72fd-1037-5042-ad96-2fc16601df42',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   },
  //   phoneNumbers: ['+15555550100']
  // }
  return response;
};

Per eseguire l'esempio, inserisci quanto segue al prompt dei comandi.

node list-phone-numbers-opted-out.js 

Questo codice di esempio può essere trovato qui su GitHub.

Pubblicazione di un messaggio SMS

In questo esempio, utilizza un modulo Node.js per inviare un messaggio SMS a un numero di telefono.

Crea una libs directory e crea un modulo Node.js con il nome del filesnsClient.js. Copia e incolla il codice seguente, che crea l'oggetto client Amazon SNS. Sostituisci REGION con la tua AWS regione.

import { SNSClient } from "@aws-sdk/client-sns";

// The AWS Region can be provided here using the `region` property. If you leave it blank
// the SDK will default to the region set in your AWS config.
export const snsClient = new SNSClient({});

Questo codice di esempio può essere trovato qui GitHub.

Crea un modulo Node.js con il nome del file publish-sms.js. Configura l'SDK come mostrato in precedenza, inclusa l'installazione dei client e dei pacchetti richiesti. Crea un oggetto contenente i parametri Message e PhoneNumber.

Quando invii un SMS, ricorda di specificare il numero di telefono utilizzando il formato E.164. E.164 è uno standard per la struttura del numero di telefono utilizzato per le telecomunicazioni internazionali. I numeri di telefono che seguono questo formato possono avere un massimo di 15 cifre e sono preceduti dal segno più (+) e dal prefisso internazionale. Ad esempio, un numero di telefono negli Stati Uniti in formato E.164 verrà visualizzato come + 1001XXX5550100.

Questo esempio imposta il parametro PhoneNumber per specificare il numero di telefono a cui inviare il messaggio. Trasferisci l'oggetto al metodo PublishCommand della classe client SNS: Per chiamare il PublishCommand metodo, crea una funzione asincrona che richiama un oggetto di servizio Amazon SNS, passando l'oggetto parameters.

import { PublishCommand } from "@aws-sdk/client-sns";
import { snsClient } from "../libs/snsClient.js";

/**
 * @param {string | Record<string, any>} message - The message to send. Can be a plain string or an object
 *                                                 if you are using the `json` `MessageStructure`.
 * @param {*} phoneNumber - The phone number to send the message to.
 */
export const publish = async (
  message = "Hello from SNS!",
  phoneNumber = "+15555555555",
) => {
  const response = await snsClient.send(
    new PublishCommand({
      Message: message,
      // One of PhoneNumber, TopicArn, or TargetArn must be specified.
      PhoneNumber: phoneNumber,
    }),
  );
  console.log(response);
  // {
  //   '$metadata': {
  //     httpStatusCode: 200,
  //     requestId: '7410094f-efc7-5f52-af03-54737569ab77',
  //     extendedRequestId: undefined,
  //     cfId: undefined,
  //     attempts: 1,
  //     totalRetryDelay: 0
  //   },
  //   MessageId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
  // }
  return response;
};

Per eseguire l'esempio, immettere quanto segue al prompt dei comandi.

node publish-sms.js

Questo codice di esempio può essere trovato qui su GitHub.