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.
You can use the SDK using composer. Run the following command in your project directory to update your
composer.json file and download the SDK.
$ composer require plivo/php-sdk
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'
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:
<?php require 'vendor/autoload.php'; use Plivo\RestClient; $client = new RestClient();
Alternatively, you can specifiy the authentication credentials while initializing the
<?php require 'vendor/autoload.php'; use Plivo\RestClient; $client = new RestClient("your_auth_id", "your_auth_token");
The SDK uses consistent interfaces to create, retrieve, update, delete and list resources. The pattern followed is as follows:
<?php $client->resources->create($params) # Create $client->resources->get($id) # Get $client->resources->update($id, $params) # Update $client->resources->delete($id) # Delete $client->resources->list() # List all resources, max 20 at a time
You can also use the
resource directly to update and delete it. For example,
<?php $resource = $client->resources->get($id) $resource->update($params) # update the resource $resource->delete() # Delete the resource
$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
offset to get the second page of resources.
Send a message
<?php require 'vendor/autoload.php'; use Plivo\RestClient; $client = new RestClient(); $message_created = $client->messages->create( 'the_source_number', ['the_destination_number'], 'Hello, world!' );
Make a call
<?php require 'vendor/autoload.php'; use Plivo\RestClient; $client = new RestClient(); $call_made = $client->calls->create( 'the_source_number', ['the_destination_number'], 'https://answer.url' );
Generate Plivo XML
<?php require 'vendor/autoload.php'; use Plivo\XML\Response; $response = new Response(); $response->addSpeak('Hello, world!'); echo($response->toXML());
This generates the following XML:
<?xml version="1.0" encoding="utf-8"?> <Response> <Speak>Hello, world!</Speak> </Response>
Refer to the Plivo API Reference for more examples. Also refer to the guide to setting up dev environment on Plivo Developers Portal to setup a simple PHP server & use it to test out your integration in under 5 minutes.
Report any feedback or problems with this version by opening an issue on Github.