# node-smsukraine

> NodeJS NPM module for smsukraine.com.ua

Latest version **1.0.0** (published 2015-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-smsukraine
pnpm add node-smsukraine
yarn add node-smsukraine
bun add node-smsukraine
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-05-10 |
| First published | 2015-05-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Jaroslav Khorishchenko |
| Maintainers | snipter |
| Keywords | sms, ukraine, smsukraine |

## Links

- npm: https://www.npmjs.com/package/node-smsukraine
- Repository: https://github.com/snipter/node-smsukraine
- Issues: https://github.com/snipter/node-smsukraine/issues
- npm.io page: https://npm.io/package/node-smsukraine

## Dependencies (2)

- [request](https://npm.io/package/request.md) ^2.54.0
- [underscore](https://npm.io/package/underscore.md) ^1.8.2

## Recent versions

- 1.0.0 (latest) — 2015-05-10

## README

# NodeJS module for SMS Ukraine service

Node module for using API of service [smsukraine.com.ua](http://smsukraine.com.ua/). The full list of  API methods and it's params you can find [here](http://smsukraine.com.ua/techdocs/).

## Installing

```
npm install node-smsukraine
```

## Usage

You can use two methods for setting login and pass: global and local.

With global method you can set login, pass and sms name for each request:

```javascript
var SmsUkraine = require("smsukraine");
var sms = new SmsUkraine({login: "my_login", pass: "my_pass", name: "my_sms_name"});
```

- **login** - your login in the system;
- **pass** - your password;
- **name** - your sms name;

With local method you can set login, pass and sms name for current request

```javascript
sms.status({id: "248919871", login: "my_login", pass: "my_pass"}, function(err, sms_data){
	if(err) return console.log(JSON.stringify(err));
	console.log(JSON.stringify(sms_data));
})
```

## Methods

### Send SMS

```javascript
var data = {"to": "380971234567", "text": "Hello world!"}
sms.send(data, function(err, sms_data){
	if(err) return console.log(JSON.stringify(err));
	console.log(JSON.stringify(sms_data));
})
```

For parameter **data.to** you can use differen types of mobile number. For example: 

- +38 (097) 123-45-67
- 097 123 45 67
- 80971234567
- etc.

With successful request you will receive message with SMS id and SMS count:

```json
{
	"id": 123456,
	"sms_count": 2
}
```

### Check status

```javascript
sms.status(248919871, function(err, sms_data){
	if(err) return console.log("err:" + JSON.stringify(err));
	console.log(JSON.stringify(sms_data));
})
```

Where **id** - sended SMS id.

With successful request you will receive status and code:

```json
{
	"code": 2,
	"status": "Доставлено",
	"status_time":"2015-05-10T15:06:21+0300"
}
```


### Check balance

```javascript
sms.balance(function(err, balance){
	if(err) return console.log(JSON.stringify(err));
	console.log("balance: " + balance);
})
```

## Contacts

Jaroslav Khorshchenko
[websnipter@gmail.com](mailto:websnipter@gmail.com)

---
_Source: https://npm.io/package/node-smsukraine · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._