whatsapp-mcp-server-i37

🚀 WhatsApp 多通道平台服务器

这是一个用于 WhatsApp 集成的多通道平台服务器，借助它，您能通过 REST API 轻松实现消息的发送与接收，为您的 WhatsApp 应用开发提供便利。

✨ 主要特性

• WhatsApp 连接管理及二维码认证
• 支持发送和接收文本消息
• 可发送媒体消息（如图片、文档等）
• 具备联系人管理功能
• 提供聊天记录功能
• 支持会话 persistence
• 拥有与其他应用程序集成的 REST API

📦 安装指南

先决条件

• Node.js (v14 或更高版本)
• MongoDB（可选但推荐用于消息存储）
• WhatsApp 账户

安装步骤

1. 克隆仓库：

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

2. 安装依赖项：

npm install

3. 从示例创建 .env 文件：

cp .env.example .env

4. 使用配置编辑 .env 文件

🚀 快速开始

运行服务器

开发环境

启动开发服务器：

npm run dev

生产环境

npm start

📚 详细文档

API 文档

认证

服务器使用 WhatsApp Web 的 QR 码进行认证。首次启动服务器时，控制台会显示一个 QR 码。使用您的 WhatsApp 手机应用程序扫描：

1. 在手机上打开 WhatsApp
2. 点击菜单或设置并选择 WhatsApp Web
3. 扫描控制台中显示的 QR 码

API 端点

认证路由

• GET /api/auth/status - 检查认证状态
• POST /api/auth/logout - 退出 WhatsApp
• POST /api/auth/restart - 重新启动 WhatsApp 客户端

消息路由

• POST /api/messages/send - 发送文本消息
• POST /api/messages/send-media - 发送媒体消息
• GET /api/messages/history/:contact - 获取与联系人的聊天记录

联系人路由

• GET /api/contacts - 获取所有联系人
• GET /api/contacts/:id - 通过 ID 获取联系人
• GET /api/contacts/chats - 获取所有对话

💻 使用示例

基础用法

发送消息

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

获取联系人

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

📄 许可证

此项目根据 MIT License 许可 - 有关详细信息，请参阅 LICENSE 文件。

致谢

• whatsapp-web.js - WhatsApp Web API
• Express - 网络框架
• Mongoose - MongoDB ODM