Skip to content

A class (Smsable) that can send and receive SMS text messages via twilio, that has a clean and simple speak/listen API.

License

Notifications You must be signed in to change notification settings

rapid-sensemaking-framework/rsf-smsable

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rsf-smsable

A class that can send and receive text messages via twilio, that has a clean and simple speak/listen API.

In order to make this work, not only do you need to set up a twilio account, and number, but you also need to use an ngrok tunnel to your temp server, to receive webhook events. It is possible to do free of charge testing with Twilio, it just appends a little message into the text messages that it sends, which is fine for testing. This is all explained here: https://www.twilio.com/docs/sms/quickstart/node#sign-up-for-twilio-and-get-a-twilio-phone-number

Installation

npm install --save rsf-smsable

Usage

You must be running an instance of rsf-twilio-bot to connect to via websockets in order for the following to work.

const { init, shutdown, Smsable } = require('rsf-smsable')

const config = {
  socketUrl: 'ws://localhost:3022'
}
init(config).then(() => {
  const person = new Smsable('+12223334444')
  // log anything that we hear from them
  person.listen(console.log)
  person.speak('hello!')

  // after 5 seconds, shutdown/disconnect
  // person methods will no longer work, or be fired
  setTimeout(() => {
    shutdown()
  }, 5000)
})

About

A class (Smsable) that can send and receive SMS text messages via twilio, that has a clean and simple speak/listen API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published