Get Started with Node.js using NestJS Framework

    Sign up for a Plivo Account

    When you sign up with Plivo, you will start with a free trial account to experiment with and learn about our services. This free trial account comes with free credits. If you wish to continue with our service, you can add more credits and purchase a number by clicking here. Add a number and credits to your account to start testing the full range of our voice and SMS service features.

    Sign up here to get your free Plivo account today.

    Follow these steps to successfully sign up for a free trial account:

    1. Sign up with your work email address
    2. Check your inbox for an activation email from Plivo. Click on the link in the email to activate your account.
    3. Enter your mobile number to complete the phone verification step.

    Sign up with your work email address

    Sign up with email addres

    If you have any issues creating a Plivo account, please reach out to our Support Team for assistance.

    Start your implementation with Plivo to send/receive messages using PHLO or the traditional API/XML way. PHLO allows you to create the call flows using its intuitive canvas and deploy it with few clicks. Refer to the instructions from the respective tabs below to start your integration with PHLO or API as you wish.

    Send your First Outbound SMS/MMS

    To send your first outbound sms, you can create and deploy a PHLO in just a few clicks using the PHLO canvas. PHLO also lets you visually construct your entire use-case. With PHLO, only pay for sms you send/receive. Building with PHLO is free.

    Prerequisites

    1. Create a Plivo account (if you don’t have one already): Sign up with your work email address and complete the phone verification step using your mobile number.
    2. Set Up Your Node.js & NestJS Dev Environment: To set up your dev environment in Node.js, please refer to the instructions available in the Set Up Your Node.js & NestJS Dev Environment section.
    3. Buy a Plivo Number(optional): You must have an SMS-enabled Plivo phone number if you wish to receive incoming sms. Purchase numbers from the Numbers section of your Plivo Console. It is also possible to purchase numbers using the Numbers API.

    Create the PHLO

    Create a PHLO to send your first outbound SMS/MMS by following these instructions:

    • On the side 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.
    • Click Create New PHLO to build a new PHLO.
    • In 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.
    • From the list of components on the left-hand side, drag and drop the Send Message component onto the canvas. This will add an Send Message node onto the canvas.
    • Connect the Start node with the Send Message node, using the API Request trigger state.
    • Configure the Send Message node with the source/from number using the From field. Enter the destination number you wish to send message in the To field.
    • If you’d like to send MMS then Configure the Media URLs node with the Media files you’d like to send using the Media URLs field.
    • Once you have configured the node, click Validate to save the configurations.
    • After you complete the configurations, provide a recognizable name for your PHLO and click Save. Your PHLO is now ready. You can trigger the PHLO and test it out. For more information, refer to the following section.

    Set Up Your Node.js & NestJS Dev Environment

    You must set up and install Node and Plivo’s Node SDK to send your first outbound sms. Here’s how.

    Install Node.js

    Operating SystemInstructions
    macOS & LinuxTo see if you already have Node.js installed, run 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

    • Install Nest CLI using npm

      $ npm i @nestjs/cli
      
    • Create a new NestJS project using the following command:

      $ nest new plivovoice
      
    • Change the directory to our project directory in the command line:

      $ cd plivovoice
      
    • Install the Plivo Node.js 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. 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 are hardcoded and act as static payload.

    With Static Payload

    Code

    Now, open the app.controller.ts file and paste the following code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    
    import { Controller, Get, Post, Res, HttpStatus } from '@nestjs/common';
    import { Response } from 'express';
    import { AppService } from './app.service';
    const plivo = require('plivo');
    
    @Controller()
    export class AppController {
      constructor(private readonly appService: AppService) {}
      
      @Get('/trigger_phlo/')
      triggerPhlo() {
        const PhloClient = plivo.PhloClient;
        const authId = 'Auth_ID';
        const authToken = 'Auth_token';
        const phloId = 'PHLO_ID';
        const 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 StartNode - 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, open the app.controller.ts file and paste the following code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    
    import { Controller, Get, Post, Res, HttpStatus } from '@nestjs/common';
    import { Response } from 'express';
    import { AppService } from './app.service';
    const plivo = require('plivo');
    
    @Controller()
    export class AppController {
      constructor(private readonly appService: AppService) {}
    
      @Get('/trigger_phlo')
      triggerPhlo() {
        const PhloClient = plivo.PhloClient;
        const authId = 'Auth_ID';
        const authToken = 'Auth_token';
        const phloId = 'PHLO_ID';
        const payload = {
          From: '+14157778888',
          To: '+14157778889',
        };
    
        const 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);
          });
      }
    }
    

    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

    Save the file and use the below command to start the NestJS application.

    $ npm run start
    

    And you should see your basic server app in action on http://localhost:3000/trigger_phlo/

    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.

    Receive Your First Inbound SMS/MMS

    Create and deploy a PHLO to receive your first inbound SMS and forward to your web server with a few clicks on the PHLO canvas. PHLO also lets you visually construct your entire use-case. With PHLO, only pay for calls you make/receive. Building with PHLO is free.

    Prerequisites

    1. Create a Plivo account (if you don’t have one already): Sign up with your work email address and complete the phone verification step using your mobile number.
    2. Buy a Plivo number: You must have a sms-enabled Plivo phone number to receive incoming calls. Purchase numbers from the Numbers section of your Plivo Console. It is also possible to purchase numbers using the Numbers API.
    3. PHLO Application: When you receive a call on a Plivo sms-enabled number, you can control the call flow by associating a PHLO application to that Plivo phone number. Plivo will fetch the PHLO associated with the number and expect valid instructions via PHLO to handle the sms.

    Create the PHLO

    You can create a PHLO by referring to the below instructions to receive your first incoming call:

    • On the side 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.
    • Click Create New PHLO to build a new PHLO.
    • In 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 Incoming Message trigger state.
    • From the list of components on the left-hand side, drag and drop the HTTP Request component onto the canvas. This will add a HTTP Request node onto the canvas.
    • Connect the Start node with the HTTP Request node, using the Incoming Message trigger state.
    • Configure the HTTP Request node to send the details to your Web Server.
    • Once you have configured the node, click Validate to save the configurations.
    • After you complete the configurations, provide a recognizable name for your PHLO and click Save. Your PHLO is now ready.

    Assign the PHLO to a Plivo Number for Incoming SMS/MMS

    Once you have created and configured your PHLO, assign your PHLO to a Plivo number.

    To assign a PHLO to a number:

    1. Log in to your Plivo Console
    2. On the Product Navigation bar, click Phone Numbers.
    3. On the Numbers page, under Your Numbers, click the phone number you wish to use for the PHLO.
    4. In the Number Configuration window, select PHLO from the Application Type list.
    5. From the PHLO Name list, select the PHLO you wish to use with the phone number, and then click Update Number.

    Assign PHLO to a Plivo Number

    If you have not purchased a phone number yet, you can buy a phone number(s) by referring to the instructions available here.

    Test and Validate

    You can now send a message to your Plivo phone number to receive an incoming sms and see how the inbound sms is handled using PHLO.

    For more information about creating a PHLO app, see the PHLO User Guide.
    For information on components and their variables, see the PHLO Components Library.

    Forward an Incoming SMS/MMS

    To forward an incoming sms, you can create and deploy a PHLO with a few clicks on the PHLO canvas.

    Prerequisites

    1. Create a Plivo account (if you don’t have one already): Sign up with your work email address and complete the phone verification step using your mobile number.
    2. Buy a Plivo number: You must have a sms-enabled Plivo phone number to receive incoming sms. Purchase numbers from the Numbers section of your Plivo Console. It is also possible to purchase numbers using the Numbers API.
    3. PHLO Application: When you receive a sms on a Plivo sms-enabled number, you can control the flow by associating a PHLO application to that Plivo phone number. Plivo will fetch the PHLO associated with the number and expect valid instructions via PHLO to handle the sms.

    Create the PHLO

    You can create a PHLO by referring to the below instructions to forward an incoming SMS/MMS:

    • On the side 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.
    • Click Create New PHLO to build a new PHLO.
    • In 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 Incoming Message trigger state.
    • From the list of components on the left-hand side, drag and drop the Send Message component onto the canvas. This will add a Send Message node onto the canvas.
    • Connect the Start node with the Send Message node, using the Incoming Message trigger state.
    • Configure the Send Message node with the phone number to which you want to forward the Message. For example, in this case, “+14157778889”.
    • Once you have configured the node, click Validate to save the configurations.
    • After you complete the configurations, provide a recognizable name for your PHLO and click Save. Your PHLO is now ready.

    Assign the PHLO to a Plivo Number to Forward Incoming SMS

    Once you have created and configured your PHLO, assign your PHLO to a Plivo number.

    To assign a PHLO to a number:

    1. Log in to your Plivo Console
    2. On the Product Navigation bar, click Phone Numbers.
    3. On the Numbers page, under Your Numbers, click the phone number you wish to use for the PHLO.
    4. In the Number Configuration window, select PHLO from the Application Type list.
    5. From the PHLO Name list, select the PHLO you wish to use with the phone number, and then click Update Number.

    Assign PHLO to a Plivo Number

    If you have not purchased a phone number yet, you can buy a phone number(s) by referring to the instructions available here.

    Test and Validate

    You can now send a sms to your Plivo phone number and see how the inbound sms is forwarded to the phone number specified in the PHLO.

    For more information about creating a PHLO app, see the PHLO User Guide.
    For information on components and their variables, see the PHLO Components Library.

        <h2 id="api-install-nestjs-and-the-plivo-node-js-server-sdk">Install NestJS and the Plivo Node.js Server SDK</h2>
    

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

    Install Plivo Node.js Package

    • Install Nest CLI using npm

      $ npm i @nestjs/cli
      

      Choose npm package manager when prompted for which package manager to be used.

    • Create a new NestJS project using the following command:

      $ nest new plivosms
      
    • Change the directory to our project directory in the command line:

      $ cd plivosms
      
    • Install the Plivo Node.js SDK using npm

      $ npm install plivo
      

    Send your first Outbound SMS/MMS

    This section will guide you through how to use Plivo APIs to Send SMS from your application. First, let’s make sure you meet these prerequisites before we dive into the code.

    • 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: You must have a SMS-enabled Plivo phone number to send messages to the US and Canada. Purchase numbers from the Numbers section of your Plivo Console. It is also possible to purchase numbers using the Numbers API.

    Buy a New Plivo Number

    Now, open the app.controller.ts which is within src folder file and paste the following code.

    Code

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    
    import {Controller,Get,Post,Res,HttpStatus} from '@nestjs/common';
    import {Response} from 'express';
    import {AppService} from './app.service';
    const plivo = require('plivo');
    
    @Controller()
    export class AppController {
        constructor(private readonly appService: AppService) {}
    
        @Get('/outbound')
        sendSMS() {
            const client = new plivo.Client('<auth_id>', '<auth_token>');
            client.messages.create({
                    src: '<Caller_ID>',
                    dst: '<Destination_Number>',
                    text: 'Hello, from Nest!'
                })
                .then(
                    function(response) {
                        console.log(response);
                    },
                    function(err) {
                        console.error(err);
                    },
                );
        }
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    
    import {Controller,Get,Post,Res,HttpStatus} from '@nestjs/common';
    import {Response} from 'express';
    import {AppService} from './app.service';
    const plivo = require('plivo');
    
    @Controller()
    export class AppController {
        constructor(private readonly appService: AppService) {}
    
        @Get('/outbound')
        sendMMS() {
            const client = new plivo.Client('<auth_id>', '<auth_token>');
            client.messages.create(
                    {
                        src: '<Caller_ID>',
                        dst: '<Destination_Number>',
                        text: 'Hello, MMS from Nest!',
                        type: 'mms',
                        media_urls: ['https://media.giphy.com/media/26gscSULUcfKU7dHq/source.gif'],
                        media_ids: ['801c2056-33ab-499c-80ef-58b574a462a2']
                    }
                )
                .then(
                    function(response) {
                        console.log(response);
                    },
                    function(err) {
                        console.error(err);
                    },
                );
        }
    }
    
    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
    • 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

    Save the file and use the below command to start the NestJS application.

    $ npm run start
    

    And you should see your basic server app for outbound calls in action on http://localhost:3000/outbound/

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

    Set up a NestJS server for Incoming SMS & Callbacks

    In this section, we’ll walk you through how to set up a NestJS server in under five minutes and start handling incoming calls & callbacks.

    Plivo supports receiving SMS text messages in several countries (see complete SMS API coverage). When an SMS is sent to a Plivo phone number, you can receive the text on your server by setting a Message URL in your Plivo app. Plivo will send the message along with other parameters to your Message URL.

    Use the following code snippet to start a local server.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    
    import { Controller, Get, Post, Res, HttpStatus } from '@nestjs/common';
    import { Response } from 'express';
    import { AppService } from './app.service';
    const plivo = require('plivo');
    
    @Controller()
    export class AppController {
        constructor(private readonly appService: AppService) {}
    
        @Get('/outbound')
        sendSMS() {
            ..........;
            ..........;
        }
        @Post('/receive')
        async createPosting(@Body('From') from: string, @Body('To') to: string,@Body('Text') text: string) {
        return `Filter for ${from} ${to} ${text}`;
      }
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    
    import { Controller, Get, Post, Res, HttpStatus } from '@nestjs/common';
    import { Response } from 'express';
    import { AppService } from './app.service';
    const plivo = require('plivo');
    
    @Controller()
    export class AppController {
        constructor(private readonly appService: AppService) {}
    
        @Get('/outbound')
        sendSMS() {
            ..........;
            ..........;
        }
        @Post('/receive')
        async createPosting(@Body('From') from: string, @Body('To') to: string,@Body('Text') text: string,@Body('Media0') media_url: string) {
        return `Filter for ${from} ${to} ${text} ${media_url}`;
      }
    }
    

    Save the file and use the below command to start the NestJS application.

    $ npm run start
    

    And you should see your basic server app for inbound calls in action on http://localhost:3000/inbound/

    Exposing your local server to the internet

    To receive Incoming SMS and to handle callbacks, your local server should be able to connect with Plivo API service, Ngrok is a tunneling software used to expose a web server running on your local machine to the internet. Using Ngrok you can set webhooks which can talk to Plivo server.

    ngrok block diagram

    You can download and install ngrok from here. Follow the detailed configuration instructions to get started.

    Run ngrok on the port which currently hosts your application. For example, if your port number is 80, run the following command:

    ./ngrok http <port_on_which_your_local_server_is_running>
    

    This will give you a UI with links that look like ngrok.io/* which you can use to access your local server using the public network.

    Sample ngrok CLI

    Create an Application

    1. Create an Application by visiting the Application Page and click on New Application. You can also use Plivo’s Application API.
    2. Give your application a name. Let’s call it Receive SMS. Enter your server URL (e.g. http://example.com/receive_sms/) in the Message URL field and set the method as POST. See our Application API docs to learn how to modify your application through our APIs.
    3. Click on Create Application to save your application.

    Create Application

    Assign a Plivo number to your app

    1. Navigate to the Numbers page and select the phone number you want to use for this app.
    2. Select Receive SMS (name of the app) from the Plivo App dropdown list.
    3. Click on Update Number to save.

    Assign Phone Number to Receive SMS App

    Test and validate

    Send an SMS to your Plivo number using a regular mobile phone. Plivo will send a request to your Message URL with the parameters listed in the Messages Documentation.

    Reply to an incoming SMS/MMS

    When an SMS is sent to an Plivo phone number, you can receive the text on your server by setting a Message URL in your Plivo app. Plivo will send the message along with other parameters to your Message URL. You can reply back using the Plivo Message XML.

    Note: In order to reply to a US or Canadian phone number, the `'src'` (source) phone number must be a Plivo US or Canadian phone number that is SMS-enabled. You can purchase a Plivo number from the Buy Numbers tab on your Plivo Console and filter the Phone Numbers by selecting SMS in the features option to buy SMS enabled numbers.

    Create a file called reply_sms.js and paste the following code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    
    import {Controller,Get,Post,Res,HttpStatus} from '@nestjs/common';
    import {Response} from 'express';
    import {AppService} from './app.service';
    const plivo = require('plivo');
    
    @Controller()
    export class AppController {
        constructor(private readonly appService: AppService) {}
    
        @Get('/outbound')
        sendSMS() {
            ..........;
            ..........;
        }
        @Get('/inbound')
        xmlResponse(@Res() res: Response) {
            ..........;
            ..........;
        }
        
        // Reply to incoming messages.
        @Post('/receive')
        async createPosting(@Body('From') from: string, @Body('To') to: string, @Body('Text') text: string) {
            console.log('Message received - From: ' + from + ', To: ' + to + ', Text: ' + text);
            var message_body = "Thank you, we've received your request"; //The text which was received
            r.addMessage(message_body, params);
            console.log(r.toXML()); //Prints the XML
            res.set('Content-Type', 'text/xml');
            res.send(r.toXML());
        }
    
    }
    
    Note: Create an application in the Plivo console with your Server URL in the message_URL field and assign the app to a Plivo number.

    Test and validate

    Save the file and use the below command to start the NestJS application.

    $ npm run start
    

    And you should see your basic server app in action on http://localhost:3000/forward/

    Send an SMS to your Plivo number using a regular mobile phone and an automatic response will be sent from your Plivo number to your mobile phone. Also, Plivo will send a request to your Message URL with the parameters listed in the Messages Documentation.