Quick Sms

A Node.js library for sending sms and bulk sms using quicksms api r

Get Started

~$ npm install quicksms

Usage

After Installing import quicksms

var quicksms  = require('quicksms');

Configure

Create your username and password from quicksms official website

For error and response code, do check the official quicksms docs

quicksms.setCredentials(username,password);

Parameters

sender :- the Sender of the message,
recipientFile :- the file path containing the Phone Numbers (for bulk sms, numbers should be seperated by ",")
message :- the content of the message to be sent
N.B :- Ignore the '+' sign in front of phone numbers, instead of '+23456868' use '23456868'

Send SMS

quicksms.sendSms(sender,message,recipient,cb);

Send Bulk Sms

quicksms.sendBulk(sender,message,recipientFile,cb);

Check your quicksms balance

quicksms.getBalance(cb);

Get the delivery Report for a message

quicksms.getDeliveryReport(msgId,cb);

Contributing

If you would like to contribute, fork the repo, make your changes and create a pull request

License

This Library was released under MIT License

Reference

Quicksms Api Documentation

Contributors

Abdullateef AdeniranYusuf