The Node.js SDK makes it simpler to integrate communications into your Node.js 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.
Install the SDK using npm
$ npm install plivo
If you have the
0.4.1 version (a.k.a legacy) already installed, you may have to first uninstall it before installing the new version.
For features in beta, use the beta branch:
$ npm install plivo@beta
To make the API requests, you need to create a
Client and provide it with authentication credentials (which can be found at https://manage.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:
let plivo = ;let client = ;
Alternatively, you can specifiy the authentication credentials while initializing the
let plivo = ;let client = '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:
clientresources; // Createclientresources; // Getclientresources; // Updateclientresources; // Deleteclientresources; // List all resources, max 20 at a time
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
let plivo = ;let client = ;clientmessages;
Make a call
let plivo = ;let client = ;clientcalls;
Generate Plivo XML
let plivo = ;let response = ;let speak_body = "Hello, world!";response;console;
This generates the following XML:
Run a PHLO
var plivo = ;var PhloClient = plivoPhloClient;var authId = 'auth-id';var authToken = 'auth-token';var phloId = 'PHLO_ID';var phloClient = phlo = null;// Run phlophloClient = authId authToken;phloClient;
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 an Express 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.