🚀 Bhoriwal WhatsApp SDK

A simple, powerful, and reusable SDK for the WhatsApp Cloud API.

Built for:

• Multi-project usage
• SaaS platforms
• Backend automation systems

✨ Features

• ✅ Send Text Messages
• ✅ Send Media (Image, Video, Document, Audio)
• ✅ Send Template Messages
• ✅ Interactive Button Messages
• ✅ WhatsApp Flows Support
• ✅ Bulk Messaging
• ✅ Phone Number Reachability Check
• ✅ Mark Messages as Read
• ✅ Block / Unblock Users
• ✅ Fetch Templates
• ✅ Analyze Template Structure (🔥 Smart Feature)
• ✅ One-time Configuration

📦 Installation

npm install bhoriwal-sdk

⚙️ Configuration (Recommended)

Configure once and use everywhere:

import Bhoriwal from "bhoriwal-sdk";

Bhoriwal.config({
  token: process.env.WA_ACCESS_TOKEN,
  phoneId: process.env.WA_PHONE_NUMBER_ID,
  wabaId: process.env.WA_BUSINESS_ACCOUNT_ID
});

🔐 Environment Variables

WA_PHONE_NUMBER_ID=xxxxxxxxxxxx
WA_ACCESS_TOKEN=EAAGxxxxxxxxxxxxxxxx
WA_BUSINESS_ACCOUNT_ID=xxxxxxxxxxxx

💬 Send Text Message

await Bhoriwal.sendText({
  to: "919999999999",
  message: "Hello from Bhoriwal 🚀"
});

📌 Works only within 24-hour customer window.

🖼️ Send Media Message

await Bhoriwal.sendMedia({
  to: "919999999999",
  type: "image", // image | video | document | audio
  link: "https://example.com/image.jpg",
  caption: "Check this out 👀"
});

🧾 Send Template Message

await Bhoriwal.sendTemplate({
  to: "919999999999",
  name: "order_update",
  components: [
    {
      type: "body",
      parameters: [
        { type: "text", text: "John" },
        { type: "text", text: "ORD123" }
      ]
    }
  ]
});

📌 Templates must be approved in Meta.

🔍 Fetch & Analyze Templates (🔥 Powerful Feature)

1️⃣ Get All Templates

const templates = await Bhoriwal.getTemplates();

2️⃣ Find Template

const template = templates.find(t => t.name === "order_update");

3️⃣ Analyze Template Structure

const info = Bhoriwal.analyzeTemplate(template);

console.log(info);

✅ Example Output

{
  name: "order_update",
  bodyParams: [
    { index: 1, type: "text" },
    { index: 2, type: "text" }
  ],
  header: {
    type: "image"
  },
  buttons: [
    { buttonIndex: 0, type: "dynamic_url" }
  ]
}

💡 What This Means

• Body requires 2 text parameters
• Header requires an image
• Button needs dynamic value

👉 No more guessing template structure 🎯

🔘 Send Button Message (Interactive)

await Bhoriwal.sendMessageFlow({
  to: "919999999999",
  message: "Hello 👋 Please choose an option:",
  buttons: [
    { id: "order", title: "Order" },
    { id: "contact", title: "Contact" },
    { id: "other", title: "Other" }
  ]
});

📌 Button Rules

• Maximum 3 buttons
• Title max 20 characters
• ID max 256 characters

🔄 Send WhatsApp Flow

await Bhoriwal.sendFlow({
  to: "919999999999",
  flowId: "123456",
  flowToken: "abc123",
  flowData: {
    name: "John"
  }
});

📤 Bulk Messaging

await Bhoriwal.bulkSend(
  [
    { to: "919111111111", message: "Hello 1" },
    { to: "919222222222", message: "Hello 2" }
  ],
  Bhoriwal.sendText
);

☎️ Check Phone Number

await Bhoriwal.checkPhoneNumber({
  to: "919999999999"
});

📌 Uses safe verification method (no official API available).

👁️ Mark Message as Read

await Bhoriwal.markAsRead({
  messageId: "wamid.HBg..."
});

🚫 Block / Unblock User

Block

await Bhoriwal.blockUser({
  to: "919999999999"
});

Unblock

await Bhoriwal.unblockUser({
  to: "919999999999"
});

⚠️ Important Notes

• Template messages are required outside the 24-hour window
• Some features (Flows, Blocking) require Meta approval
• Phone check is a workaround, not official API

🧠 Best Practices

• Use templates for notifications
• Analyze templates before sending
• Cache templates for performance
• Validate inputs before sending
• Use bulk messaging carefully (rate limits)

📄 License

MIT

❤️ Support

If you like this project, consider starring ⭐ and sharing it.