Merge pull request aws-samples#1666 from smalhotraa/smalhotraa-pinpointsmssvls-pinpointvalidateandsendmsg

jbesw · web-flow · commit df55763fc382 · 2023-09-18T13:41:38.000-06:00
New serverless pattern - apigw-lambda-pinpoint
diff --git a/apigw-lambda-pinpoint/README.md b/apigw-lambda-pinpoint/README.md
@@ -0,0 +1,84 @@
+# Pinpoint SMS using API Gateway and Lambda
+
+This pattern shows an example how a phone number can be validated and how a SMS message can be send using Pinpoint APIs which via API Gateway and Lambda deployed using SAM.  
+
+As a pre-requisite, a Pinpoint Application has to be created and its SMS channel should be enabled. Subsequently, this stack can be deployed with pinpoint application id, destination phone number, message that has to be sent, origination number and message type. Please read more about the Pinpoint API calls utilised here:
+https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messagespost
+
+https://docs.aws.amazon.com/pinpoint/latest/apireference/phone-number-validate.html
+
+Learn more about this pattern at Serverless Land Patterns: << Add the live URL here >>
+
+Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the [AWS Pricing page](https://aws.amazon.com/pricing/) for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.
+
+## Requirements
+
+* [Create an AWS account](https://portal.aws.amazon.com/gp/aws/developer/registration/index.html) if you do not already have one and log in. The IAM user that you use must have sufficient permissions to make necessary AWS service calls and manage AWS resources.
+* [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) installed and configured
+* [Git Installed](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+* [AWS Serverless Application Model](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) (AWS SAM) installed
+
+## Deployment Instructions
+
+1. Create a new directory, navigate to that directory in a terminal and clone the GitHub repository:
+    ``` 
+    git clone https://github.com/aws-samples/serverless-patterns
+    ```
+1. Change directory to the pattern directory:
+    ```
+    cd serverless-patterns/apigw-lambda-pinpoint
+    ```
+1. From the command line, use AWS SAM to deploy the AWS resources for the pattern as specified in the template.yml file:
+    ```
+    sam deploy --guided
+    ```
+1. During the prompts:
+    * Enter a stack name
+    * Enter the desired AWS Region
+    * Allow SAM CLI to create IAM roles with the required permissions.
+
+    Once you have run `sam deploy --guided` mode once and saved arguments to a configuration file (samconfig.toml), you can use `sam deploy` in future to use these defaults.
+
+1. Note the outputs from the SAM deployment process. These contain the resource names and/or ARNs which are used for testing.
+
+## How it works
+
+1. Depending on the country to which SMS messages has to be sent, an [origination number](https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-request-number.html) can be requested accordingly.
+
+2. Next, the SMS message can be sent using the API Gateway deployed via stack.
+
+3. The lambda function's code firstly verify the phone number by using the [phone number validate](https://docs.aws.amazon.com/pinpoint/latest/apireference/phone-number-validate.html) API call.
+
+## Testing
+
+1. You can make a request to API Gateway with the following payload:
+
+```
+{
+    "destination_number": "",
+    "message": "",
+    "pinpoint_app_id": "",
+    "origination_number": "",
+    "message_type": ""
+}
+```
+2. If the message is sent successfully, then you will receive the following response:
+
+```
+Message sent! Message ID: <random message id> 
+```
+
+## Cleanup
+ 
+1. Delete the stack
+    ```bash
+    aws cloudformation delete-stack --stack-name STACK_NAME
+    ```
+1. Confirm the stack has been deleted
+    ```bash
+    aws cloudformation list-stacks --query "StackSummaries[?contains(StackName,'STACK_NAME')].StackStatus"
+    ```
+----
+Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+SPDX-License-Identifier: MIT-0
diff --git a/apigw-lambda-pinpoint/example-pattern.json b/apigw-lambda-pinpoint/example-pattern.json
@@ -0,0 +1,57 @@
+{
+  "title": "Pinpoint SMS via API Gateway and Lambda",
+  "description": "Validate phone number and send SMS from Pinpoint via API Gateway and Lambda",
+  "language": "Python",
+  "level": "200",
+  "framework": "SAM",
+  "introBox": {
+    "headline": "How it works",
+    "text": [
+      "This pattern shows an example how a phone number can be validated and how a SMS message can be send using Pinpoint APIs which via API Gateway and Lambda deployed using SAM."
+    ]
+  },
+  "gitHub": {
+    "template": {
+      "repoURL": "https://github.com/aws-samples/serverless-patterns/tree/main/apigw-lambda-pinpoint",
+      "templateURL": "serverless-patterns/apigw-lambda-pinpoint",
+      "projectFolder": "apigw-lambda-pinpoint",
+      "templateFile": "template.py"
+    }
+  },
+  "resources": {
+    "bullets": [
+      {
+        "text": "Send Messages Pinpoint",
+        "link": "https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messagespost"
+      },
+      {
+        "text": "Phone number validate",
+        "link": "https://docs.aws.amazon.com/pinpoint/latest/apireference/phone-number-validate.html"
+      }
+    ]
+  },
+  "deploy": {
+    "text": [
+      "sam deploy"
+    ]
+  },
+  "testing": {
+    "text": [
+      "See the GitHub repo for detailed testing instructions."
+    ]
+  },
+  "cleanup": {
+    "text": [
+      "Delete the stack: <code>sam delete --stack-name STACK_NAME</code>."
+    ]
+  },
+  "authors": [
+    {
+      "name": "Sahil Malhotra",
+      "image": "link-to-your-photo.jpg",
+      "bio": "Serverless enthusiast",
+      "linkedin": "https://www.linkedin.com/in/smalhotraa/",
+      "twitter": "twitter-handle"
+    }
+  ]
+}
diff --git a/apigw-lambda-pinpoint/src/lambda_function.py b/apigw-lambda-pinpoint/src/lambda_function.py
@@ -0,0 +1,85 @@
+import logging
+import boto3
+import json
+import os
+
+# Initialize Pinpoint client
+pinpoint_client = boto3.client('pinpoint')
+
+def lambda_handler(event, context):
+    
+    print(event)
+    event_body = json.loads(event['body'])
+    
+    
+    app_id = event_body["pinpoint_app_id"]
+    
+    destination_number = event_body["destination_number"]
+    print(destination_number)
+    
+    message = event_body["message"]
+    print(message)
+    
+    origination_number = event_body["origination_number"]
+    print(origination_number)
+    
+    message_type = event_body["message_type"]
+    print(message_type)
+    
+
+    response = dict()
+    try:
+        response_number_validation = pinpoint_client.phone_number_validate(NumberValidateRequest={'PhoneNumber':destination_number})
+        
+        if response_number_validation["NumberValidateResponse"]["PhoneType"] != "INVALID":
+            
+            print("Sending SMS message.")
+            
+            response_send_message = pinpoint_client.send_messages(
+            ApplicationId=app_id,
+            MessageRequest={
+                'Addresses': {destination_number: {'ChannelType': 'SMS'}},
+                'MessageConfiguration': {
+                    'SMSMessage': {
+                        'Body': message,
+                        'MessageType': message_type,
+                        'OriginationNumber': origination_number}}})
+            
+            
+            message_id = response_send_message['MessageResponse']['Result'][destination_number]['MessageId']
+            
+            if message_id:
+                
+                print(f"Message sent! Message ID: {message_id}.")
+                response = dict()
+                response['statusCode'] = 200
+                response['body'] = f"Message sent! Message ID: {message_id}."
+                return response
+                
+            else:
+                
+                print(f"Unable to send message")
+                response = dict()
+                response['statusCode'] = 500
+                response['body'] = response_send_message
+                return response
+        
+        
+    except Exception as e:
+        
+        print("Couldn't send message!")
+        response['statusCode'] = 500
+        response['body'] = "Couldn't send message!\n" + str(e)
+        return response
+    
+    
+
+        
+
+        
+
+
+        
+    
+
+
diff --git a/apigw-lambda-pinpoint/template.yaml b/apigw-lambda-pinpoint/template.yaml
@@ -0,0 +1,61 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Transform: AWS::Serverless-2016-10-31
+Resources:
+  Api:
+    Type: AWS::Serverless::Api
+    Properties:
+      Name: !Sub
+        - ${ResourceName} From Stack ${AWS::StackName}
+        - ResourceName: PinpointSMSApigw
+      StageName: Prod
+      DefinitionBody:
+        openapi: '3.0'
+        info: {}
+        paths:
+          /send_message:
+            post:
+              x-amazon-apigateway-integration:
+                httpMethod: POST
+                type: aws_proxy
+                uri: !Sub arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${PinpointFunction.Arn}/invocations
+              responses: {}
+      EndpointConfiguration: REGIONAL
+      TracingEnabled: true
+  PinpointFunction:
+    Type: AWS::Serverless::Function
+    Properties:
+      Description: !Sub
+        - Stack ${AWS::StackName} Function ${ResourceName}
+        - ResourceName: PinpointFunction
+      CodeUri: src/
+      Handler: lambda_function.lambda_handler
+      Runtime: python3.9
+      MemorySize: 3008
+      Timeout: 30
+      Tracing: Active
+      Events:
+        ApiPOSTsendmessage:
+          Type: Api
+          Properties:
+            Path: /send_message
+            Method: POST
+            RestApiId: !Ref Api
+      Policies:
+        - Statement:
+            - Effect: Allow
+              Action:
+                - "mobiletargeting:PhoneNumberValidate"
+              Resource: !Join
+                - ""
+                - - "arn:aws:mobiletargeting:*:"
+                  - !Ref AWS::AccountId
+                  - ":phone/number/validate"
+            - Effect: Allow
+              Action:
+                - "mobiletargeting:SendMessages"
+              Resource: !Join
+                - ""
+                - - "arn:aws:mobiletargeting:*:"
+                  - !Ref AWS::AccountId
+                  - ":apps/*/messages"
+
