shobhit-whatsapp-api
v1.0.0
Published
Unified WhatsApp API for Twilio, Gupshup and Wasender
Maintainers
Readme
shobhit-whatsapp-api
A simple and unified WhatsApp messaging SDK for Node.js.
This package supports multiple WhatsApp providers and automatically detects which provider to use based on the configuration.
Currently supported:
- ✅ Wasender
- ✅ Gupshup
📦 Installation
npm install shobhit-whatsapp-api
-----------------------------------------------------------------------
🟢 Using TWILIO
🔑 Required Keys --- accountSid, authToken
from (WhatsApp-enabled Twilio number)
📌 Example Configuration
Code Structure
import { createWhatsAppClient } from "shobhit-whatsapp-api";
const client = createWhatsAppClient({
TWILIO: {
accountSid: "ACxxxxxxxxxxxxxxxx",
authToken: "your_auth_token",
from: "whatsapp:+14155238886",
},
});
📤 Send Message
await client.sendMessage({
to: "whatsapp:+919777777777",
message: "Hello from Twilio",
});
-----------------------------------------------------------------------
🟢 WASENDER USAGE
Wasender requires only one API key.
🔑 Required Keys (Wasender) ---- apiKey
Code Structure
import { createWhatsAppClient } from "shobhit-whatsapp-api";
const client = createWhatsAppClient({
WASENDER: {
apiKey: process.env.WASENDER_API_KEY,
},
});
await client.sendMessage({
to: "919999999999",
message: "Hello WhatsApp using Wasender",
});
-----------------------------------------------------------------------
🟢 GUPSHUP USAGE
Gupshup requires four keys.
🔑 Required Keys (Gupshup) ----- apiKey, appName, sourceNumber, templateId
import { createWhatsAppClient } from "shobhit-whatsapp-api";
const client = createWhatsAppClient({
GUPSHUP: {
apiKey: process.env.GUPSHUP_API_KEY,
appName: process.env.GUPSHUP_APP_NAME,
sourceNumber: process.env.GUPSHUP_SOURCE_NUMBER,
templateId: process.env.GUPSHUP_TEMPLATE_ID,
},
});
await client.sendMessage({
to: "919888888888",
message: "Hello WhatsApp using Gupshup",
});
-----------------------------------------------------------------------
❌ Common Errors
Missing Keys ----- GUPSHUP missing keys: apiKey, templateId
No Provider Found ---- No valid provider config found. Use WASENDER or GUPSHUP.
-----------------------------------------------------------------------
🧪 Example .env File
WASENDER_API_KEY=your_wasender_key
GUPSHUP_API_KEY=your_gupshup_key
GUPSHUP_APP_NAME=your_app_name
GUPSHUP_SOURCE_NUMBER=919999999999
GUPSHUP_TEMPLATE_ID=123456