AWS SNS SMS

Send SMS messages using Amazon Simple Notification Service

AWS SNS SMS

Amazon Simple Notification Service (SNS) is a fully managed messaging service that supports sending SMS messages globally.

Configuration

Database Setup

Create a new entry in the notify_providers table with the following settings:

Field	Value
channel_type	12 (AWS SNS SMS)
is_enabled	1

Configuration Fields

AWS_ACCESS_KEY_ID · string · required

Access key for AWS instance

AWS_SECRET_ACCESS_KEY · string · required

Secret access key for AWS

AWS_REGION · string · required

Region of the AWS instance

Example Configuration:

{
  "AWS_ACCESS_KEY_ID": "Aws-Access-key",
  "AWS_SECRET_ACCESS_KEY": "Aws-Secret-Key",
  "AWS_REGION": "us-east-1"
}

Request Format

Sample Request Body

{
  "providerId": 12,
  "data": {
    "to": "[phone]",
    "message": "This is a test notification"
  }
}

Request Fields

to · string · required

Recipient’s phone number in E.164 format

message · string · required

The SMS message content

Dependencies

Package	Version	Description
@aws-sdk/client-sns	^3.855.0	AWS SDK for JavaScript SNS client

References

• What is AWS SNS
• AWS SNS SMS Integration