node package manager

@broid/twilio

npm node deps tests bithound bithoundscore nsp-checked

Broid Twilio Integration

Broid Integrations is an open source project providing a suite of Activity Streams 2 libraries for unified communications among a vast number of communication platforms.

Connect your App to Multiple Messaging Channels with One OpenSource Language.

gitter

Message types supported

Simple Image Video Buttons Location Phone number

Buttons, Location, Phone number are platform limitations.

Getting started

Install

npm install --save @broid/twilio

Connect to Twilio

const BroidTwilio = require('@broid/twilio');
 
const twilio = new BroidTwilio({
  username: '<phone_number>',
  token: '<account_sid>',
  token_secret: '<auth_token>',
  http: {
    host: "127.0.0.1",
    port: 8080
  }
});
 
twilio.connect()
  .subscribe({
    next: data => console.log(data),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });

Twilio can also be used with your existing express setup.

const BroidTwilio = require('broid-twilio');
const express = require("express");
 
const twilio  = new BroidTwilio({
  username: '<phone_number>',
  token: '<account_sid>',
  token_secret: '<auth_token>'
});
 
const app = express();
app.use("/twilio", twilio.getRouter());
 
twilio.connect()
  .subscribe({
    next: data => console.log(data),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });
 
app.listen(8080);

Options available

name Type default Description
serviceID string random Arbitrary identifier of the running instance
logLevel string info Can be : fatal, error, warn, info, debug, trace
token string Your account sid
tokenSecret string Your auth token
username string The phone number
http object WebServer options (host, port)

Receive a message

twilio.listen()
  .subscribe({
    next: data => console.log(`Received message: ${data}`),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });

Post a message

To send a message, the format should use the broid-schemas.

const formatted_message = {
  "@context": "https://www.w3.org/ns/activitystreams",
  "type": "Create",
  "generator": {
    "id": "f6e92eb6-f69e-4eae-8158-06613461cf3a",
    "type": "Service",
    "name": "twilio"
  },
  "object": {
    "type": "Note",
    "content": "hello world"
  },
  "to": {
    "type": "Person",
    "id": "+15437783737"
  }
};
 
twilio.send(formatted_message)
  .then(() => console.log("ok"))
  .catch(err => console.error(err));

Examples of messages

You can find examples of sent and received messages at Broid-Schemas.

Contributing to Broid

See CONTRIBUTE.md

Copyright & License

Copyright (c) 2016-2017 Broid.ai

This project is licensed under the AGPL 3, which can be found here.