shoutpoint-api-sdk v0.4.5

Shoutpoint-API-SDK

A Software Development Kit for Shoutpoint APIs: Dials, LiveCalls, LiveIVR, PhoneNumbers

Installation

  npm install shoutpoint-api-sdk --save

Usage

  var shoutpoint = require('shoutpoint-api-sdk');
  var sp = shoutpoint('API_KEY');

The above variable "sp" contains the APIs within it.

   sp.Dials         //This handles the Dials API and has methods to use it
   sp.LiveCalls     //This handles the LiveCalls API and has methods to use it
   sp.LiveIVR       //This handles the LiveIVR API and has methods to use it
   sp.PhoneNumbers  //This handles the PhoneNumbers API and has methods to use it

##Getting Started

To get started, initialize the library.

  var shoutpoint = require('shoutpoint-api-sdk');
  var sp = shoutpoint('YOUR API KEY HERE');

Next we want to provision a phone number that we can use.

    sp.PhoneNumbers.listAvailable(); //This will give you a promise that is resolved with a list of numbers

Now that we see what is available, we pick a number and provision it for ourselves.

    sp.PhoneNumbers.provision('LiveIVRs',['The number you chose']);

Once you have a number provisioned for your API key, you can use that number for the other APIs.

##Examples

    //This lets you send an SMS message
    sp.Dials.sms('{{the number to send the message to}}', '{{the configured number that you own}}', "Your message here");

    //This lets you get the details of a call
    sp.LiveCalls.getSpecificCall("The call id of the call I want to see");

Contributing

Arvind Sontha

Release History

• 0.4.2 Initial release