elibom

A node client for Elibom.com rest API

npm install elibom
2 downloads in the last week
9 downloads in the last month

Elibom Node.js API Client

Build Status

A Node.js client of the Elibom REST API. The full API reference is here.

Getting Started

1. Install the module

npm install elibom

2. Configure the ElibomClient object passing your credentials.

var elibomClient = require('elibom')('user@domain.com','apiPassword')

Note: You can find your api password at http://www.elibom.com/api-password (make sure you are logged in).

You are now ready to start calling the API methods!

API methods

Send SMS

elibomClient.sendMessage('300XXXXXXXXX','message',function(err,data){    
    if (!err){
        console.log(data);
    }else{
        console.log(err.message);
    }
});

Schedule SMS

elibomClient.scheduleMessage('300XXXXXXXXX','message','YYYY-mm-dd hh:mm',function(err,data){    
    if (!err){
        console.log(data);
    }else{
        console.log(err.message);
    }
});

Show Delivery

elibomClient.showDelivery(deliverId,function(err,data){    
    if (!err){
       console.log(data);
    }else{
       console.log(err.message);
    }
});

List Scheduled SMS Messages

elibomClient.listSchedules(function(err,data){    
    if (!err){
        console.log(data);
    }else{
        console.log(err.message);
    }
});

Cancel Scheduled SMS Message

elibomClient.cancelSchedule(scheduleId,function(err,data){    
    if (!err){
        console.log(data);
    }else{
        console.log(err.message);
    }
});

List Users

elibomClient.showUsers(function(err,data){    
    if (!err){
        console.log(data);
    }else{
        console.log(err.message);
    }
});

Show User

elibomClient.showUser(userId,function(err,data){    
    if (!err){
        console.log(data);
    }else{
        console.log(err.message);
    }
});

Show Account

elibomClient.showAccount(function(err,data){    
    if (!err){
        console.log(data);
    }else{
        console.log(err.message);
    }
});
npm loves you