Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voronchuk/fb-bot-api
API wrapper to communicate with Facebook Messenger Bots
https://github.com/voronchuk/fb-bot-api
Last synced: 27 days ago
JSON representation
API wrapper to communicate with Facebook Messenger Bots
- Host: GitHub
- URL: https://github.com/voronchuk/fb-bot-api
- Owner: Voronchuk
- License: mit
- Created: 2016-05-04T13:25:09.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-08-03T14:45:27.000Z (over 8 years ago)
- Last Synced: 2024-08-09T07:25:13.552Z (5 months ago)
- Language: JavaScript
- Size: 798 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Facebook Bot Node API
[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][downloads-url]
[![Dependency Status][david-image]][david-url]
[npm-image]: https://img.shields.io/npm/v/fb-bot-api.svg?style=flat-square
[npm-url]: https://npmjs.org/package/fb-bot-api
[downloads-image]: http://img.shields.io/npm/dm/fb-bot-api.svg?style=flat-square
[downloads-url]: https://npmjs.org/package/fb-bot-api
[david-image]: http://img.shields.io/david/Voronchuk/fb-bot-api.svg?style=flat-square
[david-url]: https://david-dm.org/Voronchuk/fb-bot-api
## Getting Started
Use this library to communicate with the Facebook Messenger API to develop a bot for [Facebook Messenger](http://messenger.com/). Go to [developers.facebook.com](https://developers.facebook.com/docs/messenger-platform/implementation) to learn more and start building a bot.
[`npm install fb-bot-api`][npm-url]
## License
The Facebook Messenger bot library is released under the terms of the MIT license. See [License](LICENSE) for more information or see https://opensource.org/licenses/MIT.
## Process
Sample config:
```javascript
var config = {
WEBSERVER: {
PORT: 8080,
PROXY_CONFIG: 'loopback',
URL_PREFIX: '/facebook'
},
FB_MESSAGE_URL: 'https://graph.facebook.com/v2.6',
VERIFY_TOKEN: '...',
APP_ID: '...',
PAGE_ID: '...',
PROFILE_TOKEN: '...',
MESSAGE_DELIVERY_TRACKING_TIMEOUT: 30000 // Optional settings which enables tracking a delivery of sent messages
};
```
Make bot instance:
```javascript
var FacebookBot = require('fb-bot-api').Facebook;
var instance = new FacebookBot(config);
instance.on('message', function (sender, message) {
...
});
instance.on('message-image', function (sender, imageUrl) {
...
});
instance.on('message-postback', function (sender, postback) {
...
});
instance.on('message-read', function (sender, read) {
...
});
instance.on('message-optin', function (sender, optin) {
...
});
instance.on('error', function (error) {
...
});
// If MESSAGE_DELIVERY_TRACKING_TIMEOUT is set
instance.on('message-delivered', function (sender, signature) {
...
});
instance.listen();
// Welcome message
instance.bot.setWelcome('Hello world!');
instance.bot.setWelcome('Hello world!', [
{
type: 'postback',
label: 'Start'
},
{
type: 'postback',
label: 'End'
}
]);
// Normal messages with and without links
instance.bot.sendText(facebookUserId, 'Some message');
instance.bot.sendText(facebookUserId, 'Some message', [
{
type: 'postback',
label: 'Answer'
},
{
type: 'web_url',
label: 'Google',
content: 'https://google.com'
}
]);
// Image messages
instance.bot.sendImage(facebookUserId, 'https://images.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png');
instance.bot.sendImage(facebookUserId, '/local/path/to/file.png');
// Structured messages with horizontal scrolling
instance.bot.sendItems(facebookUserId, [
{
title: "Welcome to My Company #1!",
item_url: "https://www.petersbowlerhats.com",
image_url: "https://www.petersbowlerhats.com/img/hat.jpeg",
subtitle: "We have the right hat for everyone.",
buttons: [
{
type: "web_url",
label: "View Website 1",
content: "https://www.petersbowlerhats.com"
},
{
type: "postback",
label: "Start Chatting 1"
}
]
},
{
title: "Welcome to My Company #2!",
item_url: "https://www.petersbowlerhats.com",
image_url: "https://www.petersbowlerhats.com/img/hat.jpeg",
subtitle: "We have the right hat for everyone.",
buttons: [
{
type: "web_url",
label: "View Website 2",
content: "https://www.petersbowlerhats.com"
},
{
type: "postback",
label: "Start Chatting 2"
}
]
}
]);
```
By default the system initialise Express 4 web-server instance to listen for FB Messenger webhook messages, if thats an overkill for you can pass custom web-server engine as the second param of FacebookBot constructor, like `new FacebookBot(config, express())`.
## Diclaimer
This library is still early in it's development, lacks tests and features, so use on your own risk.