https://github.com/wcoder/node-rocketsms

Modern RocketSMS SMS-gateway API.
https://github.com/wcoder/node-rocketsms

javascript nodejs sms sms-api sms-gateway sms-messages sms-sdk sms-verification

Last synced: 2 months ago
JSON representation

Modern RocketSMS SMS-gateway API.

• Host: GitHub
• URL: https://github.com/wcoder/node-rocketsms
• Owner: wcoder
• License: mit
• Created: 2020-06-09T19:28:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-17T20:31:39.000Z (6 months ago)
• Last Synced: 2024-10-04T09:32:57.658Z (3 months ago)
• Topics: javascript, nodejs, sms, sms-api, sms-gateway, sms-messages, sms-sdk, sms-verification
• Language: JavaScript
• Homepage: https://rocketsms.by/
• Size: 72.3 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-rocketsms

Modern RocketSMS SMS-gateway API.

## Features

- Supports [API spec](https://rocketsms.by/storage/rocketsms_api.pdf) v1.3.0.

- Clear, lightful API layer

- Async/await/Promises

## Installation

Install the [![latest version](https://img.shields.io/npm/v/node-rocketsms.svg?label=latest%20version)](https://www.npmjs.com/package/node-rocketsms) via npm:

```sh

npm install node-rocketsms

```

## Example Usage

```js

const RocketSMS = require('node-rocketsms');

const sms = new RocketSMS('username', 'password');

```

### Create message

``` js

const result = await sms.send('375999999999', 'New message text!');

```

### Message status

```js

const result = await sms.status(123456789);

```

### Account balance

```js

const result = await sms.balance();

```

### Alfa-numbers list

```js

const result = await sms.senders();

```

### Add alfa-number

```js

const result = await sms.addSender('SenderName');

```

### Templates list

```js

const result = await sms.templates();

```

---

©