Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
jairls18-whatsapp-cloud-api
Advanced tools
Readme
whatsapp-cloud-api
is a Node.js library for creating bots and sending/receiving messages using the Whatsapp Cloud API.
Contains built-in Typescript declarations.
Using npm:
npm i whatsapp-cloud-api
Using yarn:
yarn add whatsapp-cloud-api
import { createBot } from 'whatsapp-cloud-api';
// or if using require:
// const { createBot } = require('whatsapp-cloud-api');
(async () => {
try {
// replace the values below
const from = 'YOUR_WHATSAPP_PHONE_NUMBER_ID';
const token = 'YOUR_TEMPORARY_OR_PERMANENT_ACCESS_TOKEN';
const to = 'PHONE_NUMBER_OF_RECIPIENT';
const webhookVerifyToken = 'YOUR_WEBHOOK_VERIFICATION_TOKEN';
// Create a bot that can send messages
const bot = createBot(from, token);
// Send text message
const result = await bot.sendText(to, 'Hello world');
// Start express server to listen for incoming messages
// NOTE: See below under `Documentation/Tutorial` to learn how
// you can verify the webhook URL and make the server publicly available
await bot.startExpressServer({
webhookVerifyToken,
});
// Listen to ALL incoming messages
// NOTE: remember to always run: await bot.startExpressServer() first
bot.on('message', async (msg) => {
console.log(msg);
if (msg.type === 'text') {
await bot.sendText(msg.from, 'Received your text message!');
} else if (msg.type === 'image') {
await bot.sendText(msg.from, 'Received your image!');
}
});
} catch (err) {
console.log(err);
}
})();
Sending other message types (read more in API reference):
// Send image
const result = await bot.sendImage(to, 'https://picsum.photos/200/300', {
caption: 'Random jpg',
});
// Send location
const result = await bot.sendLocation(to, 40.7128, -74.0060, {
name: 'New York',
});
// Send template
const result = await bot.sendTemplate(to, 'hello_world', 'en_us');
Customized express server (read more below):
import cors from 'cors';
// Create bot...
const bot = createBot(...);
// Customize server
await bot.startExpressServer({
webhookVerifyToken: 'my-verification-token',
port: 3000,
webhookPath: `/custom/webhook`,
useMiddleware: (app) => {
app.use(cors()),
},
});
Listening to other message types (read more in API reference):
const bot = createBot(...);
await bot.startExpressServer({ webhookVerifyToken });
// Listen to incoming text messages ONLY
bot.on('text', async (msg) => {
console.log(msg);
await bot.sendText(msg.from, 'Received your text!');
});
// Listen to incoming image messages ONLY
bot.on('image', async (msg) => {
console.log(msg);
await bot.sendText(msg.from, 'Received your image!');
});
By default, the endpoint for whatsapp-related requests will be: /webhook/whatsapp
.
This means that locally, your URL will be: http://localhost/webhook/whatsapp
.
You can use a reverse proxy to make the server publicly available. An example of this is ngrok.
You can read more on the Tutorial.
The implementation above creates an express server for you through which it listens to incoming messages. There may be plans to support other types of server in future (PRs are welcome! :)).
You can change the port as follows:
await bot.startExpressServer({
port: 3000,
});
By default, all requests are handled by the POST|GET /webhook/whatsapp
endpoint. You can change this as below:
await bot.startExpressServer({
webhookPath: `/custom/webhook`,
});
Note: Remember the leading /
; i.e. don't use custom/whatsapp
; instead use /custom/whatsapp
.
If you are already running an express server in your application, you can avoid creating a new one by using it as below:
// your code...
import express from 'express';
const app = express();
...
// use the `app` variable below:
await bot.startExpressServer({
app,
});
To add middleware:
import cors from 'cors';
await bot.startExpressServer({
useMiddleware: (app) => {
app.use(cors()),
},
});
Full customized setup:
import cors from 'cors';
await bot.startExpressServer({
webhookVerifyToken: 'my-verification-token',
port: 3000,
webhookPath: `/custom/webhook`,
useMiddleware: (app) => {
app.use(cors()),
},
});
on()
listenerThis library uses a single process pubsub, which means that it won't work well if you're deploying on multi-instance clusters, e.g. distributed Kubernetes clusters. In future, there may be plans to export/support a pubsub reference which can be stored in extenal storage, e.g. redis (PRs are welcome! :)).
# install npm modules
npm i
# eslint
npm run lint
# typescript check
npm run ts-check
# test
## Read 'Local Testing' below before running this
npm t
# build
npm run build
Create a .env file in the root of your project:
FROM_PHONE_NUMBER_ID=""
ACCESS_TOKEN=""
VERSION=""
TO=""
WEBHOOK_VERIFY_TOKEN=""
WEBHOOK_PATH=""
Library API inspired by node-telegram-bot-api.
Any and all PRs are open.
FAQs
Node.js library for creating bots and sending/receiving messages using the Whatsapp Cloud API
The npm package jairls18-whatsapp-cloud-api receives a total of 2 weekly downloads. As such, jairls18-whatsapp-cloud-api popularity was classified as not popular.
We found that jairls18-whatsapp-cloud-api demonstrated a healthy version release cadence and project activity because the last version was released less than 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
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.