Code Monkey home page Code Monkey logo

send-sms.js's Introduction

send-sms.js

NPM version Build status Dependency Status Downloads

The library to send simple message which is compatible with multi-services, currently it supports the following services:

Installation

$ npm install git+https://github.com/mobinco/send-sms.js.git --save

This library also is able to run at browser-side or any JavaScript environment.

Usage

const {
  SMS,
  adapters
} = require('send-sms');

const ippanel = new adapters.IPPanel({
  apiKey: 'your api key'
});
const sms = new SMS(ippanel);

// when you need to send a simple message
sms.send('your phone number to send', 'foobar text', 'from tel line');

// sms.send returns a Promise so if you are in ES7 environment
try {
  await sms.send(phone, text, from);
} catch (err) {
  console.error(err);
}

The above example will send a message to user like the following:

foobar text

Write your adapter for service that you are using

const { Adapter } = require('send-sms');
class YourServiceAdapter extends Adapter {
  constructor(arguments) {
    super({
      // options like credentials
    });
  }
  send(phone, content, from) {
    // must implement this method in your self adapter, which does
    // send requests to service endpoint, and must return a Promise
  }
}

To see an example, see (adapters/smsbao.js)

License

MIT @ Mobinco, Inc.

send-sms.js's People

Contributors

yorkie avatar mobinco avatar mobinsmtp avatar

Stargazers

 avatar

Forkers

akbarazimifar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.