Send SMS Notifications Using Node.js

    Overview

    This guide shows how to send an SMS notification or alert to any phone number.

    You can send SMS notifications and alerts either by using our PHLO visual workflow builder or our APIs. Follow the instructions in one of the tabs below.

    To implement SMS Notifications use-case, you can create and deploy a PHLO with a few clicks on the PHLO canvas. PHLO also lets you visually construct your entire use-case. With PHLO, you only pay for SMS you send/receive, and building with PHLO is free.

    Outline

    Implementation

    In this section, we will guide you to create a PHLO to implement SMS Notification use-case.

    Prerequisites

    1. Create a Plivo Account(if you don’t have one already): You can sign up with your work email address and complete the phone verification step using your mobile number.
    2. Buy a Plivo number(optional): You must have a SMS-enabled Plivo phone number if you are willing to receive incoming SMS. You can purchase numbers from the Numbers section of your Plivo Console. It is also possible to purchase numbers using the Numbers API.

    Create the PHLO

    With PHLO, you can quickly create a workflow that suits your use case. To use PHLO, make sure to register and log on to Plivo Console.

    Use the following components to create this PHLO:

    • Send SMS

    When you send an API request to the PHLO, it triggers a SMS message to the user using the Send SMS component. This is a simple use case, yet it is one of the most widely used.

    Note: The Callback function provides the user details required to send the SMS message.

    To create this PHLO

    1. On the top navigation bar, click PHLO. The PHLO page will appear and display your existing PHLOs, if any exist. If this is your first PHLO, then the PHLO page will be empty.
    2. Click CREATE NEW PHLO to build a new PHLO.
    3. On the Choose your use-case window, click Build my own. The PHLO canvas will appear with the Start node. Note: The Start node is the starting point of any PHLO. You can choose between the four available trigger states of the Start node; Incoming SMS, Incoming Call, and API Request. For this PHLO, we will use the API Request trigger state.
    4. Click the Start node to open the Configurations tab and then enter the information to retrieve from the HTTP Request payload. For example, this could be a list of numbers to send an SMS message to.
    5. Click Validate to save the configurations for the node.
    6. From the list of components on the left-hand side, drag and drop the Send SMS component onto the canvas. This will add a Send SMS node onto the canvas.
    7. Connect the Start node with the Send SMS node, using the API Request trigger state.
    8. Rename the node to Send_Notification. Note: You can rename the nodes as per your requirements. We are using specific names to help you relate to the different nodes used in this use case.
    9. Next, configure the Send SMS node to select the From and To numbers from the Start node. Note: The SMS message can be static or dynamic. In this example, we will use a combination of a static message along with some dynamic message.
    10. On the Send SMS Configurations tab, enter a static message (For example, Your order status is: ) in the Message field, followed by a variable to include the dynamic text. You can choose a variable by entering two curly brackets in the Speak Text field. Note:
    11. Enter two curly brackets to view all available variables.
    12. The values for the From and To numbers are picked from the HTTP Request Payload. Make sure to clearly define the variables in the Start node.
    13. Click Validate to save the configurations for the node.
    14. After you complete the configurations, click Save. You can trigger your PHLO using the PHLO URL to test it out.

    Your complete PHLO will look like this:

    SMS Notification

    Set up Your Node.js Dev Environment

    You must set up and install Node and Plivo’s Node SDK to send SMS. Here’s how.

    Install Node.js

    Operating SystemInstructions
    macOS & LinuxYou would already have Node.js installed, you can check this by running the command node --version in the terminal. If you don't have it installed, you can install it from here .
    WindowsTo install Node.js on Windows you can download it from here and install.

    Install Plivo Node.js Package

    • Create a project directory, run the following command:

      $ mkdir mynodeapp
      
    • Change the directory to our project directory in the command line:

      $ cd mynodeapp
      
    • Install the SDK using npm

      $ npm install plivo
      

    Trigger the PHLO

    Once you have created and setup your Node.js dev envrironment, you can go to your Plivo Consolse and copy the PHLO_ID. You can integrate a PHLO into your application workflow by making an API request to trigger the PHLO with the required payload.

    With Static Payload

    You can choose to either configure the mandatory params required for a PHLO while creating the PHLO itself or, you can pass the params as payload while triggering the PHLO from your app.

    Note: When you configure the params while creating the PHLO, the values(From & To) are hardcoded, and they act as static payload.

    With Static Payload

    Code

    Now, create a file called TriggerPhlo.js and paste the below code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    
    var plivo = require('plivo');
    var PhloClient = plivo.PhloClient;
    
    var authId = 'auth-id';
    var authToken = 'auth-token';
    var phloId = 'PHLO_ID';
    var phloClient = phlo = null;
    
    phloClient = new PhloClient(authId, authToken);
    phloClient.phlo(phloId).run().then(function (result) {
        console.log('Phlo run result', result);
    }).catch(function (err) {
        console.error('Phlo run failed', err);
    });
    

    With Dynamic Payload

    To use dynamic values for the parameters, follow the below steps.

    • Select the Start node - under API request, fill the Payload key as From & To and keep the values empty, then click validate & save.

    With Dynamic Payload

    • Use the liquid templating params while creating the PHLO and pass the values while triggering the PHLO.

    With Dynamic Payload

    Code

    Now, create a file called TriggerPhlo.js and paste the below code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    
    var plivo = require('plivo');
    var PhloClient = plivo.PhloClient;
    
    var authId = 'auth-id';
    var authToken = 'auth-token';
    var phloId = 'PHLO_ID';
    var phloClient = phlo = null;
    
    var payload = {
        From: '+14157778888',
        To: '+14157778889',
    }
    phloClient = new PhloClient(authId, authToken);
    phloClient.phlo(phloId).run(payload).then(function (result) {
        console.log('Phlo run result', result);
    }).catch(function (err) {
        console.error('Phlo run failed', err);
    });
    

    You can get your Auth_ID and Auth_token from your dashboard AUTHID

    You can find the PHLO_ID on the PHLO Listing page. PHLO Listing

    Test and Validate

    You can save the file and use the below command to run your code.

    $ node TriggerPhlo.js
    
    Note: If you are using a Plivo Trial account for this example, you can only send SMS to phone numbers that have been verified with Plivo. Phone numbers can be verified at the Sandbox Numbers page.

    To implement SMS Marketing use-case in the traditional API way, you can refer to the instructions in the below section to begin your implementation.

    Outline

    Outbound-SMS Flow

    Implementation

    In this section, we will guide you in setting up an app using Plivo’s API to implement SMS Marketing use-case. First, let’s make sure you meet these prerequisites before we dive into the code.

    Prerequisites

    • Plivo Auth Id and Auth Token: You will find your Plivo Auth Id and Auth Token on the home screen of your Plivo Console. Click here to sign-up for a Plivo account if you haven’t already!

      Find Your Auth Credentials on Plivo Console

    • Plivo Phone Number(Optional): To send messages to the United States and Canada, you must have a Plivo phone number that supports SMS. Numbers can be purchased from the Numbers section of your Plivo Console and use the same as the source number/from number for the outbound SMS. This number will also help you receive incoming SMS as you must have a SMS-enabled Plivo phone number to do the same. Please note that you can also purchase numbers using the Numbers API.

      Buy a New Plivo Number

    Set up Your Node.js Dev Environment

    You must set up and install Node and Plivo’s Node SDK to implement voice alerts use-case. Here’s how.

    Install Node.js

    Operating SystemInstructions
    macOS & LinuxYou would already have Node.js installed, you can check this by running the command node --version in the terminal. If you don't have it installed, you can install it from here .
    WindowsTo install Node.js on Windows you can download it from here and install.

    Install Plivo Node.js Package

    • Create a project directory, run the following command:

      $ mkdir mynodeapp
      
    • Change the directory to our project directory in the command line:

      $ cd mynodeapp
      
    • Install the SDK using npm

      $ npm install plivo
      

    Send an Outbound SMS App

    Once you have the above prerequisites set, You can follow the below instructions to create an app to send an outbound SMS to deliver your message.

    Now, create a file called send_sms.js and paste the below code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    
    var plivo = require('plivo');
    
    (function main() {
        'use strict';
        var client = new plivo.Client("<auth_id>","<auth_token>");
        client.messages.create(
            "+14151234567",
            "+14157654321",
            "Hair Salon appointment reminder: haircut tomorrow at 10:30am with Charles. Any questions please call 0161 5555555.. Mbsports.com To optout text abcd to 89022",
          ).then(function (response) {
            console.log(response);
          },);
        })();
    
    Note:
    • Replace the placeholders auth_id & auth_token with your credentials from Plivo Console.
    • We recommend that you store your credentials in the auth_id & auth_token environment variables, so as to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and it will automatically fetch them from the environment variables
    • You can use process.env to store environment variables and fetch them while initializing the client.
    • Replace the placeholder +14151234567 with the Phone number which you have purchased and +14157654321 with the phone number you will be sending SMS to.
    • Both +14151234567 and +14157654321 should be in E.164 format
    • For other countries, this can be either a Alpha Sender ID or Numeric Sender ID based on the Sender ID support for the respective countries, to know more you can refer to the Sender ID Usage guide

    Test and Validate

    Once you have created the Send SMS App, You can save the file and use the below command to run your code.

    $ node send_sms.js
    
    Note: If you are using a Plivo Trial account for this example, you can only send SMS to phone numbers that have been verified with Plivo. Phone numbers can be verified at the Sandbox Numbers page.