Conduct SMS Surveys Using PHP

    Overview

    This guide shows how to conduct an SMS survey. Surveys can help businesses with market research. Using SMS for surveys lets organizations process input quickly and efficiently.

    You can conduct SMS surveys either by using our PHLO visual workflow builder or our APIs. Follow the instructions in one of the tabs below.

    You can create and deploy a PHLO to conduct an SMS survey with a few clicks on the PHLO canvas and trigger it with a few lines of code.

    How it works

    Prerequisites

    To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. If this is your first time triggering a PHLO with PHP, follow our instructions to set up a PHP development environment.

    Create the PHLO

    To create a PHLO, visit the PHLO page of the Plivo console. If this is your first PHLO, the PHLO page will be empty.

    • Click Create New PHLO.

    • In the Choose your use case pop-up, click Build my own. The PHLO canvas will appear with the Start node.

      Note: The Start node is the starting point of any PHLO. It lets you trigger a PHLO to start upon one of three actions: incoming SMS message, incoming call, or API request.
    • If you plan to use a dynamic payload — passing values through parameters when you trigger the PHLO from your application — click on the Start node to open the Configuration pane. Under API Request, enter key names for the variables you want use in your payload — From, To, and Message fields.

    • Once you’ve configured the node, click Validate to save the configuration.

    • From the list of components on the left-hand side, drag and drop the Send Message component onto the canvas. When a component is placed on the canvas it becomes a node.

    • Draw a line to connect the Start node’s API Request trigger state to the Send Message node.

    • In the Configuration pane at the right of the canvas, configure the Send Message node with a sender ID in the From field. Enter the destination numbers you wish to send a message to in the To field. Put your message in the Text field.

      Note: You can define a static payload by specifying values when you create the PHLO, or define a dynamic payload by passing values through Liquid templating parameters when you trigger the PHLO from your application.
    • Once you’ve configured the node, click Validate to save the configuration.

    • From the list of components on the left-hand side, drag and drop the Branch component onto the canvas.

    • Draw a line to connect the Start node’s Incoming Message trigger state to the Branch node.

    • In the Configuration pane at the right of the canvas, configure the Branch node. Rename the node to Handle_Reply. For Variable to compare, enter two curly braces to view all available variables, then select Start.message.msg.

    • Click the pencil icon and name the first condition Satisfied. Leave the Operation “is equal to” and enter a value of 1.

    • Add a second condition. Name it Not Satisfied and enter a value of 2.

    • Once you’ve configured the node, click Validate to save the configuration.

    • Drag two Send Message nodes onto the canvas. Draw lines to connect them to the Handle_Reply node using the Satisfied and Not Satisfied trigger states.

    • In the Configuration pane for each of the Send Message nodes, specify the From and To keys you configured in the Start node. Enter two curly brackets to display a list of all available variables. In the Message field, you can enter a static message, or combine static text with a variable that includes dynamic text if you specified the variable as a key in the Start node configuration pane.

    • Rename the nodes Reply_Satisfied and Reply_NotSatisfied.

    • Once you’ve configured the nodes, click Validate to save their configurations.

    • From the list of components on the left-hand side, drag and drop the HTTP Request component onto the canvas. Draw four lines to connect the Sent and Failed trigger states of both the Reply_Satisfied and Reply_NotSatisfied nodes to the HTTP Request node.

    • In the Configuration pane for the HTTP Request node, rename the node to Handle_Callback. Enter URL to make the request to. The default method used is GET, but you can click on the box to choose POST, PUT, or DELETE instead. Specify Headers, Auth, Params, and Body values on their respective tabs as necessary.

    • Once you’ve configured the node, click Validate to save the configuration.

    After you complete the configuration, give the PHLO a name by clicking in the upper left, then click Save.

    Your complete PHLO should look like this:

    SMS Survey

    Your PHLO is now ready to test.

    Trigger the PHLO

    You integrate a PHLO into your application workflow by making an API request to trigger the PHLO with the required payload — the set of parameters you pass to the PHLO. You can define a static payload by specifying values when you create the PHLO, or define a dynamic payload by passing values through parameters when you trigger the PHLO from your application.

    In either case, you need your Auth ID and Auth Token, which you can get from the overview page of the Plivo console.

    AUTHID

    You also need the PHLO ID, which you can copy from the PHLO list page.

    PHLO List

    With a static payload

    When you configure values when creating the PHLO, they act as a static payload.

    With Static Payload

    Code

    Create a file called TriggerPhlo.php and paste into it this code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    
    <?php
    require 'vendor/autoload.php';
    use Plivo\Resources\PHLO\PhloRestClient;
    use Plivo\Exceptions\PlivoRestException;
    $client = new PhloRestClient("<auth_id>", "<auth_token>");
    
    $phlo = $client->phlo->get("<phlo_id>");
    try {
        $response = $phlo->run();
        print_r($response);
    } catch (PlivoRestException $ex) {
        print_r($ex);
    }
    

    Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phlo_id placeholder with your PHLO ID from the Plivo console.

    With a dynamic payload

    To use dynamic values for the parameters, use Liquid templating parameters when you create the PHLO …

    With Dynamic Payload

    … and pass the values from your code when you trigger it.

    With Dynamic Payload

    Code

    Create a file called TriggerPhlo.php and paste into it this code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    
    <?php
    require 'vendor/autoload.php';
    use Plivo\Resources\PHLO\PhloRestClient;
    use Plivo\Exceptions\PlivoRestException;
    $client = new PhloRestClient("<auth_id>", "<auth_token>");
    
    $phlo = $client->phlo->get("<phlo_id>");
    try {
        $response = $phlo->run(["From" => "<sender_id>", "To" => "<destination_number>"]); // These are the fields entered in the PHLO console
        print_r($response);
    } catch (PlivoRestException $ex) {
        print_r($ex);
    }
    

    Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phlo_id placeholder with your PHLO ID from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).

    Test

    Save the file and run it.

    php TriggerPhlo.php
    
    Note: If you’re using a Plivo Trial account, you can send SMS messages only to phone numbers that have been verified with Plivo. You can verify (sandbox) a number by going to the console’s Phone Numbers > Sandbox Numbers page.

    To implement SMS Survey 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 Survey 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 PHP Dev Environment

    You must set up and install PHP and Plivo’s PHP SDK to implement send SMS use-case. Here’s how.

    Install PHP

    Operating SystemInstructions
    macOSYou can install PHP using the official installer. You can also install it from here.
    LinuxTo install PHP on Linux you can find the instructions here.
    WindowsTo instll PHP on Windows you can use the official installer.

    Install Composer

    Composer is a dependency manager for PHP that is used in all modern PHP frameworks, such as Symfony and Laravel. We highly recommend using Composer as the package manager for your web project.

    1. Download the latest version of Composer.
    2. Run the following command in Terminal in order to run the composer:

       $ php ~/Downloads/composer.phar --version
      

      Note: PHAR (PHP archive) is an archive format for PHP that can be run on the command line

    3. Run the following command to make it executable:

       $ cp ~/Downloads/composer.phar /usr/local/bin/composer
       $ sudo chmod +x /usr/local/bin/composer
       $ Make sure you move the file to bin directory.
      
    4. To check if the path has /usr/local/bin, use

       $ echo $PATH
      

      If the path is different, use the following command to update the $PATH:

       $ export PATH = $PATH:/usr/local/bin
       $ source ~/.bash_profile
      

      Note: If your PATH doesn’t include /usr/local/bin directory, we recommend adding it so that you can access it globally.

    5. You can also check the version of Composer by running the following command:

       $ composer --version.       
      

    1. Run the following command:

       $ curl -sS https://getcomposer.org/installer | php
      
    2. Run the following command to make the composer.phar file as executable:

       $ chmod +x composer.phar
      

      Note: PHAR (PHP archive) is an archive format for PHP that can be run on the command line

    3. Run the following command to make Composer globally available for all system users:

       $ mv composer.phar /usr/local/bin/composer
      

    1. Download and run the Windows Installer for Composer.

      Note: Make sure to allow Windows Installer for Composer to make changes to your php.ini file.

    2. If you have any terminal windows open, close all instances and open a fresh terminal instance.
    3. Run the Composer command.

       $ composer -V
      

    Install Plivo PHP Package

    • Create a project directory, run the following command:

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

      $ cd myphpapp
      
    • To install the stable release, run the following command in the project directory:

      $ composer require plivo/plivo-php
      
    • Alternatively, you can download this source and run

      $ composer install
      

    Create the Send 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 SendSMS.php and paste the following code:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    
    <?php
    require 'vendor/autoload.php';
    use Plivo\RestClient;
    $client = new RestClient("<auth_id>","<auth_token>");
    $response = $client->messages->create(
       [  
            "src" => "+14152345678",
            "dst" => "+14151112222",
            "text"  =>"To win a holiday to your dream destination, text ‘MyHolidaydestination’ to 777-444-5555. Winners announced this Friday at the Tennery Shopping Center.",
            "url"=>"http://foo.com/sms_status/",
       ]
    );
    print_r($response);
    ?>
    
    Note:
    • Replace the placeholders auth_id & auth_token with your credentials from yourPlivo 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 $_ENV or putenv/getenv function 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 plivo_source_number 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.

    $ php SendSMS.php
    
    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.