messenger-node
Advanced tools
Readme
The messenger-node module is a server-side SDK for building bots on Facebook's Messenger Platform. The SDK includes two base classes:
The SDK is available via NPM:
npm install messenger-node --save
To use the SDK, start by importing it into your project:
const Messenger = require('messenger-node');
Once the SDK is imported, you can create instances of the Webhook and Client classes.
Messenger.WebhookEvery Messenger bot has to have a webhook that the Messenger Platform can send webhook events to. This SDK provides a simple Webhook class that you can instantiate to create and run a fully-functional webhook. The webhook can do all these things for you:
getContext() function.Basically it saves you the hassle of writing the basic stuff so you can get to building your bot right away.
To create a webhook, start by creating an instance of the Webhook class. The following configuration properties may be provided when the Webhook instance is created:
verify_token: Required. The token to use for webhook verification. The Messenger Platform will send this with the challenge request when you register your webhook.port: Optional. The port number your webhook should listen on. Defaults to the process.env.PORT.endpoint: Optional. The endpoint for your webhook. For example, if your webhook base URL is https://www.mywebhook.com and endpoint is set to bananas, the full URL that you should tell the Messenger Platform to send webhook events to is https://www.mywebhook.com/bananas/. Defaults to webhookapp_secret: Optional. Your app secret. This is required if you want to validate signed webview requests using Webhook.validateSignedRequest().let webhook_config = {
'verify_token':'MY_VERIFY_TOKEN'
}
const Webhook = new Messenger.Webhook(webhook_config);
When the Messenger Platform sends your webhook a webhook event the SDK will emit it by name, and include info about the sender and the full body of the received event.
For a list of available webhook events, see the list in the Messenger Platform docs.
To listen for a particular event, all you have to do is add an event listener with Webhook.on or [Webhook.once](#once):
Webhook.on('messaging_postbacks', (event_type, sender_info, webhook_event) => {
// do something
});
You can also emit events, which can be useful for testing:
Webhook.emit('messaging_postbacks', event_type, sender_info, webhook_event);
| Name | Type | Description | Example |
|---|---|---|---|
| event_type | Object | Contains the event type and subtype. If the webhook has no subtype, then event_type.subtype will be null | {'type': 'messaging_handovers', 'subtype': 'pass_thread_control} |
| sender_info | Object | Contains the ID and ID type. | {'value': '84736289974242', 'type': 'PSID'} |
| webhook_event | Object | The complete webhook event parsed from the messaging array of the received POST request. | For webhook event formats and details, see the webhook event reference in the Messenger Platform docs. |
All webhook events sent by the Messenger Platform are supported. To listen for the event, all you have to do is attach an event listener for the event name:
messagesmessaging_postbacksmessage_readsmessage_echoesmessage_deliveriesmessaging_handoversmessaging_referralsmessaging_optinsmessaging_paymentsmessaging_pre_checkoutsmessaging_checkout_updatesmessaging_game_playsmessaging_policy_enforcementmessaging_account_linkingstandbyMessenger.ClientOnce you have a working webhook, you need a way to respond to the events and messages your bot receives. This means you need to be able to send allllll kiiinnndddsss of API requests to the Messenger Platform. The Client provided by this SDK makes this a much simpler declarative process by handling all the repetitive (and error prone) parts of formatting valid API requests for you, and making sure they get sent to the right place.
Client InstanceTo make API calls, start by creating an instance of the Client class. The following configuration properties may be provided when the Client instance is created:
page_token: Required. A valid Page-scope access token for the Page associated with your bot. This will be sent with almost every API request.app_token: Optional. A valid app-scoped access token. This is only used for certain calls to the Platform's ID Matching API.api_version: Optional. The version of the Graph API to target for all API requests in the format v2.11. Defaults to the latests version of the Graph API.let client_config = {
'page_token': 'EAAYcRUPT1JNby4BSexAmPMuy3QBAGYBAorwzZC7FnQZBZBkFZAOZAF9CBQzt6qsdCwg',
'app_token': 'qsdT1JNby4BSexAmPMuy3QBAGYBAorwzZC7FnQZBZBEAAYcRUPFkFZAOZACwg9CBQzt6',
'api_version': 'v2.11'
}
const Client = new Messenger.Client(client_config);
All Messenger Platform API requests are included as instance functions that are called on the Client instance. Here are a few examples. For a complete list, see the Client reference below.
Here are a few example requests. The Reference also includes examples for every call.
Send a Text Message
// define the message recipient
let recipient = {
'id': '1234556'
};
// set the message to send
let text = 'This is my amazing text message?!'
// send the text message
Client.sendText(recipient, text)
.then(res => {
// log the api response
console.log(res);
})
.catch(e => {
console.error(e);
});
Send a Generic Template Message
// define the message recipient
let recipient = {
'id': '1234556'
};
// define the generic template
let generic_template = {
template_type: 'generic',
elements: [
{
'title':'This is a generic template',
'subtitle':'Plus a subtitle!',
'buttons':[
{
'type':'postback',
'title':'Postback Button',
'payload':'postback_payload'
},
{
'type': 'web_url',
'title': 'URL Button',
'url': 'https://messenger.fb.com/'
}
]
}
]
}
// send the template
Client.sendTemplate(recipient, generic_template)
.then(res => {
// log the api response
console.log(res);
});
.catch(e) {
console.error(e);
}
Get a User's Profile
// PSID of the user
let psid = '12345324'
// profile fields to retrieve
let fields = ['id', 'first_name', 'last_name', 'profile_pic']
Client.getUserProfile(psid, fields)
.then(res => {
// log the api response
console.log(res);
});
.catch(e) {
console.error(e);
}
All SDK functions return a promise that resolves with the full API response received from the Messenger Platform on success, and rejects with an error string on failure. Functions also do light input-checking when called, and will reject if incorrect arguments are provided.
The SDK does not transform the API response in any way, other than ensuring you get back a JSON object.
Creates an instance of Client, used for sending requests to the Messenger Platform APIs.
options Object An object that contains the configuration settings for the Client.
options.page_token String A valid Page-scoped access token.options.app_token String Optional. A valid app-scoped access token. Required for ID Matching.options.graph_api_version String Optional. The version of the Graph API to target for all API requests. Defaults to latest. Must be in the format v2.11.const Messenger = require('messenger-node');
let options = {
'page_token': 'sd0we98h248n2g40gh4g80h32',
'app_token': 'ih908wh084ggh423940hg934g358h0358hg3', //optional
'api_version': 'v2.9' //optional
}
const Client = new Messenger.Client(options);
Returns Client
Uploads media using the Attachment Upload API.
attachment Object An object that describes the attachment to send.
Upload from URL
let recipient = {'id': '57024957309673'},
attachment = {
'type':'image',
'source':'https://www.example.com/dog.png',
'is_reusable':true
}
Client.uploadAttachment('url', 'https://www.example.com/image.jpg')
.then(res => {
console.log(res) // {'attachment_id': 09754203957254}
});
Upload from file
let recipient = {'id': '57024957309673'},
attachment = {
'type':'image',
'source':'/Users/me/Desktop/dog.jpg',
'is_reusable':true
}
Client.uploadAttachment(attachment)
.then(res => {
console.log(res); // {'attachment_id': 09754203957254}
});
Returns Promise<Object> The API response
Sets a new page token to use for all Page-level requests
tokenpage_token string The new page tokenClient.setPageToken('sgh084th3t3ht340t34h8t3t940390th34')
.then(res => {
console.log(res) // 'sgh084th3t3ht340t34h8t3t940390th34'
});
Returns string Updated page token
Gets the current page token being used for page-level requests
Client.getPageToken()
.then(res => {
console.log(res) // 'sgh084th3t3ht340t34h8t3t940390th34'
});
Returns string Current page token
Sets a new app token to use for all app-level requests
tokenapp_token string The new app tokenClient.setAppToken('9h03t9h0ahtg409thw3t34h8t3t940390th34')
.then(res => {
console.log(res) // '9h03t9h0ahtg409thw3t34h8t3t940390th34'
});
Returns string Updated app token
Gets the current app token being used for app-level requests
Client.getAppToken()
.then(res => {
console.log(res) // '9h03t9h0ahtg409thw3t34h8t3t940390th34'
});
Returns string Current app token
Sets a new Graph API version to use for all requests
version string The new version in the format v2.11Client.setApiVersion('v2.6')
.then(res => {
console.log(res) // 'v2.6'
});
Returns string Updated version number
Gets the current Graph API version being used for all requests
Client.getApiVersion()
.then(res => {
console.log(res) // 'v2.6'
});
Returns string Current Graph API version
Initiates a new handover protocol pass thread control event.
psid Integer The PSID of the user whose thread you want to initiate the pass thread control event for.target_app_id Integer Optional. The app ID of the app to pass thread control to. Set to page_inbox to pass thread control to the Page Inbox.metadata String Optional. An arbitrary string that will be delivered to the target app with the messaging_handovers webhook event.let psid = 1008372609250235,
target_app_id = 1719933432123212,
metadata = 'I passed control to you'; // optional
Client.passThreadControl(psid, target_app_id, metadata)
.then(res => {
console.log(res); // {'success': true}
});
Returns Promise The API response
Initiates a new handover protocol take thread control event. This may only be called by the app with the Primary Receiver app role.
psid Integer The PSID of the user whose thread you want to initiate the take thread control event for.metadata String Optional. An arbitrary string that will be delivered to the Secondary Receiver app with the messaging_handovers webhook event.let psid = 1008372609250235,
metadata = 'I'm taking control from you'; // optional
Client.takeThreadControl(psid, metadata)
.then(res => {
console.log(res); // {'success': true}
});
Returns Promise The API response
Initiates a new handover protocol request thread control event.
psid Integer The PSID of the user whose thread you want to initiate the request thread control event for.metadata String Optional. An arbitrary string that will be delivered to the Primary Receiver app with the messaging_handovers webhook event.let psid = 1008372609250235,
metadata = 'I'm requesting control from you'; // optional
Client.requestThreadControl(psid, metadata)
.then(res => {
console.log(res); // {'success': true}
});
Returns Promise The API response
Retrieves the app ID of the current thread owner.
psid Integer The PSID of the user whose thread you want to get the thread owner of.metadata String Optional. An arbitrary string that will be delivered to the target app with the messaging_handovers webhook event.let psid = 1008372609250235
Client.getThreadOwner(psid)
.then(res => {
console.log(res);
// {
// "data": [{
// "thread_owner": {
// "app_id": "1719933678308212"
// }
// }]
// }
});
Returns Promise The API response
Retrieves a list of app ID's of all Secondary Receivers for the Page.
psid Integer The PSID of the user whose thread you want to get the list of Secondary Receiver apps for.let psid = 1008372609250235
Client.getThreadOwner(psid)
.then(res => {
console.log(res);
// {
// "data": [
// {
// "id": "12345678910",
// "name": "David's Composer"
// },
// {
// "id": "23456789101",
// "name": "Messenger Rocks"
// }
// ]
// }
});
Returns Promise The API response
Sends a new broadcast message via the Broadcast API.
message_creative_id Integer The ID of a message creative to send in the broadcast. Created by calling Client.createMessageCreative().custom_label_id Integer Optional. The ID of a custom label to target for the broadcast. Created by calling Client.createCustomLabel().let message_creative_id = 499792492764246,
custom_label_id = 097046973276-46; // optional
Client.sendBroadcast(message_creative_id, custom_label_id)
.then(res => {
console.log(res); // {'broadcast_id': 397230957240952}
});
Returns Promise The API response
Start a reach estimation for the number of people that will be reached by a broadcast to all users or to users associated with a custom label.
custom_label_id Integer Optional. The ID of a custom label targeted by the broadcast. Created by calling Client.createCustomLabel().let custom_label_id = 3467390467035645 //optional
Client.startBroadcastReachEstimation(custom_label_id)
.then(res => {
console.log(res); // {"reach_estimation_id": "9485676932424"}
});
Returns Promise<Object> The API Response
Get the current status of a broadcast reach estimation
{@link #startbroadcastreachestimation|startBroadcastReachEstimation
must be run first to get a reach_estimation_id.
reach_estimation_id Integer The reach estimation ID.Client.getBroadcastReachEstimation(9485676932424)
.then(res => {
console.log(res); // {"reach_estimation": "100", "id": "9485676932424"}
});
Returns Promise<Object> The API Response
Creates a new custom label.
name String The name of the custom label.Client.createCustomLabel('my_custom_label')
.then(res => {
console.log(res); // {"id": "9485676932424"}
});
Returns Promise<Object> The API response
Retrieves the id and name of a custom label.
label_id Integer The ID of a custom label. Created with createCustomLabel().let custom_label_id = 9485676932424,
field = ['name', 'id']; //optional
Client.getCustomLabelById(custom_label_id, fields)
.then(res => {
console.log(res); // {"name": "my_custom_label", "id": "9485676932424"}
});
Returns Promise<Object> The API response
Retrieves the list of custom labels associated with a PSID.
psid Integer The PSID of the user to retrieve the custom labels for.Client.getCustomLabelsByPsid(950724069735075)
.then(res => {
console.log(res);
// {
// "data": [
// { "name": "myLabel", "id": "1001200005003"},
// { "name": "myOtherLabel", "id": "1001200005002"}
// ],
// "paging": {
// "cursors": {
// "before": "QVFIUmx1WTBpMGpJWXprYzVYaVhabW55dVpyc",
// "after": "QVFIUmItNkpTbjVzakxFWGRydzdaVUFNNnNPaU"
// }
// }
// }
});
Returns Promise<Object> The API response
Retrieves the list of all custom labels.
let field = ['name', 'id']; //optional
Client.getAllCustomLabels(fields)
.then(res => {
console.log(res);
// {
// "data": [
// { "name": "myLabel", "id": "1001200005003"},
// { "name": "myOtherLabel", "id": "1001200005002"}
// ],
// "paging": {
// "cursors": {
// "before": "QVFIUmx1WTBpMGpJWXprYzVYaVhabW55dVpyc",
// "after": "QVFIUmItNkpTbjVzakxFWGRydzdaVUFNNnNPaU"
// }
// }
// }
});
Returns Promise<Object> The API response
Deletes a custom label.
label_id Integer The ID of the custom label to delete.Client.deleteCustomLabel(094730967209673)
.then(res => {
console.log(res); // {"success": true}
});
Returns Promise<Object> The API response
Associates a user's PSID to a custom label.
psid Integer PSID of the user to associate with the custom label.label_id Integer The ID of a custom label. Created with createCustomLabel().let psid = 49670354734069743,
custom_label_id = 0957209720496743;
Client.addPsidtoCustomLabel(psid, custom_label_id)
.then(res => {
console.log(res); // {"success": true}
});
Returns Promise<Object> The API response
Removes a user PSID from a custom label.
psid Integer PSID of the user to remove from the custom label.label_id Integer The ID of a custom label.let psid = 49670354734069743,
custom_label_id = 0957209720496743;
Client.removePsidfromCustomLabel(psid, custom_label_id)
.then(res => {
console.log(res); // {"success": true}
});
Returns Promise<Object> The API response
Creates a new message creative.
message Object An object that describes the message to send.Text Message
let message = {'text': 'my text message'};
Client.createMessageCreative(message)
.then(res => {
console.log(res); // {"message_creative_id": "953434576932424"}
});
Template Message
let message = {
template_type: 'generic',
elements: [
{
'title':'This is a generic template',
'subtitle':'Plus a subtitle!',
'image_url':'https://www.example.com/dog.jpg',
'buttons':[
{
'type':'postback',
'title':'Postback Button',
'payload':'postback_payload'
},
{
'type': 'web_url',
'title': 'URL Button',
'url': 'https://www.example.com/'
}
]
}
]
};
Client.createMessageCreative(message)
.then(res => {
console.log(res); // {"message_creative_id": "953434576932424"}
});
Returns Promise<Object> The API response
Sends a text message via the Send API.
recipient Object An object that describes the message recipient in the format: {<id_type>: <id>}.
For example, sends to a PSID would be {'id': 123456}, to a phone number `{'phone_number': '+1 (408) 444-4444'}.text String The text to send.let recipient = {'id': '57024957309673'},
text = 'This is a text message';
Client.sendText(text)
.then(res => {
console.log(res);
// {
// "recipient_id": "1008372609250235",
// "message_id": "mid.1456970487936:c34767dfe57ee6e339"
// }
});
Returns Promise<Object> The API response
Sends a set of quick reply buttons via the Send API.
recipient Object An object that describes the message recipient in the format: {<id_type>: <id>}.
For example, sends to a PSID would be {'id': 123456}, to a phone number `{'phone_number': '+1 (408) 444-4444'}.quick_replies Object An object that describes the quick replies to send. This is the message.quick_replies property that would normally be included in a Send API request.text String Optional. Text message to send with quick replies.Generic Template
let recipient = {'id': '57024957309673'};
let quick_replies = [
{
'content_type':'text',
'title':'Quick Reply 1',
'image_url':'https://www.example.com/icon.png',
'payload':'quick_reply_payload'
},
{
'content_type':'location'
}
];
let text = 'Text message to send with the quick replies'; //optional
Client.sendQuickReplies(recipient, quick_replies, text)
.then(res => {
console.log(res);
// {
// "recipient_id": "1008372609250235",
// "message_id": "mid.1456970487936:c34767dfe57ee6e339"
// }
});
Returns Promise<Object> The API response
Sends a standalone attachment, including images, audio, video, and files via the Send API.
attachment Object An object that describes the attachment to send.
recipient Object An object that describes the message recipient in the format: {<id_type>: <id>}.
For example, sends to a PSID would be {'id': 123456}, to a phone number `{'phone_number': '+1 (408) 444-4444'}.Send attachment from URL
let recipient = {'id': '57024957309673'},
attachment = {
'type':'image',
'source':'https://www.example.com/dog.png',
'is_reusable':true
}
Client.sendAttachment(attachment, recipient)
.then(res => {
console.log(res); // {"id": "9485676932424"}
// {
// "recipient_id": "1008372609250235",
// "message_id": "mid.1456970487936:c34767dfe57ee6e339",
// "attachment_id": "395723096739076353"
// }
});
});
Send attachment from file
let recipient = {'id': '57024957309673'},
attachment = {
'type':'image',
'source':'/Users/me/Desktop/dog.jpg',
'is_reusable':true
}
Client.uploadAttachment(attachment, recipient)
.then(res => {
console.log(res); // {'attachment_id': 09754203957254}
// {
// "recipient_id": "1008372609250235",
// "message_id": "mid.1456970487936:c34767dfe57ee6e339",
// "attachment_id": "395723096739076353"
// }
});
Returns Promise<Object> The API response
Sends a template message via the Send API.
recipient Object An object that describes the message recipient in the format: {<id_type>: <id>}.
For example, sends to a PSID would be {'id': 123456}, to a phone number `{'phone_number': '+1 (408) 444-4444'}.template Object An object that describes the template to send. This is the message.attachment.payload property that would normally be included in a Send API request.Generic Template
let recipient = {'id': '57024957309673'};
let message = {
template_type: 'generic',
elements: [
{
'title':'This is a generic template',
'subtitle':'Plus a subtitle!',
'image_url':'https://www.example.com/dog.jpg',
'buttons':[
{
'type':'postback',
'title':'Postback Button',
'payload':'postback_payload'
},
{
'type': 'web_url',
'title': 'URL Button',
'url': 'https://www.example.com/'
}
]
}
]
};
Client.sendTemplate(message)
.then(res => {
console.log(res);
// {
// "recipient_id": "1008372609250235",
// "message_id": "mid.1456970487936:c34767dfe57ee6e339"
// }
});
Media Template
let recipient = {'id': '57024957309673'};
let message = {
'template_type': 'media',
'elements': [
{
'media_type': 'image',
'url': 'https://www.example.com/dog.jpg'
},
'buttons':[
{
'type': 'web_url',
'title': 'URL Button',
'url': 'https://www.example.com/'
}
]
]
};
Client.sendTemplate(message)
.then(res => {
console.log(res);
// {
// "recipient_id": "1008372609250235",
// "message_id": "mid.1456970487936:c34767dfe57ee6e339"
// }
});
Returns Promise<Object> The API response
Sends a sender action via the Send API.
recipient Object An object that describes the message recipient in the format: {<id_type>: <id>}.
For example, sends to a PSID would be {'id': 123456}, to a phone number `{'phone_number': '+1 (408) 444-4444'}.sender_action String The sender action to send. Must be typing_on, typing_off, or mark_seen.let recipient = {'id': '57024957309673'},
sender_action = 'mark_seen';
Client.sendSenderAction(recipient, sender_action)
.then(res => {
console.log(res); // {"recipient_id": "1008372609250235"}
});
Returns Promise<Object> The API response
Sends a new Sponsored Message via the Messenger Platform.
ad_account_id Integer Your Facebook Ads account ID.options Object An object that describes the sponsored message to send.
options.message_creative_id String The ID of a message creative to send. Created by calling Client.createMessageCreative().options.daily_budget String The maximum daily budget of the ad campaign for the Sponsored Message send.options.bid_amount String The maximum bid for each message recipient.options.targeting String Targeting spec for the Sponsored Message send.let options = {
'message_creative_id': '34967347634346',
'daily_budget': '10',
'bid_amount': '1',
'targeting': '{'geo_locations': {'countries':['US']}}',
'ad_account_id': '9352379502706'
};
Client.sendSponsoredMessage('test', options)
.then(res => {
console.log(res);
// {
// "ad_group_id": "6088387928148",
// "broadcast_id": "754911018029273",
// "success": true
// }
});
Returns Promise<Object> The API response
Retrieves metrics from the Messaging Insights API.
options Object An object that describes the metrics data to retrieve.
let today = new Date().getTime();
let options = {
'metrics': [
'page_messages_active_threads_unique',
'page_messages_blocked_conversations_unique',
'page_messages_reported_conversations_unique',
'page_messages_reported_conversations_by_report_type_unique'
],
'since': today - 864000,
'until': today
};
Client.getMessagingInsights(options)
.then(res => {
console.log(res);
// {
// "data": [
// {
// "name": "<METRIC>",
// "period": "day",
// "values": [
// {
// "value": "<VALUE>",
// "end_time": "<UTC_TIMESTAMP>"
// },
// {
// "value": "<VALUE>",
// "end_time": "<UTC_TIMESTAMP>"
// }
// ]
// }
// ],
// }
});
Returns Promise<Object> The API response
Generate a new static or parametric Messenger Code for your bot.
options Object An object that describes the Messenger Code to generate.
options.ref Integer The ref string to pass to your bot is opened via the code. Max 250 characters. Valid characters: a-z A-Z 0-9 +/=-.:_.options.image_size Object The size, in pixels, for the image you are requesting. Supported range: 100-2000. Defaults to 1000.let options = {
'ref': 'referral_ref', //optional
'image_size': 500 //optional
};
Client.generateMessengerCode(options)
.then(res => {
console.log(res); // {"uri": "https://scontent.xx.fbcdn.net/v/t39..."}
});
Returns Promise<Object> The API response
Sets one or more properties of your bot's Messenger Profile.
fields Object An object that contains the Messenger Profile properties to set as key-value pairs.let fields = {
'whitelisted_domains': ['https://www.example.com'],
'get_started': {
'payload': 'callback_payload'
},
'greeting': [
{
'locale':'default',
'text':'Hello!'
}, {
'locale':'en_US',
'text':'Timeless apparel for the masses.'
}
]
};
Client.setMessengerProfile(fields)
.then(res => {
console.log(res); // {"result": "success"}
});
Returns Promise<Object> The API response
Retrieves one or more properties of your bot's Messenger Profile.
let fields = ['whitelisted_domains', 'greeting'];
Client.getMessengerProfile(fields)
.then(res => {
console.log(res);
// {
// "data": [
// {
// "whitelisted_domains": [
// "https://facebook.com/"
// ],
// "greeting": [
// {
// "locale": "default",
// "text": "Hello!"
// }
// ]
// }
// ]
// }
});
Returns Promise<Object> The API response
Deletes one or more properties of your bot's Messenger Profile.
let fields = ['whitelisted_domains', 'greeting'];
Client.deleteMessengerProfile(fields)
.then(res => {
console.log(res); // {"id": "9485676932424"}
});
Returns Promise<Object> The API response
Sets config values for [built-in NLP](https://developers.facebook.com/docs/messenger-platform/built-in-nlp.
configs Object The NLP configs to setlet configs = {
'nlp_enabled': true,
'model': 'ENGLISH',
'custom_token': '924t2904t7304ty3wo',
'verbose': true,
'n_best': 2
}
Client.setNlpConfigs(configs).then(res => {
.then(res => {
console.log(res) // { 'success': true }
});
Returns String configs.nlp_enabled Enable/disable built-in NLP. Must be true or false
Returns String configs.model The default NLP model to use. For values, see the Messenger Platform docs.
Returns String configs.custom_token Wit.ai server token for integrating a custom model.
Returns String configs.verbose Enables verbose mode, which returns extra information like the position of the detected entity in the query. Must be true or false.
Returns String configs.n_best The number of entities to return, in descending order of confidence. Minimum 1. Maximum 8.
Returns all Page-scoped IDs (PSIDs) for a user across all Pages in the same Facebook Business Manager account. Matches can be found using a PSID or ASID. Uses the ID Matching API.
id String A valid ASID or PSID.id_type String The type of ID provided in the id argument: ASID or PSID.Client.getMatchingPsids('95740976304764', 'PSID')
.then(res => {
console.log(res);
// {
// "data": [
// {
// "id": "1429384723454138",
// "page": {
// "name": "MyPage1",
// "id": "9384723458738365"
// }
// },
// {
// "id": "1254459384723459",
// "page": {
// "name": "MyPage2",
// "id": "689384723453165"
// }
// }
// ],
// "paging": {
// "cursors": {
// "before": "MTA4MDYxNjQ2ODczODM2NQZDZD",
// "after": "NjgyNDk4MTcxOTQzMTY1"
// }
// }
// }
});
Returns Promise<Object> The API response
Returns all app-scoped IDs (ASIDs) for a user across all Pages in the same Facebook Business Manager account. Matches can be found using a PSID or ASID. Uses the ID Matching API.
id String A valid ASID or PSID.id_type String The type of ID provided in the id argument: ASID or PSID.Client.getMatchingAsids('95740976304764', 'PSID')
.then(res => {
console.log(res);
// {
// "data": [
// {
// "id": "7234541381429384",
// "app": {
// "link": "https://www.facebook.com/games/?app_id=299493827472589",
// "name": "MyApp1",
// "id": "9948573218738365"
// }
// },
// {
// "id": "9384723459125445",
// "app": {
// "link": "https://www.facebook.com/games/?app_id=299490394856589",
// "name": "MyApp2",
// "id": "689384785732187"
// }
// }
// ],
// "paging": {
// "cursors": {
// "before": "ODczODM2NQZDZDMTA4MDYxNjQ2",
// "after": "TcxOTQzMTY1NjgyNDk4M"
// }
// }
// }
});
Returns Promise<Object> The API response
Retrieves a user's profile via the User Profile API.
psid Integer A valid user PSID.fields Array<String> Optional. An array list of the user profile filds to retrieve. For a list of available fields, see the Messenger Platform docs.let profile_fields = [
'id',
'first_name',
'last_name',
'profile_pic',
'locale',
];
Client.getUserProfile('490730697356', profile_fields)
.then(res => {
console.log(res);
// {
// "first_name": "Peter",
// "last_name": "Chang",
// "profile_pic": "https://fbcdn-profile-a.akamaihd.net/hprofile-ak-xpf1/v/t1.0-1/p200x200/13055603_10105219398495383_8237637584159975445_n.jpg?oh=1d241d4b6d4dac50eaf9bb73288ea192&oe=57AF5C03&__gda__=1470213755_ab17c8c8e3a0a447fed3f272fa2179ce",
// "locale": "en_US",
// }
});
Returns Promise<Object> The API response
Creates and starts a webhook that emits all received webhook events.
options Object Configuration options for your webhook. All options may also be set as environment variables.
options.verify_token string May also be set as MESSENGER_VERIFY_TOKEN in environment variables.options.endpoint string Optional. Defaults to /webhook. May also be set as MESSENGER_APP_ENDPOINT in environment variables.options.app_secret string Optional. Your app secret. Required for validateSignedRequest(). May also be set as MESSENGER_APP_SECRET in environment variables.options.port string Optional. Defaults to 1337. May also be set as MESSENGER_PORT in environment variables.const Messenger = require('messenger-node');
// you can also set these as env vars
let options = {
'verify_token': 'my_voice_is_my_passport',
'app_secret': 'ih908wh084ggh423940hg934g358h0358hg3', //optional
'endpoint': '/awesomewebhook' //optional
'port': '9485' //optional
}
const Webhook = new Messenger.Webhook(options);
Returns Webhook
Adds an event listener. Implements Node.js EventEmitter's emitter.on.
event_name String The name of the event to listen for.callback Function The callback to execute when the event is received.Webhook.on('messaging_postbacks', (event_type, sender_info, webhook_event) => {
// do something
});
Adds a one-time event listener that will be removed after it is called once. Implements Node.js EventEmitter's emitter.once.
event_name String The name of the event to listen for.callback Function The callback to execute when the event is received.Webhook.once('messaging_postbacks', (event_type, sender_info, webhook_event) => {
// do something
});
Emits an event from the Webhook instance. Event listeners can be set with Webhook.on() and Webhook.once(). Implements Node.js EventEmitter's emitter.once.
eventName Object The name of the event to emit.Webhook.emit('my_event', arg1, arg2);
Returns Object ...args Optional. Arguments to pass to the event listener.
Retrieves the current Webhook instance. This is the express.js app instance.
let instance = Webhook.getInstance();
console.log(instance) // express.js app instance
Returns Object The Webhook instance.
Stops the Webhook instance.
callback Function A callback function to execute when the webhook is stopped.Webhook.stopInstance(() => console.log('Webhook is stopped'));
Retrieves the port the webhook is running on.
let port = Webhook.getPort();
console.log(port) // '1337'
Returns String The current port number.
Retrieves the current endpoint of the webhook.
let endpoint = Webhook.getEndpoint();
console.log(endpoint) // '/webhook'
Returns String The current endpoint.
Retrieves the current verify token of the webhook.
let verifyToken = Webhook.getVerifyToken();
console.log(verifyToken) // 'my_verify_token'
Returns String The current verify token.
Sets the app secret used for validating signed requests.
app_secret String The app secret to set.let app_secret = Webhook.setAppSecret('hgr0a8h30gh30agh');
console.log(app_secret) // 'hgr0a8h30gh30agh'
Returns String The app secret that was successfully set.
Verifies a signed request received by calling getcontext() in the Messenger webview.
signed_request Object The signed request.let request = {
'tid': '1254453049382119',
'thread_type': 'USER_TO_PAGE',
'psid': '1254413049321919',
'signed_request': 'QDTuYBidQ7pbpxIbPwgsb__nHty2...'
};
let decrypted_request = Webhook.validateSignedRequest(signed_request);
console.log(decrypted_request)
// {
// "psid": "1254413049321919",
// "algorithm": "HMAC-SHA256",
// "thread_type": "GROUP",
// "tid": "1254453049382119",
// "issued_at": 1491351619,
// "page_id": 239483560376726
// }
Returns Object The decrypted signed request.
FAQs
An SDK for the Messenger Platform
The npm package messenger-node receives a total of 39 weekly downloads. As such, messenger-node popularity was classified as not popular.
We found that messenger-node demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.