Download the PHP package infince/plivo-php-sdk without Composer

plivo-php

The Plivo PHP SDK makes it simpler to integrate communications into your PHP applications using the Plivo REST API. Using the SDK, you will be able to make voice calls, send SMS and generate Plivo XML to control your call flows.

Supported PHP Versions: This SDK works with PHP 7.1.0+.

Note

    Compoer will only take branches starting with 'dev-'. It will not take any other branches. Also branches should not have any other charachers like '.'. While 'dev-infince-plivo' is accepted, 'dev-infince-plivo-4.21' will not be. Composer will throw an error saying it cannot checkout to this branch.

To Install using Infince Fork, put the following in composer.json

     "repositories": [
            //...
            {
                    "type": "package",
                    "package": {
                    "name": "plivo/plivo-php",
                    "version": "dev-infince-plivo",
                    "source": {
                            "url": "https://github.com/infince/plivo-php.git",
                            "type": "git",
                            "reference": "dev-infince-plivo"
                    },
                    "autoload": {
                            "classmap": [""]
                    }
                    }
            },
            //...
     ],

1. Run the following:

   $ composer update

While commiting and pushing to the plivo repository

1. In the Infince project folder, remove plivo package in vendor.

    $ rm -rf vendor/plivo

2. Clear Composer cache.

    $ composer clear-cache

3. Run composer update again to see the changes.

    $ composer update

   Installation

To install Composer

Globally in Mac

1. Download the latest version of Composer.

2. Run the following command in Terminal:

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

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 

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

   $ composer --version.       

Globally in Linux

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

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

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

Windows 10

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

Steps to install Plivo Package

• 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.14.0

• To test the features in the beta release, run the following command in the project directory:

  $ composer require plivo/plivo-php:v4.2-beta1

• 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.

Getting started

Authentication

To make the API requests, you need to create a RestClient and provide it with authentication credentials (which can be found at https://console.plivo.com/dashboard/).

We recommend that you store your credentials in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables, so as to avoid the possibility of accidentally committing them to source control. If you do this, you can initialise the client with no arguments and it will automatically fetch them from the environment variables:

Alternatively, you can specifiy the authentication credentials while initializing the RestClient.

The Basics

The SDK uses consistent interfaces to create, retrieve, update, delete and list resources. The pattern followed is as follows:

You can also use the resource directly to update and delete it. For example,

Also, using $client->resources->list() would list the first 20 resources by default (which is the first page, with limit as 20, and offset as 0). To get more, you will have to use limit and offset to get the second page of resources.

Examples

Send a message

Make a call

Lookup a number

Generate Plivo XML

This generates the following XML:

Run a PHLO

More examples

More examples are available here. Also refer to the guides for configuring the PHP laravel to run various scenarios & use it to test out your integration in under 5 minutes.

Reporting issues

Report any feedback or problems with this version by opening an issue on Github.