NodeJS Facebook Messenger API for bots to send messages and setup events to Facebook.
npm install fb-messenger-bot-api``
npm install fb-messenger-bot-api
Import
`javascript`
const facebook = require('fb-messenger-bot-api');
ortypescript`
import { FacebookMessagingAPIClient, etc... } from 'fb-messenger-bot-api';
javascript
const messageClient = new facebook.FacebookMessagingAPIClient(process.env.PAGE_ACCESS_TOKEN);
`
or
typescript
const messageClient = new FacebookMessagingAPIClient(process.env.PAGE_ACCESS_TOKEN);
`
Using proxy
javascript
const messageClient = new facebook.FacebookMessagingAPIClient(process.env.PAGE_ACCESS_TOKEN, { hostname:process.env.PROXY_HOST, port: process.env.PROXY_PORT });
`
or
typescript
const messageClient = new FacebookMessagingAPIClient(process.env.PAGE_ACCESS_TOKEN, { hostname:process.env.PROXY_HOST, port: process.env.PROXY_PORT });
`
Defaults to if no protocol provided
$3
`javascript
messageClient.sendTextMessage(senderId, )
.then((result) => ...)
`
or
typescript
await messageClient.sentTextMessage(senderId, );
`$3
javascript
messageClient.sendImageMessage(senderId, )
.then((result) => ...)
`
or
typescript
const result = await messageClient.sendImageMessage(senderId, )
`
This method will have the image cached by facebook so every receiver after the first will get it quickly.$3
javascript
messageClient.sendButtonsMessage(senderId, [])
.then((result) => ...)
`
or
typescript
const result = await messageClient.sendButtonsMessage(senderId, [])
`
Buttons format$3
javascript
messageClient.sendQuickReplyMessage(senderId, , [])
.then((result) => ...)
`
or
typescript
const result = await messageClient.sendQuickReplyMessage(senderId, , [])
`
Quick Reply format$3
javascript
messageClient.sendGenericTemplate(senderId, [ELEMENTS])
.then((result) => ...)
`
or
typescript
const result = await messageClient.sendGenericTemplate(senderId, [ELEMENTS])
`
Generic Template element format$3
javascript
messageClient.sendListMessage(senderId, [ELEMENTS], , [FINAL_BUTTONS])
.then((result) => ...)
`
or
typescript
const result = await messageClient.sendListMessage(senderId, [ELEMENTS], , [FINAL_BUTTONS])
`
is optional. If not provided defaults to large$3
javascript
messageClient.markSeen(senderId);
`
As per all methods, callback can be provided. If no callback provided returns promise. Recommended to send and continue processing without waiting for reply.$3
javascript
messageClient.toggleTyping(senderId, );
`
As per all methods, callback can be provided. If no callback provided returns promise. Recommended to send and continue processing without waiting for reply.
Defaults to if no boolean parameter provided.
$3
`javascript
messageClient.getUserProfile(senderId,[])
.then((result) => ...)
`
or
typescript
const result = await messageClient.getUserProfile(senderId,[])
`
Valid properties: ,last_name,profile_pic,locale,timezone,gender,is_payment_enabled,last_ad_referral
If none are given defaults to only.Incoming Message Parser
Extracts all relevant & known message types that can be found here. Returns array with all objects of interest. Left flexibility to user to filter out message types of interest per use case instead of returning dictionary object with each message type as a separate list for optional performance saving in case of usage on time sensitive platforms (AWS Lambda, AF, GCF, etc).`typescript
import {FacebookMessageParser} from 'fb-messenger-bot-api';
const messages = FacebookMessageParser.parsePayload(incomingPayload);
`Setting Messenger Profile
Initialize
javascript
const profileClient = new facebook.FacebookProfileAPIClient(process.env.PAGE_ACCESS_TOKEN);
`
or
typescript
import {Profile} from 'fb-messenger-bot-api';
const profileClient = new FacebookProfileAPIClient(process.env.PAGE_ACCESS_TOKEN);
`
Using proxy
javascript
const profileClient = new facebook.FacebookProfileAPIClient(process.env.PAGE_ACCESS_TOKEN, { hostname:process.env.PROXY_HOST, port: process.env.PROXY_PORT });
`
$3
javascript
profileClient.setGreetingMessage('Message that will be visible first thing when opening chat window with your bot/page')
.then((result) => ...)
`
or
typescript
const result = await profileClient.setGreetingMessage('Message that will be visible first thing when opening chat window with your bot/page');
`
$3
javascript
profileClient.setGetStartedAction(senderId, payload)
.then((result) => ...)
`
or
typescript
const result = await profileClient.setGetStartedAction(senderId, payload)
`
is the value that will be first sent when new user sends first message, once per user interaction$3
`javascript
profileClient.setPersistentMenu(senderId, [])
.then((result) => ...)
`
or
typescript
const result = await profileClient.setPersistentMenu(senderId, [])
`
This is a burger menu appearing next to the chat input field where users can click and get direct interaction shortcuts to specific functionality of the bot.
Persistent menu formatSending Facebook Page Posts
Initialize
javascript
const pageClient = new facebook.FacebookPageAPIClient(process.env.PAGE_ID, process.env.PAGE_ACCESS_TOKEN);
`
or
typescript
import {FacebookPageAPIClient} from 'fb-messenger-bot-api';
const pageClient = new FacebookPageAPIClient(process.env.PAGE_ID, process.env.PAGE_ACCESS_TOKEN)
`
Using proxy
javascript
const pageClient = new facebook.FacebookPageAPIClient(process.env.PAGE_ID, process.env.PAGE_ACCESS_TOKEN, { hostname:process.env.PROXY_HOST, port: process.env.PROXY_PORT });
`
Defaults to if no protocol providedRequires a never expiring
publishing_actions token that can be obtained by following this guide.$3
`javascript
pageClient.imageUrl().imageCaption().sendImage();
` is the url of the image being posted is the text you want on top of the image is optional callback otherwise promise is returned$3
`javascript
pageClient.postUrl().postMessage().sendPost();
` is the url of the link being posted is the text you want on top of the link is optional callback otherwise promise is returnedValidating Facebook Webhook
$3
`javascript
const facebook = require('fb-messenger-bot-api');
const router = require('express').Router();
router.get('/api/webhook',(req, res) => facebook.ValidateWebhook.validateServer(req,res));
`
Example based on usage with Express Router, can use any other middleware which passes in the req and response objects.
Assumes verification token set under .Alternatively, if you want to pass in your set token in a different manner or under different name you can use
`javascript
ValidateWebhook.validateServer(req, res, );
`This allows you to obtain the value as you wish and still use it as above with the help of currying.
javascript
...
const validateWebhook = function validateWebhook(token) {
return (req, res) => facebook.ValidateWebhook.validateServer(req, res, token);
}
const validator = validateWebhook();
router.get('/api/webhook/',validator);
`$3
Alternatively, you can use this when running on AWS Lambda to take advantage of the serverless paradigm as follows:typescript
import {ValidateWebhook} from 'fb-messenger-bot-api';
const handler = (event, context, callback: Function) => {
...
if(event.httpMethod === 'GET') {
ValidateWebhook.validateLambda(event, callback);
}
...
}
`
Both and validateServer support passing in verification token as third parameter. Otherwise will check process.env.FB_VERIFICATION_TOKEN for value.Validating Message Integrity
Validates the integrity of the message received from Facebook platform using the provided signature signed with Facebook Application Secret.The Facebook application secret can be provided either as second optional parameter to
ValidateWebhook.validateMessageIntegrity( or by setting process.env.FB_APPLICATION_SECRET.Compatible with both server/less paradigms as part of single line middleware function to Express or as Lambda first check before callback or remainder or programme.
`typescript
import {ValidateWebhook} from 'fb-messenger-bot-api';
const messageIntegrityChecker = (req, res) => {
const validMessage = ValidateWebhook.validateMessageIntegrity(req.headers["x-hub-signature"]);
...
}
router.post('/api/webhook/',messageIntegrityChecker);
`Complete example
javascript
const router = require('express').Router();
const facebook = require('fb-messenger-bot-api');
const messagingClient = new facebook.FacebookMessagingAPIClient(process.env.PAGE_ACCESS_TOKEN);
const messageParser = facebook.FacebookMessageParser;
...
router.get('/api/webhook',facebook.ValidateWebhook.validateServer);
router.post('/api/webhook', (req, res) => {
const incomingMessages = messageParser.parsePayload(req.body);
...
messagingClient.markSeen(senderId)
.then(() => client.toggleTyping(senderId,true))
.catch((err) => console.log(error));
...
//promise based reaction on message send confirmation
messagingClient.sendTextMessage(senderId, 'Hello')
.then((result) => console.log(Result sent with: ${result}));
...
//callback based reaction on message confirmation
messagingClient.sendTextMessage(senderId, 'Hello',(result) => console.log(Result sent with: ${result}));
...
//silent message sending
messagingClient.sendTextMessage(senderId,'Hello');
})
`
or
typescript
import {FacebookMessagingAPIClient, ValidateWebhook, FacebookMessageParser} from 'fb-messenger-bot-api';
import {Router} from 'express';
...
router.get('/api/webhook',facebook.ValidateWebhook.validateServer);
router.post('/api/webhook', (req, res) => {
try {
const incomingMessages = messageParser.parsePayload(req.body);
...
await messagingClient.markSeen(senderId);
await messagingClient.toggleTyping(senderId,true));
...
//promise based reaction on message send confirmation
const result = await messagingClient.sendTextMessage(senderId, 'Hello');
console.log(Result sent with: ${result}));
...
} catch(e){...}
//callback based reaction on message confirmation
messagingClient.sendTextMessage(senderId, 'Hello',(result) => console.log(Result sent with: ${result}));
...
//silent message sending
messagingClient.sendTextMessage(senderId,'Hello');
});
``