iSMS Philippines API

iSMS Philippines API wrapper for Node.js

The iSMS Philippines API Reference is a good resource to learn more about these APIs.

:cloud: Installation

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

# Using yarn
yarn add isms-ph-api

:clipboard: Example

const ISMSPH = require("isms-ph-api");

var client = new ISMSPH({
    username: process.env.ISMS_USERNAME
    password: process.env.ISMS_PASSWORD
    // This is optional
  , host: process.env.ISMS_HOST || "https://www.isms.com.my/"
});

client.sendMessage({
        dstno: '639012345678',
        msg: 'Hello World',
        sendid: 'MyId',
        agreedterm: 'YES',
        type: 1
    }, (err, data) => {
    console.log(err || data);
});

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

2. For bug reports and feature requests, open issues. :bug:

3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

You can see below the API reference of this module.

ISMSPH(options)

Creates the instance of the ISMSPH class.

sendMessage(params, cb)

Send a message to single destination.

Params

• Object params: The iSMS API parameters (documented here).
• Function cb: The callback function.

sendMessageByGroupId(params, cb)

Send SMS by Group ID

Params

• Object params: The iSMS API parameters (documented here).
• Function cb: The callback function.

sendMessageByRecipientName(params, cb)

Send SMS by Recipient Name

Params

• Object params: The iSMS API parameters (documented here).
• Function cb: The callback function.

getContactListGroup(cb)

Get Contact List Group

Params

• Function cb: The callback function.

getContactListByGroupId(groupId, cb)

Get Contact List Based on the Group ID

Params

• Integer groupId: The ID of Group in contact list.
• Function cb: The callback function.

getContactList(cb)

Get All Contact List from Phone Book

Params

• Function cb: The callback function.

createContactGroup(groupName, cb)

Create New Contact Group

Params

• Integer groupName: The name of group that will be created.
• Function cb: The callback function.

updateContactGroup(groupName, groupId, cb)

Update Group Name

Params

• Integer groupName: The name of group that will be created.
• Integer groupId: ID of Group that will be updated in contact list.
• Function cb: The callback function.

deleteContactGroup(groupId, cb)

Delete Contact Group

Params

• Integer groupId: ID of Group that will be deleted in contact list.
• Function cb: The callback function.

getBalance(cb)

Get SMS Balance

Params

• 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

  

Thank you! :heart:

:scroll: License

[MIT][license]