Whatsapp-MCP-Server

🚀 WhatsApp商业API MCP服务器

本项目提供了一个用于WhatsApp商业API的MCP服务器，可实现消息发送、模板管理、媒体文件管理等功能，为使用WhatsApp商业API的开发者提供了便捷的服务。

🚀 快速开始

先决条件

• Node.js 16或更高版本
• WhatsApp商业API凭证：
  • API令牌
  • 手机号码ID
  • 商业账户ID

安装

npm install whatsapp-business-mcp-server

或者直接运行：

npx whatsapp-business-mcp-server

配置

创建一个.env文件，包含你的WhatsApp商业API凭证：

WHATSAPP_API_TOKEN=your_api_token_here
WHATSAPP_PHONE_NUMBER_ID=your_phone_number_id_here
WHATSAPP_BUSINESS_ACCOUNT_ID=your_business_account_id_here
WHATSAPP_API_VERSION=v18.0

启动服务器

npm start

开发模式

npm run dev

与MCP Inspector一起使用

npm run inspect

✨ 主要特性

• 发送各种类型的消息（文本、模板、媒体、互动型）
• 管理消息模板
• 上传和管理媒体文件
• 更新业务资料信息
• 管理电话号码
• 配置Webhooks

💻 使用示例

基础用法

以下是启动服务器的基础命令：

npm start

高级用法

在开发模式下运行服务器：

npm run dev

📚 详细文档

可用工具

消息发送

• sendTextMessage - 发送一条文本消息
• sendTemplateMessage - 发送一个模板消息
• sendImageMessage - 发送一张图片
• sendDocumentMessage - 发送一个文档
• sendVideoMessage - 发送一段视频
• sendLocationMessage - 发送一个位置
• sendContactMessage - 发送联系信息
• sendInteractiveMessage - 发送互动型消息
• markMessageAsRead - 将消息标记为已读

媒体管理

• uploadMedia - 上传媒体文件到WhatsApp服务器
• getMediaUrl - 获取媒体文件的URL
• deleteMedia - 删除媒体文件

模板管理

• getMessageTemplates - 获取所有消息模板
• createMessageTemplate - 创建一个新的消息模板

业务资料

• getBusinessProfile - 获取业务资料信息
• updateBusinessProfile - 更新业务资料

电话号码管理

• getPhoneNumbers - 获取所有的电话号码
• getPhoneNumberById - 获取某个电话号码的详细信息
• requestVerificationCode - 请求验证代码
• verifyCode - 验证一个电话号码

Webhooks配置

• getWebhookInfo - 获取Webhook的信息
• subscribeWebhook - 订阅Webhooks通知
• deleteWebhookSubscription - 删除Webhooks订阅

可用资源

• whatsapp://templates - 列出所有的模板
• whatsapp://templates/{category} - 按分类列出模板
• whatsapp://template/{name} - 获取某个模板的详细信息
• whatsapp://business-profile - 查看业务资料
• whatsapp://phone-numbers - 列出所有的电话号码
• whatsapp://phone-number/{id} - 获取某个电话号码的详细信息
• whatsapp://docs - API文档

📄 许可证

本项目采用MIT许可证。