TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published


    Messaging API client for Messenger


    Table of Contents


    npm i --save messaging-api-messenger


    yarn add messaging-api-messenger



    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.

    Verifying Graph API Calls with appsecret_proof

    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:

    const client = new MessengerClient({
      accessToken: ACCESS_TOKEN,
      appId: APP_ID,
      appSecret: APP_SECRET,
      skipAppSecretProof: true,

    Error Handling

    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.

    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

    API Reference

    All methods return a Promise.

    Send API - Official Docs

    Content Types - Content types

    Templates - Official Docs

    Quick Replies - Official Docs

    Quick Replies

    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:

    await client.sendText(USER_ID, 'Pick a color:', {
      quickReplies: [
          contentType: 'text',
          title: 'Red',

    with the sendImage option:

    await client.sendImage(USER_ID, '', {
      quickReplies: [
          contentType: 'text',
          title: 'Red',

    It works with all of message sending methods.

    Sender Actions - Official Docs

    Sender Actions

    Attachment Upload API - Official Docs

    Note: Only attachments that were uploaded with the isReusable property set to true can be sent to other message recipients.

    Message Batching - Official Docs

    There are a bunch of factory methods can be used to create batch requests:

    • MessengerBatch.sendRequest
    • MessengerBatch.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.

    Custom Labels - Official Docs

    User Profile API - Official Docs

    Messenger Profile API - Official Docs

    Persistent Menu - Official Docs

    Get Started Button - Official Docs

    Get Started Button

    Greeting Text - Officail docs

    Greeting Text

    Whitelisted Domains - Official Docs

    Account Linking URL - Official Docs

    Handover Protocol API

    Page Messaging Insights API - Official Docs

    Requirements for insights API:

    Built-in NLP API - Official Docs

    Event Logging API - Official Docs

    ID Matching API - Official Docs

    Persona API - Official Docs


    Debug Tips

    Log Requests Details

    To enable default request debugger, use following DEBUG env variable:


    If you want to use a custom request logging function, just provide your own onRequest:

    const client = new MessengerClient({
      accessToken: ACCESS_TOKEN,
      onRequest: ({ method, url, headers, body }) => {
        /* */


    Point Requests to Your Dummy Server

    To avoid sending requests to real Messenger server, specify the origin option when constructing your client:

    const { MessengerClient } = require('messaging-api-messenger');
    const client = new MessengerClient({
      accessToken: ACCESS_TOKEN,
      origin: '',

    Warning: Don't do this on your production server.


    npm i messaging-api-messenger

    DownloadsWeekly Downloads






    Unpacked Size

    726 kB

    Total Files


    Last publish


    • chentsulin
    • etrexkuo
    • tw0517tw
    • link515
    • kpman