Send message through Facebook Messenger Send API.
$ npm install fbm-send
Use the fbm-webhook
module for handling the Facebook Messenger webhook events.
const FbmSend = require("fbm-send");
const fbmWebhook = require("fbm-webhook");
const webhook = fbmWebhook({
path: "/webhook",
appSecret: "Your Facebook App Secret",
verifyToken: "Your Predefined Verify Token"
});
const fbmSend = new FbmSend({
accessToken: "Your Page Access Token",
version: "4.0"
});
// Listen to the message event.
webhook.on("message", async event => {
// Reply with text.
const response = await fbmSend.request({
recipient: event.sender,
messaging_type: "RESPONSE",
message: {
text: "Hello World!"
}
});
console.log(response);
});
webhook.listen(3000, () => console.log("Server is running on port: 3000"));
accessToken
: Your Facebook page access token, default toprocess.env.FB_PAGE_ACCESS_TOKEN
.version
: The Facebook Graph API version, default to4.0
.
You can use the try...catch
block to catch the API error response:
try {
await fbmSend.request({
recipient: event.sender,
messaging_type: "RESPONSE",
message: {
text: "Hello World!"
}
});
} catch(error) {
if (error.response) {
console.log(error.response); // The API error response object.
}
}
- Constructor
- Send Request
- Send Text
- Send Attachment
- Send Image/Video/Audio
- Send Saved Attachment
- Send Sender Action
- Send Mark Seen/Typing On/Typing Off
Create a new fbm-send
instance.
new FbmSend([{
accessToken = process.env.FB_PAGE_ACCESS_TOKEN,
version = "4.0"
}]);
accessToken
(optionalString
): The Facebook page access token, default toprocess.env.FB_PAGE_ACCESS_TOKEN
.version
(optionalString
): The Facebook Graph API version, default to4.0
.
Use the request
method to send an HTTP request to the Send API. All other methods are just a wrapper around this method.
const response = await request({
recipient,
formData = false,
...body
});
recipient
(String
|Object
): The message recipient.formData
(optionalBoolean
): Send the request as amultipart/form-data
(for uploading a local file), default tofalse
.body
(Object
): The request payload to send.
The recipient can be a String
: PSID
, phone_number
, or a user_ref
.
It can also be an Object
as defined in the documentation: recipient object.
// Recipient as a string.
const recipient = "1234567"; // PSID, phone_number, or user_ref
// Equals to recipient as an object.
const recipient = {
id: "1234567"
}
As of Graph API version 2.2
, you're required to pass the messaging_type
(String
). There are three supported values for messaging_type
:
RESPONSE
(default value)UPDATE
MESSAGE_TAG
Read more in the messaging type documentation.
It returns a Promise
which when resolved contains a response from the API.
Send a simple text to the user:
const response = await fbmSend.request({
recipient: "123456",
messaging_type = "RESPONSE",
message: {
text: "Hello World!"
}
});
// Equals to:
const response = await fbmSend.request({
recipient: {
id: "123456"
},
messaging_type = "RESPONSE",
message: {
text: "Hello World!"
}
});
Send a file from a local filesystem:
const fs = require("fs");
const myFile = fs.createReadStream(`${__dirname}/test.txt`);
const response = await fbmSend.request({
recipient: "123456",
messaging_type = "RESPONSE",
message: {
attachment: {
type: "file",
payload: {
is_reusable: true
}
}
},
filedata: myFile,
formData: true // Must be set to TRUE!
});
Check the Send Attachment feature for more simpler approach.
Send quick replies:
const response = await fbmSend.request({
recipient: "123456",
messaging_type: "RESPONSE",
message: {
text: "Choose your Jedi",
quick_replies: [
{
content_type: "text",
title: "Yoda",
payload: "yoda"
},
{
content_type: "text",
title: "Luke Skywalker",
payload: "luke_skywalker"
}
]
}
});
Send URL buttons:
const response = await fbmSend.request({
recipient: "123456",
messaging_type: "RESPONSE",
message: {
attachment: {
type: "template",
payload: {
template_type: "button",
text: "Jedi Wiki",
buttons: [
{
type: "web_url",
url: "https://en.wikipedia.org/wiki/Yoda",
title: "Yoda"
},
{
type: "web_url",
url: "https://en.wikipedia.org/wiki/Luke_Skywalker",
title: "Luke Skywalker"
}
]
}
}
}
});
Send a plain text to the user:
const response = await fbmSend.text(text, {
to,
messagingType: "RESPONSE"
});
text
(String
): The text to send.to
(String
|Object
): The recipient.messagingType
(optionalString
): The messaging type, default toRESPONSE
.
const response = await fbmSend.text("Hello World!", {
to: "123456"
});
Overriding the default messaging type:
const { UPDATE } from "fbm-send/messaging-types";
const response = await fbmSend.text("Hello World!", {
to: "123456",
messagingType: UPDATE
});
Send an attachment to the user:
const response = await fbmSend.attachment(file, {
to,
messagingType = "RESPONSE",
type = "file",
isReusable = false
});
file
(String
): The remote URL of the file or the local file path.to
(String
|Object
): The recipient.messagingType
(optionalString
): The messaging type, default toRESPONSE
.type
(optionalString
): The type of the attachment:file
,image
,video
, oraudio
. Default tofile
.isReusable
(optionalBoolean
): Set totrue
to make the attachment reusable (no need to re-upload it again). Default tofalse
.
Provide file attachment as a remote URL (must be started with http://
or https://
):
const response = await fbmSend.attachment("https://example.com/photo.jpg", {
to: "1234567",
type = "image"
});
Provide file attachment as a local file:
const response = await fbmSend.attachment(`${__dirname}/test.txt`, {
to: "1234567",
type: "file"
});
Set isReusable
to true
to save the attachment, so it can later be reused without the needs to upload it again.
// The attachment_id can later be used
const { attachment_id } = await fbmSend.attachment(`${__dirname}/test.txt`, {
to: "1234567",
type: "file",
isReusable: true
});
Instead of re-uploading the file, the attachment_id
can later be referenced.
There are also wrapper methods to send an attachment with image, video, or audio type:
// Send image.
const response = await fbmSend.image(file, {
to,
messagingType = "RESPONSE",
isReusable = false
});
// Send video.
const response = await fbmSend.video(file, {
to,
messagingType = "RESPONSE",
isReusable = false
});
// Send audio.
const response = await fbmSend.audio(file, {
to,
messagingType = "RESPONSE",
isReusable = false
});
file
(String
): The remote URL of the file or the local file path.to
(String
|Object
): The recipient.messagingType
(optionalString
): The messaging type, default toRESPONSE
.isReusable
(optionalBoolean
): Set totrue
to make the attachment reusable (no need to re-upload it again). Default tofalse
.
const response = await fbmSend.image("https://example.com/photo.jpg", {
to: "1234567"
});
const response = await fbmSend.video(`../videos/cat.mp4`, {
to: "1234567",
isReusable: true
});
const response = await fbmSend.audio("https://example.com/sound.mp3", {
to: "1234567",
messagingType: "UPDATE"
});
When sending an attachment, set the isReusable
to true
to save the file for later use. You'll get the attachment_id
from the API response. You can use this attachment_id
to send the same file without the needs to re-upload it again.
const response = await fbmSend.attachmentId(id, {
to,
messagingType = "RESPONSE",
type = "file"
});
id
(String
): The attachment id.to
(String
|Object
): The recipient.messagingType
(optionalString
): The messaging type, default toRESPONSE
.type
(optionalString
): The type of the attachment:file
,image
,video
, oraudio
. Default tofile
.
// Send an attachment and get the id for later use.
const { attachment_id } = await fbmSend.attachment(`${__dirname}/test.txt`, {
to: "123456",
type: "file",
isReusable: true // Set to TRUE
});
// Use the saved attachment file.
const response = await fbmSend.attachmentId("98765432", {
to: "567890",
type: "file"
});
Send sender action to the user:
const response = await fbmSend.action(type, {
to
});
type
(String
): The action type:mark_seen
,typing_on
, ortyping_off
.to
(String
|Object
): The recipient.
const { MARK_SEEN, TYPING_ON, TYPING_OFF } = require("fbm-send/src/sender-actions");
const response = await fbmSend.action(MARK_SEEN, {
to: "1234"
});
const response = await fbmSend.action(TYPING_ON, {
to: "1234"
});
const response = await fbmSend.action(TYPING_OFF, {
to: "1234"
});
There are also wrapper methods to send mark seen/typing on/typing off action to the user:
const response = await fbmSend.markSeen({ to });
const response = await fbmSend.typingOn({ to });
const response = await fbmSend.typingOff({ to });
to
(String
|Object
): The recipient.
// Send mark as seen action.
const response = await fbmSend.markSeen({
to: "1234"
});
// Send typing on action.
const response = await fbmSend.typingOn({
to: "1234"
});
// Send typing off action.
await fbmSend.typingOff({
to: "1234"
});
- fbm-webhook: Facebook Messenger webhook middleware for Express.
This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by Facebook or any of its affiliates or subsidiaries. This is an independent and unofficial API.