Framework for messaging bots
npm install botframework

Bot Framework allows you to write bots for Facebook Messenger implementing MVC like controllers.
But it has been designed to allow integration of other bots in future.
bash
npm install botframework
`Usage
$3
In order to setup the Facebook Bot in next step you need to define a
* callback url e.g. https://www.myhost.com/facebook/receive
* verify id e.g. "my-secure-id"
For testing I can recommend http://localtunnel.me/
$3
follow https://developers.facebook.com/docs/messenger-platform/quickstart to set up your bot.
Note the access_token. We will need it$3
$3
`javascript
var bf = require('../');
var bot = new bf.Bot({
fb: {
page_id: ,
verify_id: ,
port: 3000,
callback_path: '/facebook/receive',
access_token:
}
}, new ctrl());bot.setWelcomeMessage('Hello There'); // sets up the message on the facebook welcome screen for new users
function ctrl() {
this.newUser = function (data) {
console.log('user'+ JSON.stringify(data));
reply.text('hi');
};
this.textMessage = function(data, reply) {
reply.text('Servus: ' + data.text);
};
}
`
$3
`javascript
import {IBotSettings, , IBotController} from 'botframework';let botSettings: IBotSettings = {
fb: {
page_id: ,
verify_id: ,
port: 3000,
callback_path: '/facebook/receive',
access_token:
}
} ;
class BotController implements IBotController {
textMessage(msg: IBotRequest, reply: IBotReply): any {
reply.text('hi');
}
}
var bot = new Bot(botSettings, new BotController());
bot.setWelcomeMessage('Hello There'); // sets up the message on the facebook welcome screen for new users
`$3
Botframework detects the facebook message type and calls the according handler callback function if its defined.
You can implement more handlers. Following callbacks are currently supported:
`javascript
export interface IBotController {
newUser?(request: IBotRequest, reply: IBotReply): void; // handles facebook Authentication callback
textMessage?(request: IBotRequest, reply: IBotReply): void; // handles plain text messages
imageMessage?(request: IBotRequest, reply: IBotReply): void; // image received
linkMessage?(request: IBotRequest, reply: IBotReply): void; // link received through e.g. safari sendTo Messenger plugin
locationMessage?(request: IBotRequest, reply: IBotReply): void; // user sent his location
delivered?(request: IBotRequest, reply: IBotReply): void; // facebook delivery message
catchAll?(request: IBotRequest, reply: IBotReply): void; // everything unhandled goes here
}
`
$3
The Reply interfaces currently supports replying with a simple text message and a list message.
`javascript
// reply with list
let botItems: Array = response.data.map( (obj: Object) => {
let buttons = [
{
title: 'Open Link',
url: obj.href,
type: 'web_url'
}
];
return {
title: obj.name,
image_url: obj.img_url
subtitle: obj.desc || '',
buttons
}
});
reply.list(botItems);
//////
//reply with text
reply.text('Hi there');
//reply with buttons
let buttons: IBotReplyListItemAction[] = [
{
title: 'Open Link',
url: obj.href,
type: 'web_url'
},
{
title: 'Show Updates',
payload: 'SHOW_UPDATES',
type: 'postback'
}
];
reply.buttons('Please choose:', buttons);
``