numero2/contao-notification_center-aws-sns

Integration of AWS SNS as a notification gateway for Contao 4 with Notification Center

1.0.1 2022-04-07 10:13 UTC

Requires

• aws/aws-sdk-php: ^3.92
• contao/core-bundle: ^4.4.0
• terminal42/notification_center: ^1.5

Requires (Dev)

• contao/manager-plugin: ^2.0

Conflicts

• contao/core: *
• contao/manager-plugin: <2.0 || >=3.0

LGPL-3.0-or-later

• numero2 - Agentur für digitales Marketing

• sms
• gateway
• aws
• contao
• SNS
• notification_center

README

About

The package adds AWS SNS to the Notification Center as a gateway.

System requirements

• Contao 4
• Notification Center

Installation

• Install via Contao Manager or Composer (composer require numero2/contao-notification_center-aws-sns)
• Run a database update via the Contao-Installtool or using the contao:migrate command.
• Create a SMS (Amazon Web Services SNS) gateway in the Notification Center

How to generate API keys in AWS

1. Log in to the AWS Management Console
2. Select a Supported Region from the top right of the console
3. Switch to the IAM Service
4. Select Policiesand choose Create policy
5. Switch to the JSON tab and see the example below for a policy which can be used
6. Save the policy and switch to Users and click Add user
7. Choose a user name and set the Access type to Programmatic access
8. In the Permissions step choose Attach existing policies directly and select the policy you just created
9. Make sure to save the generated Access key ID and the Secret access key for later configuration in Contao

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "sns:Publish"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

🚨 Important information about phone number format

AWS requires the recipient phone number to be in E.164 format (e.g [phone]). For this purpose this extension provides a custom Input validation option called Phone number (E.164) for the form generator.

For a better user experience we suggest to use a small JavaScript called International Telephone Input which makes sure the inserted number matches the format.