README.md

greensms-node

Documentation

The documentation for the GREENSMS API can be found here.

Installation

npm install greensms --save

Sample Usage

Check out these code examples in JavaScript and TypeScript to get up and running quickly.

const GreenSMS = require("greensms");
// Register at my.greeensms.ru first
const client = new GreenSMS({ user: "test", pass: "test" });

client.sms
  .send({
    to: "71231234567",
    txt: "Message to deliver",
  })
  .then((response) => {
    console.log("Request ID: %s", response.request_id);
  })
  .catch((err) => {
    console.error(err);
  });

Environment Variables

greensms-node supports credential storage in environment variables. If no credentials are provided following env vars will be used: GREENSMS_USER/GREENSMS_PASS OR GREENSMS_TOKEN.

Token Auth

const GreenSMS = require("greensms");

const client = new GreenSMS({ token: "token" });

client.account
  .balance()
  .then((response) => {
    console.log("Balance ", response.balance);
  })
  .catch((err) => {
    console.error(err);
  });

Callback Example

const GreenSMS = require("greensms");
// Register at my.greeensms.ru first
const client = new GreenSMS({ user: "test", pass: "test" });

function cb(err, response) {
  console.error("Error ", err);
  console.log("Response", response);
}

greenSmsInstance.account.balance(cb);

Compatibility

greensms-node is compatible with Node.js 12+ and tested until 19.x.

Methods

• You can either use username/password combination or auth token to create an object with constructor
• All methods support Promises, Async/Await and Callbacks.
• Each API Function is available as MODULE.FUNCTION()
• Parameters for each API can be referred from here
• Response keys by default are available in snake_case. If you want to use camelCase, then pass camelCaseResponse: true, in the constructor

Handling Exceptions

• Exceptions for Promise are caught in the catch block.
• For Async/Await, you can catch the error with try/catch block
• Each Error consists of error, code, message, errorType fields and extends the default javascript Error class

Getting help

If you need help installing or using the library, please contact us: support@greensms.ru.

If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

Contributing

Bug fixes, docs, and library improvements are always welcome. Please refer to our Contributing Guide for detailed information on how you can contribute. If you're not familiar with the GitHub pull request/contribution process, this is a nice tutorial.

Getting Started

If you want to familiarize yourself with the project, you can start by forking the repository and cloning it in your local development environment. The project requires Node.js to be installed on your machine.

After cloning the repository, install the dependencies by running the following command in the directory of your cloned repository:

npm install

You can run the existing tests to see if everything is okay by executing:

npm test