payamsms-sdk

PayamSMS JavaScript SDK

PayamSMS is a SMS provider.

How to use this package

So, let's have a quick review of our steps.

• Installation
• Configuration
• Methods

Installation

To install PayamSMS SDK use npm command like below:

$ npm i payamsms-sdk

Configuration

Now you installed package. You need to initial it. Just require it and use PayamSMS class with 4 params.

• username
• password
• organization
• line

// Import SDK
const PayamSMS = require("payamsms-sdk");

// Initial it with your env
const sms = new PayamSMS(
    env.PAYAM_ORGANIZATION,
    env.PAYAM_USERNAME,
    env.PAYAM_PASSWORD,
    env.PAYAM_LINE
);

Methods

This SDK has 2 main methods for sending and receiving messages. One other is getting balance that

• send
• receive

Send

Now you want to send a message, or many messages. Ok, have fun with this method!

// Descibe messages
const messages = [
    {
        recipient: "98912xxxxxxx",
        body: "لورم ایپسوم متن ساختگی با تولید سادگی نامفهوم از صنعت چاپ",
    },
];

// Send message
const send = sms.send(messages);

Now add then and get the results.

send.then((result) => {
    console.log(result);
});

Then it returns an array contains objects like below:

• 200 | OK

[
    {
        "code": 200,
        "message": "Message sent",
        "serverId": 10565602949
    }
]

• 500 | Not OK

[
    {
        "code": 500,
        "message": "Error details will be describe here."
    }
]

So, you can do anything you want.

Receive

It will be completed soon . . .

balance

With balance you can get how much money your account has. Ok, just follow instructions:

const balance = sms.getBalance(messages);

balance.then((result) => {
    console.log(result.balance);
});

What result contains, is like below:

{
    "balance": "2020153"
}

Development

If you want to develop the package, it is so simple. just follow steps below.

• Clone the project
• Install dependencies by running $ npm install
• Add your values in .env file
• Start changing!
  • Link package
  • Test

Before you start: **Remember the base or code are stored in lib/payamsms.js. You need to edit there.

Cloning the project

To clone the project, you need to have git installed. Ok, now clone it same as command below.

$ git clone https://gitlab.com/BlackIQ/payamsms-sdk

installing dependencies

Next, install what package uses with npm i or npm install.

$ npm i

Add your values in .env file

Go to test directory and make a copy of .env file.

$ cp .env.example .env

Now .env is created with keys and just add your values.

Changing

To change package or anything, your need a testing environment to use linked package. Just follow steps.

Link package

We asoume you are in lib directory. Right. You can open a tmux or in another terminal to cd in test directory.

In lib directory enter link command:

$ npm link

So, in other terminal, or other tmux part, link your development package to your test directory. If you are in the test directory ok, if not, just say cd test and enter the linking command:

$ npm link payamsms-sdk

Linking step is done.

Test

Your test app is linked. Change anything in package and test it in test directory.