Semaphore-ph-api NPM

semaphoresms

Sempahore.co API wrapper for Node.js

The Sempahore.co API V4 Reference is a good resource to learn more about these APIs.

:cloud: Installation

# Using npm
npm install --save semaphore-ph-api

# Using yarn
yarn add semaphore-ph-api

:clipboard: Example

const SemaphoreSMS = require("semaphore-ph-api");

var client = new SemaphoreSMS({
    apiKey: process.env.SEMAPHORE_API_KEY
    // This is optional
  , version: 'api/v4'
  , host: process.env.SEMAPHORE_HOST || "https://api.semaphore.co/"
});

client.sendMessage({
        number: '09123456789',
        message: 'Hello World'
        },(err, data) => {
    console.log(err || data);
    // =>
	//		{
	//		"message_id": "123456",
	//		"user_id": "123456",
	//		"user": "test@mail.com",
	//		"account_id": "1234",
	//		"account": "Test",
	//		"recipient": "09123456789",
	//		"message": "Hello World",
	//		"sender_name": "Test",
	//		"network": "Smart",
	//		"status": "Pending",
	//		"source": "prepaid",
	//		"type": "127.33",
	//		"created_at": "2017-08-04T09:59:29.660Z",
	//		"updated_at": "2017-08-05T09:59:29.660Z"
	//		}
});

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

You can see below the API reference of this module.

`SemaphoreSMS(options)`

Creates the instance of the SemaphoreSMS class.

Params

Object options: An object containing:
apiKey (String): SemaphoreSMS API Key (mandatory).
version (String): Semaphore api version appended to host. (default: api/v4).
host (String): The Semaphore.co api host (default: https://api.semaphore.co/).

`sendMessage(data, cb)`

Send a message to single destination.

Params

Object data: The Sending Messages parameters (documented here).
Function cb: The callback function.

`sendPriorityMessage(data, cb)`

Normally messages are processed in the order they are received and during periods of heavy traffic messaging, messages can be delayed. If your message is time sensitive, you may wish to use our premium priority queue which bypasses the default message queue and sends the message immediately. This service is 2 credits per 160 character SMS.

Params

Object data: The Sending Messages parameters (documented here).
Function cb: The callback function.

`retrieveMessage(params, cb)`

To retrieve outgoing SMS messages.

Params

Object params: The Retrieving Messages parameters (documented here).
Function cb: The callback function.

`retrieveMessageById(id, cb)`

Retrieve a single outgoing SMS message by its unique id

Params

String id: ID of the message to get.
Function cb: The callback function.

`retrieveAccount(cb)`

To retrieve basic information about your account.

Params

Function cb: The callback function.

`retrieveAccountTransactions(params, cb)`

To retrieve transaction information about your account.

Params

Object params: The Limit and Page parameters (documented here).
Function cb: The callback function.

`retrieveSenderNames(params, cb)`

To retrieve sender names associated with your account.

Params

Object params: The Limit and Page parameters (documented here).
Function cb: The callback function.

`retrieveUsers(params, cb)`

To retrieve users associated with your account

Params

Object params: The Limit and Page parameters (documented here).
Function cb: The callback function.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I do web services and open-source my used projects as much as I can. I will try to reply to everyone needing help using these projects. It consumes a lot of time and hardwork. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 344FWmvxDt6FFFoYoFjftiT3gGus68AqNw