💬 WhatsApp API — Session Connection & Management

Seamlessly integrate your WhatsApp Business accounts with your applications and automated workflows using the Baileys REST Mongo API.
This API enables you to programmatically connect, manage, and automate WhatsApp sessions with webhook updates and message control.

https://yourdomain.com/api/sessions

🚀 1. Create a WhatsApp Session (Login / Connect)

Endpoint:

POST https://yourdomain.com/api/sessions/start/:whatsapp_number

Purpose:
Create a new WhatsApp Web session for the given number.
This will generate a QR code to scan with your WhatsApp app and establish a secure session.

🔸 Request Type

POST

🔸 Required Fields in Request

Example

Use this API to programmatically create a new WhatsApp client connection. The webhook URL will receive status updates about the connection process.

$curl -X POST https://yourdomain.com/api/sessions/start/919876543210 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "client_id": 12345,
  "api_key": "YOUR_API_KEY",
  "webhook_url": "https://yourapp.com/webhook"
}'

🧑‍💻 Example (Node.js using Axios)

const axios = require("axios");

async function connectWhatsApp() {

try {

const response = await axios.post(

"https://yourdomain.com/api/sessions/start/919876543210",

{

client_id: 12345,

api_key: "YOUR_API_KEY",

webhook_url: "https://yourapp.com/webhook"

},

{

headers: { Authorization: "Bearer YOUR_API_KEY" }

}

);

console.log("✅ Session Response:", response.data);

} catch (error) {

console.error("❌ Error:", error.response?.data || error.message);

}

}

connectWhatsApp();

🧩 Fields in Response

🟢 Example Successful Response

{
  "status": 1,
  "message": "Scan the QR code to connect your WhatsApp account",
  "qr": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "whatsapp_client_id": "session-919876543210",
  "number": "919876543210"

🔴 Example Error Response

{
  "status": 0,
  "message": "Invalid API key or missing parameters"
}

✅ Connection Successful

{
  "event": "connected",
  "sessionId": "session-919876543210",
  "number": "919876543210",
  "status": "connected"
}

🔒 4. Logout / Disconnect Session

Endpoint:

DELETE https://yourdomain.com/api/sessions/session-919876543210

Description:
Terminates the active WhatsApp Web session.
Removes session from memory and deletes authentication files.

Response:

{
  "success": true,
  "message": "Session disconnected successfully"
}

---

🧭 5. Check Session Status

Endpoint:

GET https://yourdomain.com/api/whatsapp/:sessionId/status

Response Example:

{
  "sessionId": "session-919876543210",
  "status": "connected",
  "number": "919876543210"
}

⚙️ Technical Notes

• Multi-session ready: Each WhatsApp number has its own session stored under /auth/{sessionId}.

• Auto reconnect: Sessions reconnect automatically using Baileys’ stored credentials.

• Webhooks: Triggered for all important events — connection, disconnection, message receive, and errors.

• Database-backed: Sessions and messages are persisted in MongoDB for analytics and dashboards.

  💡 Tip

  To refresh the session, simply DELETE the existing one and re-initiate the /start/:number request.
  This will generate a new QR for re-login.