Merge pull request #556 from anthonyjdella/forward-message

[UPDATE] SMS Forward & SMS Forward Multiple Templates

docs/templates.md

@@ -7,8 +7,7 @@ This is the list of Functions available in this repo:
 * [Hello Messaging](https://github.com/twilio-labs/function-templates/blob/main/hello-messaging): Function to get you started with Twilio Prog. Messaging
 * [Never gonna give you up](https://github.com/twilio-labs/function-templates/blob/main/never-gonna-give-you-up): Never gonna let you down. Plays a song to a phone call
 * [Forward Call](https://github.com/twilio-labs/function-templates/blob/main/forward-call): Forwards an incoming call to another number
-* [Forward Message](https://github.com/twilio-labs/function-templates/blob/main/forward-message): Forwards incoming messages to another number
-* [Forward Message to Multiple Numbers](https://github.com/twilio-labs/function-templates/blob/main/forward-message-multiple): Forwards incoming messages to a set of numbers
+* [Forward Message](https://github.com/twilio-labs/function-templates/blob/main/forward-message): Forwards incoming messages to another number or to a set of numbers
 * [Forward Message to Email via SendGrid](https://github.com/twilio-labs/function-templates/blob/main/forward-message-sendgrid): Uses SendGrid to forward incoming messages via email
 * [Voicemail](https://github.com/twilio-labs/function-templates/blob/main/voicemail): Forwards calls during business hours. Records messages otherwise.
 * [Forward Message to Email via Sparkpost](https://github.com/twilio-labs/function-templates/blob/main/forward-message-sparkpost): Uses Sparkpost to forward incoming messages via email

env-variables.manifest.json

@@ -62,35 +62,13 @@
       }
     ],
     "forward-message": [
-      {
-        "key": "MY_PHONE_NUMBER",
-        "required": true,
-        "format": "phone_number",
-        "description": "Messages sent to your Twilio number will get forwarded to this E.164-formatted phone number",
-        "link": "https://www.twilio.com/docs/glossary/what-e164",
-        "default": "+12223334444",
-        "configurable": true,
-        "contentKey": null
-      },
-      {
-        "key": "TWILIO_SMS_WEBHOOK_URL",
-        "required": true,
-        "format": "text",
-        "description": "The path to the webhook",
-        "link": null,
-        "default": "/forward-message",
-        "configurable": false,
-        "contentKey": null
-      }
-    ],
-    "forward-message-multiple": [
       {
         "key": "FORWARDING_NUMBERS",
         "required": true,
         "format": "list(phone_number)",
         "description": "A list of numbers in E.164 format you want to forward incoming messages to, separated by commas",
-        "link": null,
-        "default": "+12223334444,+491761234567",
+        "link": "https://www.twilio.com/docs/glossary/what-e164",
+        "default": "+12223334444,+12223335555",
         "configurable": true,
         "contentKey": null
       },
@@ -100,7 +78,7 @@
         "format": "text",
         "description": "The path to the webhook",
         "link": null,
-        "default": "/forward-message-multiple",
+        "default": "/forward-message",
         "configurable": false,
         "contentKey": null
       }
@@ -472,7 +450,7 @@
         "format": "phone_number",
         "description": "A comma separated list of numbers in E.164 format that you want to dial in order",
         "link": null,
-        "default": "+12223334444,+491761234567",
+        "default": "+12223334444,+12223335555",
         "configurable": true,
         "contentKey": null
       },
@@ -1288,7 +1266,7 @@
         "format": "phone_number",
         "description": "A comma separated list of numbers in E.164 format that are allowed to trigger a broadcast",
         "link": null,
-        "default": "+12223334444,+491761234567",
+        "default": "+12223334444,+12223335555",
         "configurable": true,
         "contentKey": null
       },

forward-message/.env

@@ -1,8 +1,8 @@
-# description: Messages sent to your Twilio number will get forwarded to this E.164-formatted phone number
-# format: phone_number
+# description: A list of numbers in E.164 format you want to forward incoming messages to, separated by commas
+# format: list(phone_number)
 # required: true
 # link: https://www.twilio.com/docs/glossary/what-e164
-MY_PHONE_NUMBER=+12223334444
+FORWARDING_NUMBERS=+12223334444,+491761234567
 
 # description: The path to the webhook
 # configurable: false

forward-message/README.md

@@ -1,14 +1,14 @@
 # Forward Message
 
-This Function in `forward-message.js` will return the TwiML required to forward an incoming SMS message to a number that is set in the environment variables.
+This Function in `forward-message.js` returns the TwiML required to forward an incoming SMS message to a single number or each number in a comma-separated list set in the environment variables.
 
 ### Environment variables
 
 This Function expects one environment variable to be set.
 
 | Variable          | Meaning                                                                                                                                                              |
 | :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `MY_PHONE_NUMBER` | The number you want to forward incoming messages to [in E.164 format](https://support.twilio.com/hc/en-us/articles/223183008-Formatting-International-Phone-Numbers) |
+| `FORWARDING_NUMBERS` | A list of numbers [in E.164 format](https://support.twilio.com/hc/en-us/articles/223183008-Formatting-International-Phone-Numbers) you want to forward incoming messages to, separated by commas |
 
 ### Parameters
 

forward-message/assets/index.html

@@ -44,18 +44,18 @@ <h1>
                 </h1>
                 <section>
                     <h2>Get started with your application</h2>
-                    <p>
-                        Follow these steps to try out your new app:
-                    </p>
                     <p>
                         This app will return the
                         <a href="https://www.twilio.com/docs/sms/twiml" target="_blank" rel="noopener">TwiML</a>
-                        required to forward an incoming SMS message to the number that is set in the environment
-                        variables.
+                        required to forward an incoming SMS message to each number in the comma separated list of
+                        numbers set in the environment variables.
+                    </p>
+                    <p>
+                        Follow these steps to try out your new app:
                     </p>
                     <ol class="steps">
                         <li>Text any message to your Twilio phone number</li>
-                        <li>Receive the response message from Twilio</li>
+                        <li>Every phone number you specified should receive the response message from Twilio</li>
                     </ol>
                 </section>
                 <section>

forward-message/changelog.md

@@ -2,7 +2,9 @@
 
 ## [Unreleased]
 
-## [1.0.0]
+## [1.0.1]
 ### Added
-- Initial release.
+- Updated and merged templates for single number and multi-number forwarding.
+- Added code comments.
+- Updated and added test cases.
 

forward-message/functions/forward-message.protected.js

@@ -1,8 +1,36 @@
+/*
+ * Forward a Message to a Specified Number or List of Numbers
+ *
+ * Description: When your Twilio Phone Number associated with this function
+ * receives an SMS, it will forward the message to the phone number(s) listed
+ * in FORWARDING_NUMBERS specified in /.env. This will work whether a single
+ * number or multiple numbers are listed.
+ *
+ * Contents:
+ * 1. Main Handler
+ */
+
+/*
+ * 1. Main Handler
+ *
+ * This is the entry point to your Twilio Function,
+ * which will create a new MessagingResponse using TwiML
+ * and forward the incoming SMS to each number specified in
+ * the FORWARDING_NUMBERS environment variable.
+ *
+ * We then use the callback to return from your function
+ * with the TwiML MessagingResponse you defined earlier.
+ * In the callback, in non-error situations, the first
+ * parameter is null and the second parameter
+ * is the value you want to return.
+ */
+
 exports.handler = function (context, event, callback) {
   const twiml = new Twilio.twiml.MessagingResponse();
-  twiml.message(
-    { to: context.MY_PHONE_NUMBER },
-    `From: ${event.From}. Body: ${event.Body}`
-  );
+
+  context.FORWARDING_NUMBERS.split(/,\s?/).forEach((number) => {
+    twiml.message({ to: number }, `From: ${event.From}. Body: ${event.Body}`);
+  });
+
   callback(null, twiml);
 };

forward-message/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.0",
+  "version": "1.0.1",
   "private": true,
   "dependencies": {}
 }