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.
| Simple | Image | Video | Buttons | Location | Phone number |
|---|---|---|---|---|---|
| ✅ | ✅ | ✅ |
Buttons, Location, Phone number are platform limitations.
Image, Video are supported as a simple message
npm install --save @broid/alexaconst 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) |
alexa.listen()
.subscribe({
next: data => console.log(`Received message: ${data}`),
error: err => console.error(`Something went wrong: ${err.message}`),
complete: () => console.log('complete'),
})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));- A message received from Sally
{
"@context": "https://www.w3.org/ns/activitystreams",
"published": 1483677146,
"type": "Create",
"generator": {
"id": "67c9cb10-8a74-42c8-ba55-294d0447cdf9",
"type": "Service",
"name": "alexa"
},
"actor": {
"id": "15146345659",
"name": "15146345659",
"type": "Person"
},
"target": {
"id": "12262101490",
"name": "12262101490",
"type": "Person"
},
"object": {
"type": "Note",
"id": "0B0000003186F6EB",
"content": "Hello world"
}
}- Send a simple 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": "hello world"
},
"to": {
"id": "15146345659",
"type": "Person"
}
}Broid is an open source project. Broid wouldn't be where it is now without contributions by the community. Please consider forking Broid to improve, enhance or fix issues. If you feel like the community will benefit from your fork, please open a pull request.
And because we want to do the better for you. Help us improving Broid by sharing your feedback on our Integrations GitHub Repo and let's build Broid together!
Make sure that you're read and understand the Code of Conduct.
Copyright (c) 2016-2017 Broid.ai
This project is licensed under the AGPL 3, which can be found here.