Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
whatsapp-business-api
Advanced tools
A Wrapper for Whatsapp Business Cloud API hosted by Meta.
Weekly downloads
Readme
A Wrapper for Whatsapp Business Cloud API hosted by Meta.
Official API Documentation: Meta for Developers
Note: This package is WIP. The capabilities of Cloud API will be reflected soon. Feel free to contribute!
npm install --save whatsapp-business-api
import WhatsappAPI from "whatsapp-business-api";
const wp = new WhatsappAPI({
accountPhoneNumberId: "<phone-number-id>", // required
accessToken: "<access-token>", // required
})
await wp.sendTextMessage("<phone-number-to-send>", "<plain-message>");
To receive messages from Whatsapp Business, you need to serve an endpoint with GET and POST methods. GET will be used to verify the endpoint and POST will be used to receive changes on API (in this case the incoming messages).
After setting up the webhook endpoint using this package, you need to configure the webhook on Meta Developers Platform.
By default, library will create a new Express Application to setup webhook. If you want to use your own Express Application you can pass it with webhook options using
expressApp
key.
import WhatsappAPI from "whatsapp-business-api";
const wp = new WhatsappAPI({
accountPhoneNumberId: "<phone-number-id>", // required
accessToken: "<access-token>", // required
webhook: {
fbAppSecret: "<facebook-app-secret>", // required to setup Webhook
port: 1234, // default: 1337
verifyToken: "<verify-token>",
},
})
const echoMessage = async (message: IncomingMessage) => {
await wp.sendTextMessage(message.from, message.text.body);
}
wp.initWebhook(echoMessage);
sendTextMessage(
to: string, // Phone number to send message.
options: {
message: string, // Message body to send.
preview_url?: boolean, // Whether urls in body should have preview. Default: true
},
)
Supported media types can be found in src/contants.ts
.
sendMediaMessage(
to: string, // Phone number to send message.
options: {
external_link?: string, // Globally accesible link of media.
local_path?: string, // Full local path of the media file to upload and send.
caption?: string, // Caption of the media.
filename?: string, // Name of the file to show as preview. It is only applicable for sending documents.
}
)
FAQs
A Wrapper for Whatsapp Business Cloud API hosted by Meta.
The npm package whatsapp-business-api receives a total of 73 weekly downloads. As such, whatsapp-business-api popularity was classified as not popular.
We found that whatsapp-business-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers 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
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.