0.0.1 • Published 9 years ago

semaphore-sms v0.0.1

Weekly downloads
3
License
ISC
Repository
github
Last release
9 years ago

semaphore-nodejs

Small client library to use semaphore.co API in node.js

##Usage

Install the npm in your project

> npm install semaphore-sms

Example usage:

var semaphore = require('semaphore-sms');

semaphore.set_api_key("...");

semaphore.send_sms("09000000000", "Test message!", "A Sender", function(response) {
  
  if (response.status === 'success') {
    //Message sent!
  }
  
})

##Sending SMS message(s)

The method semaphore.send_sms is used to an SMS to between 1 and 20 recipient phone numbers.

semaphore.send_sms(numbers, message, sender, callback)
ParameterTypeDescription
numbersString or ArrayA phone number or an array of phone numbers to be the recipients of the SMS (20 max)
messageStringThe message body, 140 chars max
senderStringThe sender name
callbackFunctionA callback function. The only param will be a JSON object returned from the semaphore API

##Tests

Add your api key to tests/test.js then run npm test