WhatsApp MCP Server

WhatsApp MCP Server

site icon
2025.04.08 1
JavaScriptWhatsApp 集成消息自动化REST API交流协作
WhatsApp MCP Server 是一个多通道平台服务器,用于 WhatsApp 集成,允许通过 REST API 以编程方式发送和接收消息。
View on GitHub

Overview

基本能力

产品定位

WhatsApp MCP Server 是一个用于 WhatsApp 集成的多通道平台服务器,提供 REST API 接口,方便开发者以编程方式发送和接收消息。

核心功能

  • WhatsApp 连接管理(通过二维码认证)
  • 发送和接收文本消息
  • 发送媒体消息(图片、文档等)
  • 联系人管理
  • 聊天历史记录
  • 会话持久化
  • 提供 REST API 与其他应用程序集成

适用场景

  • 企业客户服务自动化
  • 社交媒体营销
  • 个人自动化消息处理
  • 多平台消息集成

工具列表

  • whatsapp-web.js: WhatsApp Web API,用于与 WhatsApp 通信
  • Express: Web 框架,用于构建 REST API
  • Mongoose: MongoDB ODM,用于数据存储

常见问题解答

  1. 如何认证? 启动服务器后,控制台会显示二维码,使用 WhatsApp 手机应用扫描即可。
  2. 如何发送消息? 使用 /api/messages/send 端点发送文本消息。
  3. 如何获取联系人? 使用 /api/contacts 端点获取所有联系人。

使用教程

使用依赖

  • Node.js (v14 或更高版本)
  • MongoDB (可选,但建议用于消息存储)
  • WhatsApp 账户

安装教程

  1. 克隆仓库:
git clone https://github.com/krusleung/whatsapp-mcp-server.git
cd whatsapp-mcp-server
  1. 安装依赖:
npm install
  1. 创建 .env 文件:
cp .env.example .env
  1. 编辑 .env 文件配置

运行服务器

开发模式:

npm run dev

生产模式:

npm start

调试方式

  1. 启动服务器后,检查控制台是否显示二维码。
  2. 使用 API 端点测试消息发送和接收功能。
  3. 检查 MongoDB 数据库(如果使用)以确保消息存储正常。

许可证

该项目遵循 MIT 开源许可条款。