Package Health Score

51 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.1.0	\|	10/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.6	\|	09/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.7.18	\|	04/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.8.5	\|	04/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.6.15	\|	02/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (5,345)

GitHub Stars: 1.91K
Forks: 203
Contributors: 30

Direct Usage Popularity

The npm package messaging-api-messenger receives a total of 5,345 downloads a week. As such, we scored messaging-api-messenger popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package messaging-api-messenger, we found that it has been starred 1,911 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 30
Funding: No

With more than 10 contributors for the messaging-api-messenger repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 10
Open PR: 4
Last Release: 3 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of messaging-api-messenger based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for messaging-api-messenger is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=10

Age: 8 years
Dependencies: 11 Direct
Versions: 113
Install Size: 726 kB
Dist-tags: 2
# of Files: 46
Maintainers: 5
TS Typings: Yes

messaging-api-messenger has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use messaging-api-messenger?

To help you get started, we've collected the most common ways that messaging-api-messenger is being used within popular public projects.

Yoctol / bottender / packages / bottender / src / context / __tests__ / MessengerContext.spec.ts View on Github

beforeEach(() => {
  /* eslint-disable global-require */
  MessengerClient = require('messaging-api-messenger').MessengerClient;
  MessengerContext = require('../MessengerContext').default;
  MessengerEvent = require('../MessengerEvent').default;
  warning = require('warning');
  /* eslint-enable global-require */
});

View more ways to use messaging-api-messenger

messaging-api-messenger

> Messaging API client for Messenger

Installation

npm i --save messaging-api-messenger

yarn add messaging-api-messenger

Usage

Initialize

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) =&gt; {
  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

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',
      payload: 'DEVELOPER_DEFINED_PAYLOAD_FOR_PICKING_RED',
    },
  ],
});

with the sendImage option:

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.

Sender Actions - Official Docs

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

sendBatch

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

getUserProfile

Messenger Profile API - Official Docs

Persistent Menu - Official Docs

Get Started Button - Official Docs

Greeting Text - Officail docs

Whitelisted Domains - Official Docs

Account Linking URL - Official Docs

Handover Protocol API

Page Messaging Insights API - Official Docs

Requirements for insights API:

The page token must have read_insights permission.
Insights are only generated for a Facebook Page that has more than 30 people that like it.
getInsights
getBlockedConversations
getReportedConversations
getTotalMessagingConnections
getNewConversations

Built-in NLP API - Official Docs

Event Logging API - Official Docs

logCustomEvents

ID Matching API - Official Docs

Persona API - Official Docs

Others

Debug Tips

Log Requests Details

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

DEBUG=messaging-api:request

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 }) =&gt; {
    /* */
  },
});

Testing

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: 'https://mydummytestserver.com',
});

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

messaging-api-messenger dependencies

@types/append-query @types/lodash @types/warning append-query axios axios-error form-data lodash messaging-api-common ts-invariant warning

FAQs

What is messaging-api-messenger?

Messaging API client for Messenger. Visit Snyk Advisor to see a full health score report for messaging-api-messenger, including popularity, security, maintenance & community analysis.

Is messaging-api-messenger popular?

The npm package messaging-api-messenger receives a total of 5,345 weekly downloads. As such, messaging-api-messenger popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is messaging-api-messenger well maintained?

We found indications that messaging-api-messenger is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is messaging-api-messenger safe to use?

While scanning the latest version of messaging-api-messenger, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 16 November-2024, at 13:25 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP