O AWS SDK para JavaScript v2 chegou ao fim do suporte. Recomendamos migrar para o [AWS SDK para JavaScript v3](https://docs.aws.amazon.com//sdk-for-javascript/v3/developer-guide/). Para ver detalhes e informações sobre como migrar, consulte este [anúncio](https://aws.amazon.com/blogs//developer/announcing-end-of-support-for-aws-sdk-for-javascript-v2/).
# Enviar mensagens SMS com o Amazon SNS
![\[JavaScript code example that applies to Node.js execution\]](http://docs.aws.amazon.com/pt_br/sdk-for-javascript/v2/developer-guide/images/nodeicon.png)
**Este exemplo de código Node.js mostra:**
+ Como obter e definir as preferências de mensagens SMS para Amazon SNS.
+ Como verificar um número de telefone para definir se ele não permite o recebimento de mensagens SMS.
+ Como obter uma lista de números de telefone que cancelaram o recebimento de mensagens SMS.
+ Como enviar uma mensagem SMS.
## O cenário
Você pode usar o Amazon SNS para enviar mensagens de texto ou mensagens SMS para dispositivos habilitados para SMS. Você pode enviar uma mensagem diretamente para um número de telefone ou enviar uma mensagem para vários números de telefone de uma só vez inscrevendo esses números em um tópico e enviando sua mensagem para o tópico.
Neste exemplo, você usa uma série de módulos do Node.js para publicar mensagens de texto SMS do Amazon SNS em dispositivos habilitados para SMS. Os módulos do Node.js usam o SDK para JavaScript para publicar mensagens SMS usando estes métodos da classe de cliente :
+ [https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SNS.html#getSMSAttributes-property](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SNS.html#getSMSAttributes-property)
+ [https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SNS.html#setSMSAttributes-property](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SNS.html#setSMSAttributes-property)
+ [https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SNS.html#checkIfPhoneNumberIsOptedOut-property](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SNS.html#checkIfPhoneNumberIsOptedOut-property)
+ [https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SNS.html#listPhoneNumbersOptedOut-property](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SNS.html#listPhoneNumbersOptedOut-property)
+ [https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SNS.html#publish-property](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SNS.html#publish-property)
## Tarefas de pré-requisito
Para configurar e executar este exemplo, você deve primeiro concluir estas tarefas:
+ Instale o Node.js. Para obter mais informações sobre como instalar Node.js, consulte o [website de Node.js](http://nodejs.org).
+ Crie um arquivo de configurações compartilhado com as credenciais de usuário. Para obter mais informações sobre como fornecer um arquivo de credenciais do JSON, consulte [Carregar credenciais em Node.js do arquivo de credenciais compartilhado](loading-node-credentials-shared.md).
## Obter atributos do SMS
Use o Amazon SNS para especificar as preferências para o uso de mensagens SMS, por exemplo, como suas entregas serão otimizadas (para fins de custo ou confiabilidade), o limite de gastos mensais, como as entregas de mensagens serão registradas e a assinatura em relatórios diários de uso de SMS. Essas preferências são recuperadas e definidas como atributos de SMS para Amazon SNS.
Neste exemplo, use um módulo do Node.js para obter os atributos de SMS atuais no Amazon SNS. Crie um módulo do Node.js com o nome de arquivo `sns_getsmstype.js`. Configure o SDK como mostrado anteriormente. Crie um objeto contendo os parâmetros para obter atributos de SMS, incluindo os nomes dos atributos individuais a serem obtidos. Para obter detalhes sobre os atributos de SMS disponíveis, consulte [SetSMSAttributes](https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html) na Referência de API do Amazon Simple Notification Service.
Esse exemplo usa o atributo `DefaultSMSType`, que controla se serão enviadas mensagens SMS como `Promotional`, o que otimiza a entrega de mensagens para gerar custos mais baixos, ou como `Transactional`, que otimiza a entrega de mensagens para gerar a mais alta confiabilidade. Passe os parâmetros para o método `setTopicAttributes` da classe de cliente `AWS.SNS`. Para chamar o método `getSMSAttributes`, crie uma promessa para invocar um objeto de serviço do Amazon SNS passando o objeto dos parâmetros. Depois, lide com `response` no retorno de chamada da promessa.
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set region
AWS.config.update({ region: "REGION" });
// Create SMS Attribute parameter you want to get
var params = {
attributes: [
"DefaultSMSType",
"ATTRIBUTE_NAME",
/* more items */
],
};
// Create promise and SNS service object
var getSMSTypePromise = new AWS.SNS({ apiVersion: "2010-03-31" })
.getSMSAttributes(params)
.promise();
// Handle promise's fulfilled/rejected states
getSMSTypePromise
.then(function (data) {
console.log(data);
})
.catch(function (err) {
console.error(err, err.stack);
});
```
Para executar o exemplo, digite o seguinte na linha de comando.
```
node sns_getsmstype.js
```
Este código de exemplo pode ser encontrado [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascript/example_code/sns/sns_getsmstype.js).
## Definir atributos do SMS
Neste exemplo, use um módulo do Node.js para obter os atributos de SMS atuais no Amazon SNS. Crie um módulo do Node.js com o nome de arquivo `sns_setsmstype.js`. Configure o SDK como mostrado anteriormente. Crie um objeto contendo os parâmetros para definir atributos de SMS, incluindo os nomes dos atributos individuais a serem definidos e os valores para cada um. Para obter detalhes sobre os atributos de SMS disponíveis, consulte [SetSMSAttributes](https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html) na Referência de API do Amazon Simple Notification Service.
Este exemplo define o atributo `DefaultSMSType` para `Transactional`, que otimiza a entrega de mensagens para gerar a mais alta confiabilidade. Passe os parâmetros para o método `setTopicAttributes` da classe de cliente `AWS.SNS`. Para chamar o método `getSMSAttributes`, crie uma promessa para invocar um objeto de serviço do Amazon SNS passando o objeto dos parâmetros. Depois, lide com `response` no retorno de chamada da promessa.
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set region
AWS.config.update({ region: "REGION" });
// Create SMS Attribute parameters
var params = {
attributes: {
/* required */
DefaultSMSType: "Transactional" /* highest reliability */,
//'DefaultSMSType': 'Promotional' /* lowest cost */
},
};
// Create promise and SNS service object
var setSMSTypePromise = new AWS.SNS({ apiVersion: "2010-03-31" })
.setSMSAttributes(params)
.promise();
// Handle promise's fulfilled/rejected states
setSMSTypePromise
.then(function (data) {
console.log(data);
})
.catch(function (err) {
console.error(err, err.stack);
});
```
Para executar o exemplo, digite o seguinte na linha de comando.
```
node sns_setsmstype.js
```
Este código de exemplo pode ser encontrado [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascript/example_code/sns/sns_setsmstype.js).
## Verificar se um número de telefone cancelou o recebimento
Neste exemplo, use um módulo do Node.js para verificar um número de telefone e determinar se ele cancelou o recebimento de mensagens SMS. Crie um módulo do Node.js com o nome de arquivo `sns_checkphoneoptout.js`. Configure o SDK como mostrado anteriormente. Crie um objeto contendo o número de telefone a ser verificado como parâmetro.
Este exemplo define o parâmetro `PhoneNumber` para especificar o número de telefone a ser verificado. Passe o objeto para o método `checkIfPhoneNumberIsOptedOut` da classe de cliente `AWS.SNS`. Para chamar o método `checkIfPhoneNumberIsOptedOut`, crie uma promessa para invocar um objeto de serviço do Amazon SNS passando o objeto dos parâmetros. Depois, lide com `response` no retorno de chamada da promessa.
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set region
AWS.config.update({ region: "REGION" });
// Create promise and SNS service object
var phonenumPromise = new AWS.SNS({ apiVersion: "2010-03-31" })
.checkIfPhoneNumberIsOptedOut({ phoneNumber: "PHONE_NUMBER" })
.promise();
// Handle promise's fulfilled/rejected states
phonenumPromise
.then(function (data) {
console.log("Phone Opt Out is " + data.isOptedOut);
})
.catch(function (err) {
console.error(err, err.stack);
});
```
Para executar o exemplo, digite o seguinte na linha de comando.
```
node sns_checkphoneoptout.js
```
Este código de exemplo pode ser encontrado [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascript/example_code/sns/sns_checkphoneoptout.js).
## Listar números de telefone que cancelaram o recebimento
Neste exemplo, use um módulo do Node.js para obter uma lista de telefones que cancelaram o recebimento de mensagens SMS. Crie um módulo do Node.js com o nome de arquivo `sns_listnumbersoptedout.js`. Configure o SDK como mostrado anteriormente. Crie um objeto vazio como parâmetro.
Passe o objeto para o método `listPhoneNumbersOptedOut` da classe de cliente `AWS.SNS`. Para chamar o método `listPhoneNumbersOptedOut`, crie uma promessa para invocar um objeto de serviço do Amazon SNS passando o objeto dos parâmetros. Depois, lide com `response` no retorno de chamada da promessa.
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set region
AWS.config.update({ region: "REGION" });
// Create promise and SNS service object
var phonelistPromise = new AWS.SNS({ apiVersion: "2010-03-31" })
.listPhoneNumbersOptedOut({})
.promise();
// Handle promise's fulfilled/rejected states
phonelistPromise
.then(function (data) {
console.log(data);
})
.catch(function (err) {
console.error(err, err.stack);
});
```
Para executar o exemplo, digite o seguinte na linha de comando.
```
node sns_listnumbersoptedout.js
```
Este código de exemplo pode ser encontrado [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascript/example_code/sns/sns_listnumbersoptedout.js).
## Publicar uma mensagem SMS
Neste exemplo, use um módulo do Node.js para enviar uma mensagem SMS a um número de telefone. Crie um módulo do Node.js com o nome de arquivo `sns_publishsms.js`. Configure o SDK como mostrado anteriormente. Crie um objeto contendo os parâmetros `Message` e `PhoneNumber`.
Ao enviar uma mensagem SMS, especifique o número de telefone usando o formato E.164. E.164 é um padrão para a estrutura de número de telefone usada para telecomunicações internacionais. Números de telefone que seguem esse formato podem ter um máximo de 15 dígitos, e eles são prefixados com o caractere de mais (\$1) e o código do país. Por exemplo, um número de telefone dos EUA no formato E.164 seria exibido como \$11001XXX5550100.
Este exemplo define o parâmetro `PhoneNumber` para especificar o número de telefone ao qual a mensagem deve ser enviada. Passe o objeto para o método `publish` da classe de cliente `AWS.SNS`. Para chamar o método `publish`, crie uma promessa para invocar um objeto de serviço do Amazon SNS passando o objeto dos parâmetros. Depois, lide com `response` no retorno de chamada da promessa.
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set region
AWS.config.update({ region: "REGION" });
// Create publish parameters
var params = {
Message: "TEXT_MESSAGE" /* required */,
PhoneNumber: "E.164_PHONE_NUMBER",
};
// Create promise and SNS service object
var publishTextPromise = new AWS.SNS({ apiVersion: "2010-03-31" })
.publish(params)
.promise();
// Handle promise's fulfilled/rejected states
publishTextPromise
.then(function (data) {
console.log("MessageID is " + data.MessageId);
})
.catch(function (err) {
console.error(err, err.stack);
});
```
Para executar o exemplo, digite o seguinte na linha de comando.
```
node sns_publishsms.js
```
Este código de exemplo pode ser encontrado [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascript/example_code/sns/sns_publishsms.js).