whatsapp-business

WhatsApp Business API SDK

Node.js connector for WhatsApp Business Cloud API, with TypeScript support.

This project offers a solution to easily interact with WhatsApp Business Cloud API with Heavy integration testing with real API calls to support implementation stability. Built with Axios and no other extra dependency!

The connector is fully typed, tested and documented!

Installation

npm install whatsapp-business

yarn add whatsapp-business

Documentation

Most methods accept JS objects. These can be populated using parameters specified by WhatsApp's API documentation or following the typescript schema.

Usage

Basic usage

import { WABAClient, WABAErrorAPI } from "whatsapp-business";

//You cant get it from the meta for developers app administration
const client = new WABAClient({
	accountId: "YOUR_ACCOUNT_ID",
	apiToken: "YOUR_API_TOKEN",
	phoneId: "YOUR_BUSINESS_PHONE_ID",
});

const foo = async () => {
	try {
		const res = await client.getBusinessPhoneNumbers();
		console.log(res);
	} catch (err) {
		const error: WABAErrorAPI = err;
		console.error(error.message);
	}
};

foo();

Sending a message

const sendTextMessage = async (body: string, to: string) => {
	try {
		const res = await client.sendMessage({ type: "text", text: { body }, to });
		console.log(res);
	} catch (err) {
		const error: WABAErrorAPI = err;
		console.error(error.message);
	}
};

Webhooks

import { WebhookClient, WABAClient } from "./index";

//The token and path must match the values you set on the application management
//More info here https://developers.facebook.com/docs/whatsapp/business-management-api/guides/set-up-webhooks
const webhookClient = new WebhookClient({
	token: "YOUR_VALIDATION_TOKEN",
	path: "/whatsapp/business",
});
const wabaClient = new WABAClient({
	accountId: "ACCOUNT_ID",
	phoneId: "PHONE_ID",
	apiToken: "API_TOKEN",
});

//init webhooks takes an object of functions that will be triggered based on the received webhook event type
webhookClient.initWebhook({
	onTextMessageReceived: async (payload, contact) => {
		try {
			await waba_client.markMessageAsRead(payload.id.toString());
			await waba_client.sendMessage({
				type: "text",
				to: contact.wa_id,
				text: { body: "Ok!" },
			});
		} catch (err) {
			console.log(err);
		}
	},
});

Support

Cloud API
- [x] Business profiles endpoints
- [x] Media endpoints
- [x] Message endpoints
- [x] Phone Numbers endpoints
- [x] Registration endpoints
- [x] Two-Step-Verification endpoints

Webhooks
- [x] Cloud API
- [] Business Management

Business Management API
Currently working on

Analytics API
Planning to add future support

Project

Structure

This project uses typescript. Resources are stored in 2 key structures:

• src: the whole connector written in typescript
• dist the packed bundle of the project for use in nodejs environments (generated when running yarn run build).
• __tests__ all the tests for the connector

Contribution and thanks

Contributions are encouraged, I will review any incoming pull requests.

Donations

If you found this project interesting or useful, you can give this project a star. Thank you!

Or buy me a coffee using any of these:

• BTC: 1MjRd2YNNjEx3ze1Y71UNSgbAF9XECKTP1
• ETH: 0xde25d72e9e87513b9c8dad8de11e2d8332276c7e
• USDC:0xde25d72e9e87513b9c8dad8de11e2d8332276c7e

Changelog

1.4.0 (2022-12-04)

Bug Fixes

• 🐛 undefined fields in webhookHandler (59ddcbb)

Features

• ✨ webhook client (27c3d1a)