SuperAPI AI 工具集

evolution-api

办公与效率

查看项目

更新于 10-15 08:48

技能介绍

用途

Evolution API 是一个开源的 WhatsApp 集成平台,用于构建 WhatsApp 集成、聊天机器人和多渠道消息自动化。它提供 RESTful API 进行 WhatsApp 消息收发,支持 Baileys(免费)和官方 WhatsApp Business API 两种接入方式,可用于将 WhatsApp 与业务应用、CRM 系统对接,搭建多渠道客服平台,以及构建 AI 驱动的对话应用。

主要能力

消息能力:发送和接收 WhatsApp 消息,支持图片、视频、音频、文档等媒体,支持群组管理与操作、联系人管理、消息历史与搜索、已读回执与状态更新。

集成生态:可对接 Typebot(可视化聊天机器人构建器)、Chatwoot(客服平台)、Dify(AI 智能体管理)、OpenAI(AI 回复与音频转写)、Flowise(低代码 AI 工作流构建器)、N8N(工作流自动化)。

技术特性:提供覆盖多端点的 RESTful API、用于实时事件的 Webhook 系统、用于实时更新的 WebSocket 支持、消息队列集成(RabbitMQ、Kafka、SQS)、数据库持久化(PostgreSQL、MySQL)、Redis 缓存、S3/MinIO 媒体存储,并支持 Docker 部署。

使用方式

安装前置条件:Node.js 18+ 或 Docker;数据库(可选但推荐)PostgreSQL 12+ 或 MySQL 8+;Redis(可选,用于缓存)Redis 6+。

安装方式一(推荐)Docker:

git clone https://github.com/EvolutionAPI/evolution-api.git
cd evolution-api
cp .env.example .env
nano .env
docker-compose up -d
docker-compose logs -f evolution-api

安装方式二 NVM:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
source ~/.bashrc
nvm install 18
nvm use 18
git clone https://github.com/EvolutionAPI/evolution-api.git
cd evolution-api
npm install
cp .env.example .env
nano .env
npm run build
npm run start:prod

安装方式三 PM2:

npm install -g pm2
pm2 start dist/src/main.js --name evolution-api
pm2 save
pm2 startup

快速开始流程:创建实例(POST /instance/create,返回二维码)→ 用手机 WhatsApp 扫描二维码连接(设置 > 已关联的设备 > 关联设备)→ 检查连接状态(GET /instance/connectionState/{instanceName})→ 发送消息(POST /message/sendText/{instanceName})。

配置方面,通过环境变量设置服务器、认证(AUTHENTICATION_API_KEY)、数据库、Redis 缓存、CORS、日志、实例管理、语言,以及 WhatsApp 会话、二维码、官方 Business API 参数;Webhook 可全局或按事件配置;集成项(Typebot、Chatwoot、OpenAI、Dify、RabbitMQ、SQS、S3/MinIO、WebSocket)均有对应开关与参数。

API 端点涵盖实例管理(创建、列表、状态、重启、登出、删除)、消息发送(文本、媒体、音频、文档、位置、联系人、列表、按钮)、群组操作(创建、更新图片、增删成员、退群)、联系人与资料(头像、联系人、名称、状态、头像更新)、Webhook 设置与查询,以及 Typebot、Chatwoot、OpenAI、Dify 的集成设置。

Webhook 处理:平台会推送包含 event、instance、data 等字段的 JSON 负载,示例事件为 messages.upsert,可在 Node.js 等后端按事件类型分发处理。

适用场景

构建 WhatsApp 集成与聊天机器人;创建自动化消息系统;将 WhatsApp 与业务应用集成;搭建多渠道客服平台;使用 Typebot、Chatwoot 或 Dify 实现聊天机器人流程;将 WhatsApp 连接至 CRM 系统;构建 AI 驱动的对话应用;设置基于 Webhook 的消息处理;实现事件驱动的消息架构;管理 WhatsApp Business API 连接;集成 OpenAI 实现智能回复;使用 RabbitMQ、Kafka 或 SQS 设置消息队列;将媒体文件存储到 S3 或 MinIO;Evolution API 配置与部署相关问题;排查 WhatsApp 连接问题。

限制

资料未提供具体的收费、价格、平台兼容性细节、性能指标或效果承诺。官方 WhatsApp Business API 与 Baileys 的差异、各集成平台的具体版本要求等,资料中仅部分提及,其余暂未提供。