smssync

smssync endpoint for nodejs

Usage no npm install needed!

<script type="module">
  import smssync from 'https://cdn.skypack.dev/smssync';
</script>

README

smssync

Build Status Dependency Status npm version

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

$ npm install --save smssync

Usage

const express = require('express');
const smssync = require('smssync')(<options>);

...

//add smssync router to express
app.use(smssync({
    
    endpoint:'<endpoint point to mount smssync>',

    secret:'<your endpoint secret>',

    reply: '<whether to send reply from server>',

    error: '<allow smssync to handle error or pass to error middleware>',

    onReceive: function (sms, done) {
      //handle received sms from smssync device
      done(<error>, <receiving response>);
    },

    onSend: function (done) {
        //obtain sms to send by smssync device
        done(<error>, <array of sms to send>);
    },

    onSent: function (queued, done) {
      //received queued sms from smssync device
      done(<error>, <array of sms that already queued>);

    },

    onQueued: function (done) {
      //obtain sms waiting delivery report and send them to smssync device
      ...
      done(<error>, <array of message ids or uuids>);
    },

    onDelivered: function (delivered, done) {
      //receive delivery status from smssync device
      ...
      done(<error>, <processing results>);

    }

  }));

app.listen();

Testing

  • Clone this repository

  • Install all development dependencies

$ npm install
  • Then run test
$ 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.