# openvox-sms

> OpenVox VoxStack GSM-gateway sms sender

Latest version **0.0.9** (published 2015-03-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install openvox-sms
pnpm add openvox-sms
yarn add openvox-sms
bun add openvox-sms
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2015-03-27 |
| First published | 2015-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Maintainers | antirek |

## Links

- npm: https://www.npmjs.com/package/openvox-sms
- Repository: https://github.com/antirek/openvox-sms
- Issues: https://github.com/antirek/openvox-sms/issues
- npm.io page: https://npm.io/package/openvox-sms

## Dependencies (1)

- [asterisk-manager](https://npm.io/package/asterisk-manager.md) ^0.1.15

## Recent versions

- 0.0.9 (latest) — 2015-03-27
- 0.0.8 — 2015-03-27
- 0.0.7 — 2015-03-19
- 0.0.6 — 2015-01-29
- 0.0.5 — 2015-01-29
- 0.0.4 — 2015-01-29
- 0.0.3 — 2015-01-29
- 0.0.2 — 2015-01-27
- 0.0.1 — 2015-01-22

## README

# openvox-sms
OpenVox VoxStack GSM-gateway sms sender


Intro
=====

OpenVox VoxStack GSM-gateway have inside Asterisk PBX (http://www.asterisk.org)

Asterisk have AMI (Asterisk Manager Interface) - telnet for exchange commands and events


Install
=======

> npm install openvox-sms --save


Usage
=====

`````
var osms = require('openvox-sms');

var sms = new osms({host: 'localhost'});

sms.on('connect', function () {
	sms.sendSMS({span: 1, number: '89135292926', text: 'hello'}, function (err, response) {
		console.log('Done!');
		sms.close(function(){
			console.log('close');
		});
	});
});

`````

API
===

**var sms = new osms(options)**

init osms object

`````
var sms = new osms({         //connect to Asterisk AMI
	host: 'localhost',       //host
	port: 5038,              //port
	username: 'admin',       //username
	password: 'admin',       //password
	});
`````

**sms.on(event, callback)**

set listener on event from Asterisk in OpenVox VoxStack gsm gateway

`````
sms.on('connect', function () {
	//do something
	});
`````


**sms.sendSMS**

send SMS via opened connection to Asterisk

auto split long sms to array of csms

all params are required

`````
sms.sendSMS({
	span: 1,                  // span of gsm board OpenVox VoxStack
	number: '89135292926',    // number 
	text: 'hello'             // text can be long, more than 160 for ascii sms and more than 70 for non-ascii sms
	}, callback);             // callback receive one response for short sms or array for long sms
`````

**sms.close(callback)**

close connection

`````
sms.close(callback);
`````


Tests
=====

> npm test



Bugs?
=====

Please, contact me


Links
=====

http://habrahabr.ru/post/205122/

http://mysyura.in.ua/otpravka-shlyuz-openvox/

http://www.openvox.cn/pub/manuals/Release/English/VS-GW1600-20G%20User%20Manual.pdf

http://www.openvox.cn/products/voip-gateways/gsm-gateways/148/vs-gw1600-gsm-series-detail.html

http://openvox.qiniudn.com/pub/misc/GSM%20Gateway/OpenVox%20%20GSM%20Gateway%20HTTP%20Interface_en.pdf

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