Nondeterministic Palindrome Machine

    plivo
    TypeScript icon, indicating that this package has built-in type declarations

    4.39.0 • Public • Published

    Plivo Node.js library

    Version codecov UnitTests

    The Node.js SDK simplifies the integration of communications into your Node.js applications through the Plivo REST API. You will be able to use the SDK to make voice calls, send SMS, and generate Plivo XML to manage your call flows.

    Installation

    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
    

    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://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:

    let plivo = require('plivo');
    let client = new plivo.Client();

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

    let plivo = require('plivo');
    let client = new plivo.Client('<auth_id>', '<auth_token>');

    The basics

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

    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

    let plivo = require('plivo');
    let client = new plivo.Client();
    
    client.messages.create({
        src: '+14156667778',
        dst: '14156667777',
        text: 'Hello, this is a sample text from Plivo',
    }).then(function(response) {
        console.log(response)
    });

    Make a call

    let plivo = require('plivo');
    let client = new plivo.Client();
    
    client.calls.create(
      '+14156667778',
      '+14156667777',
      'http://answer.url'
    ).then(function(response) {
      console.log(response)
    });

    Lookup a number

    let plivo = require('plivo');
    let client = new plivo.Client('<auth_id>', '<auth_token>');
    
    client.lookup.get('<number-goes-here>')
    .then(function(response) {
        console.log(response);
    });

    Generate Plivo XML

    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:

    <Response>
      <Speak>Hello, world!</Speak>
    </Response>

    Run a PHLO

    let plivo = require('plivo');
    var PhloClient = plivo.PhloClient;
    var phloClient = phlo = null;
    
    phloClient = new PhloClient('<auth-id>', '<auth-token>');
    phloClient.phlo('<phlo_id>').run().then(function (result) {
    console.log('Phlo run result', result);
    });

    More examples

    More examples are available here. Also refer to the guides for configuring the Express server 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.

    Local Development

    Note: Requires latest versions of Docker & Docker-Compose. If you're on MacOS, ensure Docker Desktop is running.

    1. Export the following environment variables in your host machine:
    export PLIVO_AUTH_ID=<your_auth_id>
    export PLIVO_AUTH_TOKEN=<your_auth_token>
    export PLIVO_API_DEV_HOST=<plivoapi_dev_endpoint>
    export PLIVO_API_PROD_HOST=<plivoapi_public_endpoint>
    1. Run make build. This will create a docker container in which the sdk will be setup and dependencies will be installed.

    The entrypoint of the docker container will be the setup_sdk.sh script. The script will handle all the necessary changes required for local development. It will also package the sdk and reinstall it as a dependecy for the test program.

    1. The above command will print the docker container id (and instructions to connect to it) to stdout.
    2. The testing code can be added to <sdk_dir_path>/node-sdk-test/test.js in host
      (or /usr/src/app/node-sdk-test/test.js in container)
    3. The sdk directory will be mounted as a volume in the container. So any changes in the sdk code will also be reflected inside the container. However, when any change is made, the dependencies for the test program need to be re-installed. To do that:
      • Either restart the docker container
      • Or Run the setup_sdk.sh script
    4. To run unit tests, run make test CONTAINER=<cont_id> in host, where <cont_id> is the docker container id created in 2.
      (The docker container should be running)

    Install

    npm i plivo

    DownloadsWeekly Downloads

    9,910

    Version

    4.39.0

    License

    MIT

    Unpacked Size

    751 kB

    Total Files

    86

    Last publish

    Collaborators

    • plivo
    • tsudot
    • plivo-team
    • plivo-sdks