2.1.0 • Published 7 years ago
@broid/viber v2.1.0
Broid Viber 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.
Getting started
Install
npm install --save @broid/viber
Connect to Viber
const BroidViber = require('@broid/viber');
const viber = new BroidViber({
username: '<sender_name>',
token: "<app_key>",
webhookURL: "http://127.0.0.1/",
http: {
host: "127.0.0.1",
port: 8080
}
});
viber.connect()
.subscribe({
next: data => console.log(data),
error: err => console.error(`Something went wrong: ${err.message}`),
complete: () => console.log('complete'),
});
Viber can also be used with your existing express setup.
const BroidViber = require('@broid/viber');
const express = require("express");
const viber = new BroidViber({
username: '<sender_name>',
token: "<app_key>",
webhookURL: "http://127.0.0.1/"
});
const app = express();
app.use("/callr", callr.getRouter());
viber.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 application key | |
username | string | Your public page name | |
webhookURL | string | Full webhook URL to be passed to Viber web services | |
http | object | { "port": 8080, "http": "0.0.0.0" } | WebServer options (host , port ) |
Receive a message
viber.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": "viber"
},
"object": {
"type": "Note",
"content": "hello world"
},
"to": {
"id": "8GBB3nlCwffk8SQm1zmcAA==",
"name": "Sally"
}
};
viber.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.