Messaging API client for Messenger
npm install messaging-api-messenger> Messaging API client for Messenger

- Installation
- Usage
- API Reference
- Send API
- Content Types
- Templates
- Quick Replies
- Sender Actions
- Attachment Upload API
- Message Batching
- Custom Labels
- User Profile API
- Messenger Profile API
- Persistent Menu
- Get Started Button
- Greeting Text
- Whitelisted Domains
- Account Linking URL
- Handover Protocol API
- Page Messaging Insights API
- Built-in NLP API
- Event Logging API
- ID Matching API
- Persona API
- Others
- Debug Tips
- Testing
``sh`
npm i --save messaging-api-messenger
or
`sh`
yarn add messaging-api-messenger
`js
const { MessengerClient } = require('messaging-api-messenger');
const client = new MessengerClient({
accessToken: ACCESS_TOKEN,
appId: APP_ID,
appSecret: APP_SECRET,
version: '6.0',
});
`
If the version option is not specified, 6.0 will be used by default.
If appSecret is provided, MessengerClient will enable this feature automatically and include appsecret_proof in every Graph API requests. To skip it, set the skipAppSecretProof option to true:
`js`
const client = new MessengerClient({
accessToken: ACCESS_TOKEN,
appId: APP_ID,
appSecret: APP_SECRET,
skipAppSecretProof: true,
});
messaging-api-messenger uses axios as HTTP client. We use axios-error package to wrap API error instances for better formatting error messages. Directly calling console.log with the error instance will return formatted message. If you'd like to get the axios request, response, or config, you can still get them via those keys on the error instance.
`js`
client.sendRawBody(body).catch((error) => {
console.log(error); // formatted error message
console.log(error.stack); // error stack trace
console.log(error.config); // axios request config
console.log(error.request); // HTTP request
console.log(error.response); // HTTP response
});
All methods return a Promise.
- sendText
- sendAttachment
- sendAudio
- sendImage
- sendVideo
- sendFile
- sendTemplate
- sendButtonTemplate
- sendGenericTemplate
- sendMediaTemplate
- sendReceiptTemplate
- sendAirlineBoardingPassTemplate
- sendAirlineCheckinTemplate
- sendAirlineItineraryTemplate
- sendAirlineUpdateTemplate
- sendOneTimeNotifReqTemplate

To send messages with quick replies to the specified user using the Send API, pass quickReplies option to send message methods, for example, with sendText:
`js`
await client.sendText(USER_ID, 'Pick a color:', {
quickReplies: [
{
contentType: 'text',
title: 'Red',
payload: 'DEVELOPER_DEFINED_PAYLOAD_FOR_PICKING_RED',
},
],
});
with the sendImage option:
`js`
await client.sendImage(USER_ID, 'https://example.com/vr.jpg', {
quickReplies: [
{
contentType: 'text',
title: 'Red',
payload: 'DEVELOPER_DEFINED_PAYLOAD_FOR_PICKING_RED',
},
],
});
It works with all of message sending methods.

- sendSenderAction
- markSeen
- typingOn
- typingOff
> Note: Only attachments that were uploaded with the isReusable property set to true can be sent to other message recipients.
- uploadAttachment
- uploadAudio
- uploadImage
- uploadVideo
- uploadFile
There are a bunch of factory methods can be used to create batch requests:
- MessengerBatch.sendRequestMessengerBatch.sendMessage
- MessengerBatch.sendText
- MessengerBatch.sendAttachment
- MessengerBatch.sendAudio
- MessengerBatch.sendImage
- MessengerBatch.sendVideo
- MessengerBatch.sendFile
- MessengerBatch.sendTemplate
- MessengerBatch.sendButtonTemplate
- MessengerBatch.sendGenericTemplate
- MessengerBatch.sendReceiptTemplate
- MessengerBatch.sendMediaTemplate
- MessengerBatch.sendAirlineBoardingPassTemplate
- MessengerBatch.sendAirlineCheckinTemplate
- MessengerBatch.sendAirlineItineraryTemplate
- MessengerBatch.sendAirlineUpdateTemplate
- MessengerBatch.sendSenderAction
- MessengerBatch.typingOn
- MessengerBatch.typingOff
- MessengerBatch.markSeen
- MessengerBatch.getUserProfile
- MessengerBatch.passThreadControl
- MessengerBatch.passThreadControlToPageInbox
- MessengerBatch.takeThreadControl
- MessengerBatch.requestThreadControl
- MessengerBatch.associateLabel
- MessengerBatch.dissociateLabel
- MessengerBatch.getAssociatedLabels
-
Those methods have exactly same argument signature with the methods on client.
- createLabel
- associateLabel
- dissociateLabel
- getAssociatedLabels
- getLabelDetails
- getLabelList
- deleteLabel
- getMessengerProfile
- setMessengerProfile
- deleteMessengerProfile

- getPersistentMenu
- setPersistentMenu
- deletePersistentMenu

- getGetStarted
- setGetStarted
- deleteGetStarted

- getGreeting
- setGreeting
- deleteGreeting
- getWhitelistedDomains
- setWhitelistedDomains
- deleteWhitelistedDomains
- getAccountLinkingURL
- setAccountLinkingURL
- deleteAccountLinkingURL
- passThreadControl
- passThreadControlToPageInbox
- takeThreadControl
- requestThreadControl
- getThreadOwner
- getSecondaryReceivers
Requirements for insights API:
- The page token must have read_insights permission.30
- Insights are only generated for a Facebook Page that has more than people that like it.
- getInsights
- getBlockedConversations
- getReportedConversations
- getTotalMessagingConnections
- getNewConversations
- setNLPConfigs
- enableNLP
- disableNLP
- getIdsForApps
- getIdsForPages
- createPersona
- getPersona
- getPersonas
- getAllPersonas
- deletePersona
- debugToken
- createSubscription
- getSubscriptions
- getPageSubscription
- getPageInfo
- getMessagingFeatureReview
To enable default request debugger, use following DEBUG env variable:
`sh`
DEBUG=messaging-api:request
If you want to use a custom request logging function, just provide your own onRequest:
`js`
const client = new MessengerClient({
accessToken: ACCESS_TOKEN,
onRequest: ({ method, url, headers, body }) => {
/ /
},
});
To avoid sending requests to real Messenger server, specify the origin option when constructing your client:
`js
const { MessengerClient } = require('messaging-api-messenger');
const client = new MessengerClient({
accessToken: ACCESS_TOKEN,
origin: 'https://mydummytestserver.com',
});
``
> Warning: Don't do this on your production server.
[send-api-reference#recipient]: https://developers.facebook.com/docs/messenger-platform/send-api-reference#recipient