Copy page

Getting Started

AWS SMS

The AWS SMS module manages API credentials and sender configurations for delivering transactional SMS text messages via AWS SNS / End User Messaging services. When configured, it links with SMS Templates and Notification rules to automate SMS dispatch.

---

How it works

1. Configure AWS SMS integration — provide your AWS Access Key ID, Secret Access Key, target AWS region, and Sender ID.
2. Link to SMS templates — associate this integration record (integrationId) with an SMS Template or Notification rule specifying integrationProvider: aws_sms.
3. Automate notification dispatch — active notification rules automatically dispatch transactional SMS alerts via your AWS SMS gateway.

---

Fields

Basic information

Field	Type	Required	Max length	Description
name	string	✅	256	The name of the AWS SMS integration record
description	string	❌	1 024	A brief description of the integration setup
status	enum	✅	draft	Status of the integration: draft · live · paused

AWS credentials & configuration

Field	Type	Required	Description
accessKeyId	string	✅	The AWS IAM Access Key ID with SMS sending permissions
secretAccessKey	string	✅	The AWS IAM Secret Access Key. Encrypted at rest and in transit (returned on create only).
region	string	✅	The target AWS region (e.g., us-east-1, eu-west-1)
senderId	string	✅	Custom alphanumeric or numeric Sender ID (e.g., GAMOPANDA) displayed to SMS recipients

---

Real-world examples

💬 Configuring AWS SMS Gateway

Code
{
  "name": "Production AWS SMS Gateway",
  "description": "Primary AWS integration for sending customer transactional SMS alerts.",
  "accessKeyId": "youraccesskeyid",
  "secretAccessKey": "yoursecretaccesskey",
  "region": "yourregion",
  "senderId": "yoursenderid",
  "status": "live"
}

---

Access & permissions

Caller	Allowed operations	Notes
Admin	CREATE · GET · LIST · UPDATE · DELETE	Full management access
End user	(none)	No access
Guest user	(none)	No access

---

Related resources

Resource	Description
SMS Template	Template copy bound to AWS SMS integration
Notification	Active notification rules targeting SMS channels
Notification Log	Read-only delivery logs recording execution history

---

API reference

See the API Reference for full schemas and interactive examples for:

• GET /schema/aws_sms/record — list AWS SMS integration records
• POST /schema/aws_sms/record — create an AWS SMS integration record
• GET /schema/aws_sms/record/{id} — get an AWS SMS integration record by ID
• PATCH /schema/aws_sms/record/{id} — update an AWS SMS integration record
• DELETE /schema/aws_sms/record/{id} — delete an AWS SMS integration record