📱 Manager

Disconnected

⌛

Initializing WhatsApp...

Scan this code with your WhatsApp app
to link your device.

⭐ Latest Activity

No recent activity yet.

⚡ API Playground

Recipient Number (with country code) Message Content

📡 Live Webhook Events

Waiting for events...

🎯 Webhook Subscribers (Receiving)

Filter by Chat ID (e.g. 201xxx@c.us) Filter by Keyword Target Webhook URL

📚 API Documentation

Complete list of all available endpoints with descriptions

🌐 Base URL:

Loading...

All endpoints use this base URL. Examples are generated with your current session data.

✏️ Test data — edit and apply to all examples

Change these values then click Apply to update every endpoint example and test body on this page.

Test phone number

Test chat ID

Test message ID

Test webhook URL

🔐 Status & Authentication

GET /api/whatsapp/status

Get the current connection status of the WhatsApp client.

Returns status (READY, QR_RECEIVED, AUTHENTICATED, DISCONNECTED) and QR code if available.

POST /api/whatsapp/logout

Logout and disconnect the current WhatsApp session.

Clears the session data and requires QR scan to reconnect.

💬 Basic Messaging

POST /api/whatsapp/send

Send a text message to any WhatsApp number.

Body: { "to": "201234567890", "message": "Your text" } - Supports international numbers with country code.

Example Body (using current session data):

⚡ Advanced Messaging

POST /api/whatsapp/message/forward

Forward an existing message to another chat or contact.

Body: { "messageId": "...", "targetChatId": "..." } - Preserves original message content and media.

Requires: WhatsApp client must be connected (status READY or AUTHENTICATED). Check GET /api/whatsapp/status first.

GET /api/whatsapp/message/info?messageId=...

Get detailed information about a specific message.

Returns message metadata, delivery status, read receipts, and other details.

GET /api/whatsapp/latest-message

Get the most recent message across all chats (latest activity).

Returns the last message received or sent with chat information and timestamp.

📁 Chat Management

POST /api/whatsapp/chat/archive

Archive or unarchive a chat conversation.

Body: { "chatId": "...", "archive": true/false } - Moves chat to/from archived folder.

POST /api/whatsapp/chat/state

Set chat state indicators (typing, recording, or clear state).

Body: { "chatId": "...", "state": "typing|recording|clear" } - Shows/hides typing indicator to recipient.

📜 Message History

GET /api/whatsapp/messages/last?limit=10

Get the last N messages across all chats for dashboard or recent activity feed.

Returns messages sorted by timestamp (newest first) with chat information and message details.

GET /api/whatsapp/messages/chat?chatId=...&limit=50

Get messages from a specific chat or conversation thread.

Returns conversation history for customer support context or message thread display.

GET /api/whatsapp/messages/search?query=...&limit=50

Search messages by text content across all chats and conversations.

Useful for finding specific information, compliance searches, or full-text message lookup.

💼 Chat Management (Business)

GET /api/whatsapp/chats/active?hours=24

Get chats with recent activity within the last N hours for active conversations dashboard.

Returns chats sorted by last message time with unread counts and last message preview.

GET /api/whatsapp/chats/unread

Get all chats with unread messages for prioritization and support queue management.

Returns unread chat list with unread counts and total unread messages for notification systems.

GET /api/whatsapp/chats/archived

Get all archived chats for historical conversation access and organization.

Returns list of archived conversations sorted by timestamp for archive management tools.

👥 User & Contact Management

GET /api/whatsapp/users/active?hours=24

Get users who sent messages recently for engagement tracking and active user analytics.

Returns list of active contacts with last message time and unread counts for CRM integration.

GET /api/whatsapp/users/uncontacted?hours=24

Get users who sent messages but haven't received a reply (missed opportunities).

Critical for follow-up queue management, SLA tracking, and identifying customers needing response.

GET /api/whatsapp/contacts

Get all contacts in your WhatsApp for contact directory and CRM synchronization.

Returns complete contact list with names, numbers, and business status for contact management.

GET /api/whatsapp/contacts/blocked

Get all blocked contacts for security monitoring and access control management.

Returns list of blocked numbers for block list management and security auditing.

📈 Analytics & Statistics

GET /api/whatsapp/analytics/stats?days=7

Get comprehensive message statistics for business intelligence dashboard and KPI tracking.

Returns total incoming/outgoing messages, chat counts, unread totals, and daily breakdown for reporting.

🔗 Webhook Management

GET /api/whatsapp/webhook

Get the current webhook URL where all messages are being sent continuously.

Returns the active webhook URL configured via API, .env, or default fallback.

POST /api/whatsapp/webhook

Set the webhook URL via API - all messages will be POSTed to this URL automatically.

Body: { "url": "https://..." } - Saves URL and starts sending messages immediately without code changes.

DELETE /api/whatsapp/webhook

Clear the webhook URL set via API and fall back to .env or default configuration.

Removes the API-set webhook URL, allowing .env or default webhook to be used instead.

GET /api/whatsapp/webhook-info

Get complete webhook information including send message URL and subscription endpoints.

Returns base URL, send message endpoint, webhook configuration details, and subscriber count.

POST /api/whatsapp/webhook-subscribe

Subscribe an additional webhook URL to receive all messages (multiple endpoints support).

Body: { "url": "https://..." } - Adds URL to subscriber list, all messages sent to main webhook and all subscribers.

GET /api/whatsapp/webhook-subscribers

Get list of all subscribed webhook URLs that receive messages in addition to main webhook.

Returns array of subscriber entries with URLs and creation timestamps for webhook management.

DELETE /api/whatsapp/webhook-subscribers/:id

Remove a webhook subscriber by ID to stop sending messages to that endpoint.

Removes the specified subscriber from the list, messages will no longer be sent to that URL.

🎯 Trigger Management

GET /api/whatsapp/triggers

Get all configured message triggers that send webhooks when specific conditions are met.

Returns list of triggers with chat ID filters, keyword filters, and target webhook URLs.

POST /api/whatsapp/triggers

Create a new trigger that sends webhook when message matches chat ID and/or keyword filter.

Body: { "chatId": "...", "keyword": "...", "webhookUrl": "..." } - Leave filters empty to match all messages.

DELETE /api/whatsapp/triggers/:id

Delete a trigger by ID to stop webhook notifications for that specific filter condition.

Removes the trigger configuration, webhooks will no longer be sent for matching messages.

🧪 Testing

POST /api/whatsapp/webhook-test

Test webhook endpoint that logs received webhook data for debugging and testing purposes.

Use this URL as a webhook subscriber to see webhook payloads in server logs for development.