trailpack-sinch

0.2.0 • Public • Published

trailpack-sinch

version 0.1.0

run npm link NPM version Build status Dependency Status Code Climate

Sinch Trailpack for sending SMS

Install

With yo:

$ yo trails:trailpack trailpack-sinch

With npm:

$ npm install --save trailpack-sinch

Configure

// config/main.js
module.exports = {
  packs: [
    // ... other trailpacks
    require('trailpack-sinch')
  ]
}

Add configuration for sinch :

// config/sinch.js
module.exports = {
  /**
   * The "account Key" associated with your Sinch account.
   */
  Key: null,
  /**
   * The "account secret" associated with your Sinch account.
   */
  Secret: null,
  
}

Usage

Use the SinchService like this (from controllers/policies/services) :

//Send basic SMS
this.app.services.SinchService.sendMessage('phoneNumber', 'message').then(function (results) {
  this.app.log.debug('ok')
})
.catch(err => {
  this.app.log.error(err)
})
       
//Send messageid set status
this.app.services.SinchService.getStatus(jsonObj.messageId).then(function (results) {
 
  this.app.log.debug('ok ',results)
         
})
.catch(err => {
  this.app.log.error(err)
})
 

Sinch Account

The use of this requires setting up a sinch sms account (https://www.sinch.com/)

Credits

This trailpack is inspired by Jaumard's trailpack-twilio

We love contributions! Please check out our Contributor's Guide for more information on how our projects are organized and how to get started.

License

MIT

Package Sidebar

Install

npm i trailpack-sinch

Weekly Downloads

2

Version

0.2.0

License

Apache-2.0

Last publish

Collaborators

  • johntom