Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.6 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.6 KB
Raw

somleng-node

NPM

Build

Node.js helper library for Somleng's REST API.

Note: This library wraps Twilio Node and adds support for Somleng.

Versioning

somleng-node follows Twilio Node versioning.

Installation

npm install somleng or yarn add somleng

Sample Usage

// Client Initialization
const accountSid = process.env.SOMLENG_ACCOUNT_SID;
const authToken = process.env.SOMLENG_AUTH_TOKEN;
const client = require('somleng')(accountSid, authToken);

// Create a call
client.calls
  .create({
      twiml: '<Response><Say>Ahoy, World!</Say></Response>',
      to: '+14155551212',
      from: '+15017122661'
    })
  .then(call => console.log(call.sid));

// List calls
client.calls.list({limit: 20})
            .then(calls => calls.forEach(c => console.log(c.sid)));

Environment Variables

somleng-node supports credential storage in environment variables. If no credentials are provided when instantiating the Somleng client (e.g., const client = require('somleng')();), the values in following env vars will be used: SOMLENG_ACCOUNT_SID and SOMLENG_AUTH_TOKEN.

License

The software is available as open source under the terms of the MIT License.