WhatsApp MCP 服务器

一个用于 WhatsApp 集成的多渠道平台服务器，允许您通过 REST API 以编程方式发送和接收消息。

功能

• 通过二维码认证进行 WhatsApp 连接管理
• 发送和接收文本消息
• 发送媒体消息（图像、文档等）
• 联系人管理
• 聊天记录
• 会话持久化
• 用于与其他应用程序集成的 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 的二维码进行身份验证。 首次启动服务器时，二维码将显示在控制台中。 使用您的 WhatsApp 移动应用程序扫描此二维码：

1. 在您的手机上打开 WhatsApp
2. 点击菜单或设置，然后选择 WhatsApp Web
3. 扫描终端中显示的二维码

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 文件。

鸣谢

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