WhatsApp Business API MCP Integration

WhatsApp Business API MCP Integration

site icon
2025.04.08 0
TypeScriptWhatsApp Business API企业通信消息管理交流协作
mcp-whatsapp-business-api 是一个基于 Node.js 的 Model Context Protocol (MCP) 服务器实现,为 MCP 客户端提供了与 WhatsApp Business API 交互的标准化接口。该服务主要用于企业通过 WhatsApp Business API 进行业务通信和管理。
View on GitHub

Overview

基本能力

产品定位

mcp-whatsapp-business-api 是一个用于与 WhatsApp Business API 交互的标准化接口服务,旨在帮助企业通过 WhatsApp 进行业务通信和管理。

核心功能

  1. 业务资料管理
  2. 获取业务资料信息
  3. 更新业务资料信息

  4. 注册管理

  5. 注册电话号码
  6. 注销电话号码
  7. 验证电话号码
  8. 检查注册状态

  9. 消息管理

  10. 发送文本消息
  11. 发送模板消息
  12. 发送媒体消息(图片、音频、文档、视频、贴纸)
  13. 标记消息为已读
  14. 列出消息模板

  15. 电话号码管理

  16. 获取所有电话号码
  17. 获取电话号码详情
  18. 请求验证码

  19. 两步验证

  20. 启用两步验证
  21. 禁用两步验证

适用场景

  1. 企业通过 WhatsApp 进行客户沟通
  2. 自动化消息发送(如营销、通知等)
  3. 业务资料和电话号码管理
  4. 安全验证(两步验证)

工具列表

  1. Node.js:运行环境
  2. npm/yarn:包管理工具
  3. WhatsApp Business API:核心通信接口

常见问题解答

  1. 如何获取 WhatsApp Business API 的访问令牌?
  2. 需要注册 WhatsApp Business 账户并申请 API 访问权限。

  3. 如何配置环境变量?

  4. .env 文件中配置 WHATSAPP_API_TOKENWHATSAPP_PHONE_NUMBER_ID 等变量。

使用教程

使用依赖

  1. Node.js (v16 或更高版本) bash node -v

  2. npm 或 yarn bash npm -v yarn -v

  3. WhatsApp Business 账户

  4. 需要注册 WhatsApp Business 账户并获取 API 访问权限。

安装教程

  1. 克隆仓库: bash git clone https://github.com/yourusername/mcp-whatsapp-business-api.git cd mcp-whatsapp-business-api

  2. 安装依赖: bash npm install

  3. 创建 .env 文件并配置环境变量: env PORT=3000 NODE_ENV=development WHATSAPP_API_URL=https://graph.facebook.com/v21.0 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 JWT_SECRET=your_jwt_secret_here

调试方式

  1. 启动开发服务器: bash npm run dev

  2. 构建应用: bash npm run build

  3. 运行测试: bash npm test

  4. 访问 API 文档:

  5. 服务器运行后,访问 http://localhost:3000/api-docs

许可证

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