Set up your PHP dev environment for PHLO

    In this guide, you will learn how to set up a development environment in under 5 minutes to trigger a PHLO.

    Prerequisites

    Install PHP and the Plivo PHP SDK

    You must set up and install PHP and Plivo’s PHP SDK to trigger a PHLO. Here’s how.

    Install PHP

    Operating SystemInstructions
    OS XYou 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 install 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

    • To install a specific release, run the following command in the project directory:

      $ composer require plivo/plivo-php:4.3.1

    • Alternatively, you can download this source and run

      $ composer install

    This generates the autoload files, which you can include using the following line in your PHP source code to start using the SDK.

    <?php
require 'vendor/autoload.php'

    Trigger a PHLO

    Once you have created and configured your PHLO, copy the PHLO Run URL. You can integrate a PHLO into your application workflow by making an API request to the PHLO URL 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 they act as static payload.

    With Static Payload

    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("YOUR_PHLO_ID");
try {
    $response = $phlo->run();
    print_r($response);
} catch (PlivoRestException $ex) {
    print_r($ex);
}

    With Dynamic Payload

    To use dynamic values for the parameters, you can use the liquid templating params while creating the PHLO and pass the values while triggering the PHLO.

    With Dynamic Payload

    Code

    1
2
3
4
5
6
7
8
9
10
11
12

    require 'vendor/autoload.php';
use Plivo\Resources\PHLO\PhloRestClient;
use Plivo\Exceptions\PlivoRestException;
$client = new PhloRestClient("auth_id", "auth_token");

$phlo = $client->phlo->get("YOUR_PHLO_ID");
try {
    $response = $phlo->run(["from" => "+14157778888", "to" => "+14157778889"]); // These are the fields entered in the PHLO console
    print_r($response);
} catch (PlivoRestException $ex) {
    print_r($ex);
}

    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