Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lykmapipo/smssync
smsync endpoint for nodejs
https://github.com/lykmapipo/smssync
express nodejs smsync ushahidi
Last synced: 20 days ago
JSON representation
smsync endpoint for nodejs
- Host: GitHub
- URL: https://github.com/lykmapipo/smssync
- Owner: lykmapipo
- License: mit
- Created: 2017-01-21T16:10:39.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T01:13:10.000Z (almost 2 years ago)
- Last Synced: 2024-09-15T22:22:57.294Z (2 months ago)
- Topics: express, nodejs, smsync, ushahidi
- Language: JavaScript
- Size: 3.81 MB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# smssync
[](https://travis-ci.org/lykmapipo/smssync)
[](https://david-dm.org/lykmapipo/smssync)
[](https://badge.fury.io/js/smssync)
smsync endpoint for nodejs.
It support
- Receiving of sms(s) from SMSSync device
- Provide sms(s) to send by polling SMSSync device
- Handle Delivery report of sent sms(s) by SMSSync device
## Requirements
- NodeJS v6.5+
## Install
```sh
$ npm install --save smssync
```
## Usage
```javascript
const express = require('express');
const smssync = require('smssync')();
...
//add smssync router to express
app.use(smssync({
endpoint:'',
secret:'',
reply: '',
error: '',
onReceive: function (sms, done) {
//handle received sms from smssync device
done(, );
},
onSend: function (done) {
//obtain sms to send by smssync device
done(, );
},
onSent: function (queued, done) {
//received queued sms from smssync device
done(, );
},
onQueued: function (done) {
//obtain sms waiting delivery report and send them to smssync device
...
done(, );
},
onDelivered: function (delivered, done) {
//receive delivery status from smssync device
...
done(, );
}
}));
app.listen();
```
## Testing
* Clone this repository
* Install all development dependencies
```sh
$ npm install
```
* Then run test
```sh
$ npm test
```
## Contribute
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
## Licence
The MIT License (MIT)
Copyright (c) 2015 lykmapipo & Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.