@brokeros/int-sms-aws-sns) connects to the AWS SNS API using AWS Signature Version 4 (SigV4) authentication.
AWS SNS Calling Pipeline
Required Credentials
To connect AWS SNS to BrokerOS, create an IAM User with Amazon SNS publish permissions and retrieve:Configuration Steps
1
Create IAM Policy & User in AWS Console
In the AWS IAM Console, create an IAM user with programmatic access and attach the following minimal policy:
2
Add AWS SNS in BrokerOS Settings
In the BrokerOS web application:
- Navigate to Dashboard -> Marketing -> SMS -> Settings -> Gateways & Phone Pools tab (
/dashboard/marketing/sms/settings?tab=providers). - Click Connect Gateway (or select AWS SNS from the available gateways list).
- In the Connect AWS SNS modal, configure the parameters:
- Account Nickname: A descriptive label (e.g.,
AWS SNS India Production). - Default From Sender / Header: Your approved sender ID or verified carrier phone number.
- AWS Access Key ID: Your 20-character AWS IAM access key ID (
AKIAIOSFODNN7EXAMPLE). - AWS Secret Access Key: Your 40-character AWS IAM secret key.
- AWS Region: Deployment region identifier (e.g.,
ap-south-1for Mumbai,us-east-1for N. Virginia). - Set as default gateway for SMS broadcasts: Toggle on if AWS SNS is your primary SMS route.
- Account Nickname: A descriptive label (e.g.,
- Click Verify & Save Credentials. BrokerOS tests credentials, encrypts secrets with AES-256-GCM, and persists the configuration to PostgreSQL (
SmsIntegration).
3
Configure Delivery Status Logging (Optional)
In the AWS SNS Console under Text messaging (SMS) -> Delivery status logging, configure IAM role permissions for CloudWatch Logs or an SNS topic routed to
https://api.yourdomain.com/api/marketing/sms/webhooks/aws-sns.