Try any Node.js package right in your browser

Share this code:

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including botbuilder-facebookextension with all npm packages installed. Try it out:

BotBuilder Facebook Extension (NodeJS)

Features

Wishlist

Requirements

Getting Started

Install the package through NPM. npm install botbuilder-facebookextension --save. Choose which part of this package you would like to implement in your code.

User Profile API

In order to populate the userdata with the Facebook userdata, you can use a middleware. It will automatically retrieve the data from Facebook and store it before your first reply. By default it will refresh the userdata every day, but you can change it by passing an amount of minutes to the settings object.

A required setting for the middleware is the accessToken that you use in the Bot Framework settings. Optional settings are fields (array of fieldnames) and expireMinutes (number of minutes to cache data).

Callbacks

Facebook uses referrals, optins and postbacks to send a custom payload to your chatbot. We can use this payload to trigger a specific dialog without having to start a textchat first. With the CallbackRecognizer you are able to map a dialog to a specific referral-, postin- or postback payload.

It is possible to retrieve all values from the calback object by retrieving the entity. You can retrieve the entity on the regular way, by requesting the referral, optin or postback type. In this example you can see how to check the source of the referral, which can be shortlink (m.me) or ad.

Message Tags

Adding a Message Tag allows you to send it outside the 24+1 window, for a limited number of use cases (shipping update, reservations, and issue resolution), per Messenger Platform policy. You can find all possbile tags in the Message Tag documentation.