PHP SDK
The Plivo PHP SDK makes it simpler to integrate voice and SMS communications into your PHP applications using the Plivo REST APIs. Using the SDK, you’ll be able to make voice calls, send SMS messages, and generate Plivo XML documents to control your call flows.
Installation
To install Composer
Globally in Mac
-
Download the latest version of Composer.
-
Run in Terminal:
-
To make Composer executable , run:
-
To check whether the path already includes /usr/local/bin, run:
If necessary, update the $PATH by running:
-
Check the version of Composer by running:
Globally in Linux
-
Run:
-
To make the composer.phar file executable, run:
-
To make Composer globally available for all system users, run:
Windows 10
-
Download and run the Windows Installer for Composer.
Make sure to allow Windows Installer for Composer to make changes to your php.ini file.
-
If you have any terminal windows open, close them and open a fresh terminal instance.
-
Run the Composer command.
To install the Plivo package
-
To install the stable release, run this command in the project directory:
-
To install a specific or beta release, run this command in the project directory, specifying the release:
-
Alternatively, you can download this source and run:
This command generates the autoload files, which you can include using a line in your PHP source code:
Getting started
Authentication
To make the API requests, you need to create a RestClient
and provide it with authentication credentials, which you can find on the Overview page of the Plivo console.
We recommend that you store your credentials in the PLIVO_AUTH_ID
and the PLIVO_AUTH_TOKEN
environment variables, 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:
Alternatively, you can specify the authentication credentials while initializing the RestClient
.
Replace the auth placeholders with your authentication credentials from the Plivo console.
The basics
The SDK uses consistent interfaces to create, retrieve, update, delete, and list resources. The pattern is:
You can also use the resource
directly to update and delete it. For example:
Using $client->resources->list()
lists the first 20 resources by default (the first page, with limit
as 20, and offset
as 0). Use limit
and offset
to get more pages of resources.
Examples
Send a message
Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).
Make a call
Generate Plivo XML
This generates the following XML:
Run a PHLO
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.
More examples
Refer to the Plivo API Reference documentation for more examples. Also refer to our guide to setting up dev environment for details on how to set up a simple PHP server and expose that server to the internet.
Example response
Reporting issues
Report feedback or problems with this SDK by opening an issue on GitHub.