@broid/alexa

Broid Alexa 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.

Message types supported

Simple	Image	Video	Buttons	Location	Phone number
✅	✅	✅

Buttons, Location, Phone number are platform limitations.

Image, Video are supported as a simple message

Getting started

Install

npm install --save @broid/alexa

Connect to Alexa

const BroidAlexa = require('@broid/alexa');

const alexa = new BroidAlexa({
  http: {
    port: 8080,
    host: "0.0.0.0"
  }
});

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

Alexa can also be used with your existing express setup

const BroidAlexa = require('broid-alexa');
const express = require("express");

const alexa = new BroidAlexa();

const app = express();
app.use("/alexa", alexa.getRouter());

alexa.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
http	object	{ "port": 8080, "http": "0.0.0.0" }	WebServer options (host, port)

Receive a message

alexa.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 broid-schemas.

const formatted_message = {
  "@context": "https://www.w3.org/ns/activitystreams",
  "type": "Create",
  "generator": {
    "id": "f6e92eb6-f69e-4eae-8158-06613461cf3a",
    "type": "Service",
    "name": "alexa"
  },
  "object": {
    "type": "Note",
    "content": "What's the weather like today?"
  },
  "to": {
    "id": "15146345659",
    "type": "Person"
  }
}

alexa.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

Code of Conduct

Make sure that you're read and understand the Code of Conduct.

Copyright & License

Copyright (c) 2016-2017 Broid.ai

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