Whatsapp MCP Server I37

🚀 WhatsApp Multi-Channel Platform Server

A multi-channel platform server for WhatsApp integration that allows you to send and receive messages via REST API.

🚀 Quick Start

This server enables seamless integration with WhatsApp, providing a range of features accessible through a REST API.

✨ Features

• WhatsApp connection management and QR code authentication
• Sending and receiving text messages
• Sending media messages (images, documents, etc.)
• Contact management
• Chat history
• Session persistence
• REST API for integration with other applications

📦 Installation

Prerequisites

• Node.js (v14 or higher)
• MongoDB (Optional but recommended for message storage)
• WhatsApp account

Steps

1. Clone the repository:

git clone https://github.com/krusleung/whatsapp-mcp-server.git
cd whatsapp-mcp-server

2. Install dependencies:

npm install

3. Create a .env file from the example:

cp .env.example .env

4. Edit the .env file with your configuration.

💻 Usage Examples

Starting the Server

• Start the development server:

npm run dev

• For production environment:

npm start

Sending a Message

curl -X POST http://localhost:3000/api/messages/send \
  -H "Content-Type: application/json" \
  -d '{"to": "1234567890", "message": "Hello from WhatsApp MCP Server!"}'

Getting Contacts

curl -X GET http://localhost:3000/api/contacts

📚 Documentation

Authentication

The server uses a QR code from WhatsApp Web for authentication. When starting the server for the first time, a QR code will be displayed in the console. Scan it using your WhatsApp mobile app:

1. Open WhatsApp on your phone.
2. Tap the menu or settings and select WhatsApp Web.
3. Scan the QR code shown in the console.

API Endpoints

Authentication Routes

• GET /api/auth/status - Check the authentication status.
• POST /api/auth/logout - Log out of WhatsApp.
• POST /api/auth/restart - Restart the WhatsApp client.

Message Routes

• POST /api/messages/send - Send a text message.
• POST /api/messages/send-media - Send a media message.
• GET /api/messages/history/:contact - Get the chat history with a contact.

Contact Routes

• GET /api/contacts - Get all contacts.
• GET /api/contacts/:id - Get a contact by ID.
• GET /api/contacts/chats - Get all conversations.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• whatsapp-web.js - WhatsApp Web API
• Express - Web framework
• Mongoose - MongoDB ODM