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. Built with Axios and no other extra dependency!

The connector is fully typed 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

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

const client = new WABAClient({
	accountId: "YOUR_ACCOUNT_ID",
	apiToken: "YOUR_API_TOKEN",
	//You cant get it from the meta for developers app administration
	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();

Webhooks

Although there is no current support for managing webhooks from the API, you can access the Webhooks response types

import { Webhook } from "whatsapp-business";

const webhookListener = (res: Webhook) => {};

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 browser environments.

Testing

I am currently working on test integration.

The idea is to make a heavy testing integration with real API calls to support implementation stability.

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.1.1 (2022-05-26)

Bug Fixes

• 🐛 endpoints and typos (fd9b9f0)