rogerio-pereira / laravel-otp-email_sms_voice

Using AWS SES, SNS, Polly, Connect

About this project

Laravel Sail

This project uses Laravel Sail, (if running over Windows, Laravel Sail requires WSL2, and won't run in HyperV).

NOTE:
By default, Sail commands are invoked using the vendor/bin/sail script that is included with all new Laravel applications.
However, instead of repeatedly typing vendor/bin/sail to execute Sail commands, you may wish to configure a shell alias that allows you to execute Sail's commands more easily:

alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'

Installation

1. Clone the project

   [email protected]:rogerio-pereira/Laravel-OTP-email_sms_voice.git ./LaravelOTP
   

2. Access project folder

   cd LaravelOTP
   

3. Copy .env file

   cp .env.example .env
   

4. Update .env file

   APP_NAME=
   
   DB_CONNECTION=mysql
   DB_HOST=127.0.0.1
   DB_PORT=3306
   DB_DATABASE=
   DB_USERNAME=
   DB_PASSWORD=
   #FORWARD_DB_PORT= #Use if port 3306 is already assigned
   
   REDIS_HOST=127.0.0.1
   REDIS_PASSWORD=null
   REDIS_PORT=6379
   #FORWARD_REDIS_PORT= #Use if port 6379 is already assigned
   
   MAIL_MAILER=ses
   MAIL_FROM_ADDRESS="[email protected]" #Use an email validated in SES
   MAIL_FROM_NAME="${APP_NAME}"
   
   AWS_ACCESS_KEY_ID=<AWS Access Key, step 18>
   AWS_SECRET_ACCESS_KEY=<AWS Access Key, step 19>
   AWS_CONNECT_INSTANCE_ID=<AWS CONNECT, step 19>
   AWS_CONNECT_QUEUE_ID=<AWS CONNECT, step 19>
   AWS_CONNECT_CONTACT_FLOW_ID=<AWS CONNECT, step 52>
   

5. Install composer dependencies

   docker run --rm \
       -u "$(id -u):$(id -g)" \
       -v "$(pwd):/var/www/html" \
       -w /var/www/html \
       laravelsail/php83-composer:latest \
       composer install --ignore-platform-reqs
   

6. Generate app key

   sail artisan key:generate
   

7. Start the containers

   sail up -d
   

8. Run migrations

   sail artisan migrate
   

9. Compile js

   sail npm run build
   

10. Run tests

    sail test --parallel
    

11. Clear cache

    sail artisan optimize:clear
    

---

AWS Configuration

AWS Access Key and Secret Key

1. Go to IAM Page
2. On Left Menu > Access management > Users
3. Click Create User
4. Add a Username
5. Click Next
6. Select Attach policies directly
7. Add following permissions
   • AmazonSESFullAccess
   • AmazonSNSFullAccess
   • AmazonConnect_FullAccess
   • AmazonSQSFullAccess
   • AmazonS3FullAccess
8. Click Next
9. Click Create users
10. In the table click the user
11. Click Security Credentials
12. Scroll down to Access Keys
13. Click Create Access Key
14. Select the use case NOTE: Select Local code or Application running on an AWS compute service depending on your use case
15. Check option I understand the above..
16. Click Next
17. Click Create Access Key
18. Copy Access Key
19. Copy Secret access key
20. Click Done

SES

1. Go to AWS SES Page
2. On Left Menu > Configuration > Verified identities
3. Click Create Identity
4. Select Email Address
5. Type Email address
6. Click Create Identity
7. Access your email
8. Check for AWS email Amazon Web Services – Email Address Verification Request in region <region name>
   NOTE: Might be on span folder
9. Click the link to verify the indentity
10. Go to AWS SES Page again
11. On Left Menu > Configuration > Verified identities
12. Select email
13. Click Send test email
14. Select Custom in Scenarion
15. Type the same verified email (step 5) in Custom recipient field
16. Type a message
17. Click Send Test Email
18. Go to AWS SES Page again
19. On Left Menu > Get set up
20. Scroll down to Get production access and start sending emails section
21. Click Create Identity
22. Select Domain
23. Type the domain
24. Click Create Identity
25. Scroll down to DomainKeys Identified Mail (DKIM) section
26. Add all records to your domain DNS
27. Wait until the DNS records are verified NOTE: It might take up to 24 hours for the DNS records to be verified

Production Access

After everything is tested you need to request Production access (leave sandbox)

1. Go to AWS SES Page again
2. On Left Menu > Get set up
3. Click Request production access
4. Select Transactional on Mail Type
5. Type your website in Website URL
6. In Use case description be very specific on:
   • How do you plan to build or acquire your mailing list?
   • How do you plan to handle bounces and complaints?
   • How can recipients opt out of receiving email from you?
     NOTE: Add as much detail as possible (this field is crucial on AWS Team allowing your account to leave sandbox)
7. Select your Prefered contact language
8. Select I agree to ...
9. Click Submit Request
10. Wait for a response

SNS (Origination Number)

1. Go to AWS SNS Page
2. On Left Menu > Mobile > Origination Number
3. Click Provision numbers in Pinpoint
4. Click Request Phone Number
5. Select the Country
6. Select Tool-free
7. Make sure voice and SMS are checked
8. Select Default message type > Transactional
9. Click Next
10. Click Request
11. Click the Phone number and you'll be redirected to AWS Pinpoint page
12. Click on left Menu > Configurations > Registrations
13. Click Create Registration
14. Add name on field Registration friendly name
15. Registration Type > US tool-free number registration
16. On Available toll-free numbers select the number
17. Click Create
18. Fill the Company info form
19. Click Next
20. Fill the Contact info form
21. Click Next
22. Fill the Message use case form
    NOTE: On Use case details and Opt-in workflow description be as much specific as possible
    NOTE2: You are required to send an otp-in workflow, use this image
    
23. Click Next
24. Sample message

Hello, new OTP (OneTimePassword) XXXXXX for application XYZ

23. Click Next
24. Click Submit Registration
25. Wait until the the number is provisioned (can take up to 15 business days) (for me it took 14 business day, 21 day in total)

SNS Configuration (Sandbox phone)

NOTE: Do this step only after the phone number requested in SNS (Origination Number) is active

1. Go to AWS SNS Page
2. On Left Menu > Mobile > Text Messaging (SMS)
3. Scroll down to Sandbox destination phone number
4. Click Add Phone number
5. type your phone number
6. Select a language
7. Click Add phone number
8. Go to AWS SNS Page
9. On Left Menu > Mobile > Text Messaging (SMS)
10. Scroll down to Sandbox destination phone number
11. Select the phone number
12. Click verify Phone Number
13. Type the code sent to that number

AWS Connect Configuration

1. Go to AWS Connect Page
2. Click Add Instance
3. Identity Page
4. Select Store users in Amazon Connect
5. Type an URL
   eg. connect
6. Click Next
7. Administrator Page
8. Select Specify Administrator
9. Fill fields:
   a. First Name
   b. Last Name
   c. Username
   d. Password
   e. Password (verify)
   f. Email
10. Click Next
11. Telephony Page
12. Uncheck Allow incoming calls
13. Click Next
14. Data Storage Page
15. Copy Connect Data bucket
16. Copy Flow Logs cloudwatch
17. Click Next
18. Review and Create Page
19. Click Create Instance
20. Wait until everything is created
21. Click your access URL

AWS Connect

1. Fill username and password and click Sign In
   NOTE: Defined in AWS Connect Configuration > Step 9.c and 9.d
2. In section Explore you channels of communications
3. Click Begin
4. Select Tool free in Type field
5. Select Country
6. The phone number will be selected automatically NOTE: This phone number isn't related to SNS (Origination Number)
7. Click Next
8. Click Continue
9. On Connect Home, scroll down to Create Queues section
10. Click View queues
11. Click BasicQueue
12. Scroll down to Outbound caller configuration
13. Fill Default Caller ID
14. Select phone number in Outbound caller ID number
15. Click Save
16. Click BasicQueue again
17. Click Show additional queue information
18. You’ll get an ARN in the form of arn:aws:connect:<region>:<account-id>:instance/<instance-id>/queue/<queue-id>
19. Copy instance-id and queue-id and update .env (see below)
20. On Connect Home, scroll down to Create flows section
21. Click View flows
22. On the arrow next to Create Flow
23. Click Create flow
24. Enter a flow name
25. Search, drag and drop Play prompt
26. Click the three dots and Edit Settings
27. Select Text to speech or chat text
28. Select Set Dynamically
29. Select User defined in namespace
30. Type message in key
31. Select SSML in Interpret as
32. Click Save
    
33. Connect Start with Play prompt block
34. Search, drag and drop Get Customer input
35. Click the three dots and Edit Settings
36. Select Text to speech or chat text
37. Select Set Manually
38. Enter text

    <speak>Press 1 to repeat.</speak>
    

39. Select Text in Interpret as
40. Click DTMF
41. Set timeout as 5
42. Click Add condition
43. Type 1
44. Type Enter
45. Click Save
    
    
    
46. Search, drag and drop End flow
47. Connect blocks as follows
48. Click Save
    
49. Click Publish
    
50. Click Show additional flow information
51. You’ll get an ARN in the form of arn:aws:connect:<region>:<account-id>:instance/<instance-id>/contact-flow/<contact-flow-id>
52. Copy contact-flow-id and update .env (see below)

---