SemaphoreJS

A wrapper for accessing the Semaphore SMS API

Note: This only works on nodejs, using this on the browser will not work.

Table of Contents

Installation

npm

1npm install @avidian/semaphorejs

yarn

1yarn add @avidian/semaphorejs

Basic Usage

Sending Messages

1import { Client } from '@avidian/semaphorejs';
2
3const client = new Client('your api key', {/* options */});
4
5const response = await client.send('09991234567', 'your message');
6
7// multiple recipients
8const recipients = ['09991234567', '09997654321'];
9const response = await client.send(recipients, 'your message');

1[
2  {
3    "message_id": 1234567,
4    "user_id": 99556,
5    "user": "user@your.org",
6    "account_id": 90290,
7    "account": "Your Account Name",
8    "recipient": "09991234567",
9    "message": "The message you sent",
10    "sender_name": "SEMAPHORE",
11    "network": "Globe",
12    "status": "Queued",
13    "type": "Single",
14    "source": "Api",
15    "created_at": "2016-01-01 00:01:01",
16    "updated_at": "2016-01-01 00:01:01"
17  }
18]

Retrieving Messages

1const response = await client.messages({ limit: 100, page: 1 });

Supported filters for retrieving messages

1const options = {
2    limit: 100,
3    page: 1,
4    sendername: 'SEMAPHORE',
5    startDate: '2016-01-01',
6    endDate: '2016-02-01',
7    network: 'globe',
8    status: 'success',
9};

Retrieving account information

1const response = await client.account();

1{
2  "account_id": 12345,
3  "account_name": "Your Organization",
4  "status": "Active",
5  "credit_balance": 5000
6}

Retrieve users

1const response = await client.users();

1[
2  {
3    "user_id": 12345,
4    "email": "owner@your.org",
5    "role": "Owner"
6  },
7  {
8    "user_id": 54321,
9    "email": "someguy@your.org",
10    "role": "User"
11  }
12]

Sender names

1const response = await client.senderNames();

1[
2  {
3    "name":"Semaphore",
4    "status":"Active",
5    "created":"2016-01-01 00:00:01"
6  },
7  {
8    "name":"Kickstart",
9    "status":"Active",
10    "created":"2016-01-01 00:00:01""
11  }
12]

Transactions

1const response = await client.transactions();

License

This library is open-sourced software licensed under the MIT license.