mirror of
https://github.com/donl/plivo-node.git
synced 2026-05-31 22:07:36 -06:00
a4e3f9fd47
* Added phlo client. * Finished implementaiton of initializing phlo client. * Finished logic for v2 methods of multiparty call(not members). * Added test cases for multiparty call. * Finished logic for phlo get api. * Added member method structure. * Finished implementation of phlo.run(). * Finished api calls for multi party(except abort transfer). * Deleted old rest.js file. * Finished abortTranfer implementation with test cases. * Finished implementation of member.resumeCall(). * Finished all member functions. * Reverted debugging logic. * Removed console.log * Added samples for all apis. method structure change for abort transfer. * Resolved nsp issue. * Audit fix. * Package Lock Fix. * Added test proxy for test cases. * Resolved issue in request.js json format. * Improved comments. * Added test cases for .get() methods. * Removed async await to support older browsers. * Modified examples of phlo, removed async await. * Resolved example issues, remove auth credentials. * Removed es6 declaration syntaxes from phlo example. * Added logic to pass payload. * changed beta version 4.1-beta.1 * changed beta version 4.1-beta.1 * changed beta version 4.1-beta.1 * changes in changelog & readme- Add PHLO support
123 lines
3.9 KiB
Markdown
123 lines
3.9 KiB
Markdown
# plivo-node
|
|
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.
|
|
|
|
## Installation
|
|
Install the SDK using [npm](https://www.npmjs.com/package/plivo)
|
|
|
|
$ 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
|
|
|
|
## Getting started
|
|
|
|
### Authentication
|
|
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/](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:
|
|
|
|
```javascript
|
|
let plivo = require('plivo');
|
|
let client = new plivo.Client();
|
|
```
|
|
Alternatively, you can specifiy the authentication credentials while initializing the `Client`.
|
|
|
|
```javascript
|
|
let plivo = require('plivo');
|
|
let client = new plivo.Client('your_auth_id', 'your_auth_token');
|
|
```
|
|
|
|
### The basics
|
|
The SDK uses consistent interfaces to create, retrieve, update, delete and list resources. The pattern followed is as follows:
|
|
|
|
```javascript
|
|
client.resources.create(name,params); // Create
|
|
client.resources.get(id); // Get
|
|
client.resources.update(params); // Update
|
|
client.resources.delete(id); // Delete
|
|
client.resources.list({limit:5,offset:0}); // List all resources, max 20 at a time
|
|
```
|
|
|
|
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
|
|
|
|
```javascript
|
|
let plivo = require('plivo');
|
|
let client = new plivo.Client();
|
|
|
|
client.messages.create(
|
|
'your_source_number',
|
|
'your_destination_number',
|
|
'Hello, world!'
|
|
).then(function(message_created) {
|
|
console.log(message_created)
|
|
});
|
|
|
|
```
|
|
|
|
### Make a call
|
|
|
|
```javascript
|
|
let plivo = require('plivo');
|
|
let client = new plivo.Client();
|
|
|
|
client.calls.create(
|
|
'your_source_number',
|
|
'your_destination_number',
|
|
'http://answer.url'
|
|
).then(function(call_created) {
|
|
console.log(call_created)
|
|
});
|
|
|
|
```
|
|
|
|
### Generate Plivo XML
|
|
|
|
```javascript
|
|
let plivo = require('plivo');
|
|
let response = new plivo.Response();
|
|
let speak_body = "Hello, world!";
|
|
|
|
response.addSpeak(speak_body);
|
|
console.log(response.toXML());
|
|
```
|
|
|
|
This generates the following XML:
|
|
|
|
```xml
|
|
<Response>
|
|
<Speak>Hello, world!</Speak>
|
|
</Response>
|
|
```
|
|
|
|
### Run a PHLO
|
|
|
|
```javascript
|
|
var plivo = require('../dist/rest/client.js');
|
|
var PhloClient = plivo.PhloClient;
|
|
|
|
var authId = 'auth-id';
|
|
var authToken = 'auth-token';
|
|
var phloId = 'PHLO_ID';
|
|
var phloClient = phlo = null;
|
|
|
|
// Run phlo
|
|
phloClient = new PhloClient(authId, authToken);
|
|
phloClient.phlo(phloId).run().then(function (result) {
|
|
console.log('Phlo run result', result);
|
|
}).catch(function (err) {
|
|
console.error('Phlo run failed', err);
|
|
});
|
|
```
|
|
|
|
### More examples
|
|
Refer to the [Plivo API Reference](https://api-reference.plivo.com/latest/node/introduction/overview) for more examples. Also refer to the [guide to setting up dev environment](https://developers.plivo.com/getting-started/setting-up-dev-environment/) on [Plivo Developers Portal](https://developers.plivo.com) to setup an Express server & 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](https://github.com/plivo/plivo-node/issues).
|