WhatsApp Business API Wrapper (Unofficial)

Disclaimer: This library is an unofficial third-party wrapper for the WhatsApp Business Cloud API. It is not endorsed, sponsored, affiliated with, or provided by Meta Platforms, Inc. or WhatsApp LLC. "WhatsApp" is a registered trademark of WhatsApp LLC.

A complete, typed Node.js wrapper for the WhatsApp Business API, supporting Messaging, Media, Templates, Analytics, Webhooks, Flows, E-Commerce, QR Codes, and BSP/Partner Features.

Installation

npm install @techliftdigital/whatsapp-business
# or
pnpm add @techliftdigital/whatsapp-business

Usage

Initialization

import { WhatsAppBusiness } from '@techliftdigital/whatsapp-business';

const whatsapp = new WhatsAppBusiness({
  accessToken: 'YOUR_ACCESS_TOKEN',
  senderPhoneNumberId: 'YOUR_PHONE_NUMBER_ID',
});

Messaging & E-Commerce

Text & Templates

await whatsapp.sendText('1234567890', 'Hello!');

E-Commerce & Catalogs

// 1. Send Product Catalog
await whatsapp.sendCatalog('1234567890', 'Check out our 2024 collection', 'THUMBNAIL_PRODUCT_ID');

// 2. Send Request for Address
await whatsapp.sendRequestAddress('1234567890', 'Please provide your shipping address');

// 3. Send Order Details (Review & Pay)
await whatsapp.sendOrderDetails('1234567890', {
    header: { type: 'image', image: { link: 'https://ex.com/invoice_banner.jpg'} },
    body: { text: 'Your order is ready!' },
    action: {
        name: 'review_and_pay',
        parameters: {
            reference_id: 'ORDER_123',
            type: 'physical-goods',
            payment_settings: {
                type: 'payment_gateway',
                payment_gateway: {
                    type: 'razorpay',
                    configuration_name: 'MyShop',
                    bill_id: 'BILL_001'
                }
            },
            currency: 'INR',
            total_amount: { value: 10000, offset: 100 }, // 100.00
            order: {
                status: 'pending',
                items: [ { retailer_id: 'P01', name: 'Shirt', amount: { value: 5000, offset: 100 }, quantity: 2 } ],
                subtotal: { value: 10000, offset: 100 }
            }
        }
    }
});

Management Features

QR Codes & Flows

// Create QR
const qr = await whatsapp.createQRCode('PHONE_ID', 'Start Chat');

// Create Flow
const flow = await whatsapp.createFlow('WABA_ID', 'Survey', ['SURVEY']);

BSP / Partner Features

// Allocate Credit
await whatsapp.allocateCredit('CREDIT_LINE_ID', { waba_id: 'WABA_ID', amount: '100', currency: 'USD' });

// Request Green Tick
await whatsapp.requestOfficialBusinessAccount('PHONE_ID', { phone_number_id: 'PHONE_ID', website_url1: 'https://brand.com' });

Features List

• Messaging: Text, Templates, Media, Location, Interactive (Buttons, Lists).
• E-Commerce:
  • Catalogs: Send single product, multi-product list, full catalog.
  • Orders: Request Address, Order Details (Review & Pay), Order Status.
• Management: Flows, QR Codes, Templates (Create, Edit, Search), Analytics, Business Profile, Ice Breakers, Commands.
• BSP: Credit Lines, OBA Requests (Green Tick), Embedded Signup Support.

Legal & Compliance

By using this software, you agree to:

1. Meta's Terms: Comply with the WhatsApp Business Terms of Service and Meta Platform Terms.
2. Opt-in Policy: Only send messages to users who have explicitly opted in to receive them.
3. Prohibited Content: Adhere to the WhatsApp Commerce Policy.

This library facilitates interaction with the Cloud API but cannot prevent misuse. The implementer is solely responsible for compliance.

License

ISC