Skip to content

Latest commit

 

History

History
118 lines (78 loc) · 7.28 KB

README.md

File metadata and controls

118 lines (78 loc) · 7.28 KB
Raw

Evolution Api

Whatsapp Group Discord Community Postman Collection Documentation License Support Sponsors

Evolution API

Evolution API began as a WhatsApp controller API based on CodeChat, which in turn implemented the Baileys library. While originally focused on WhatsApp, Evolution API has grown into a comprehensive platform supporting multiple messaging services and integrations. We continue to acknowledge CodeChat for laying the groundwork.

Today, Evolution API is not limited to WhatsApp. It integrates with various platforms such as Typebot, Chatwoot, Dify, and OpenAI, offering a broad array of functionalities beyond messaging. Evolution API supports both the Baileys-based WhatsApp API and the official WhatsApp Business API, with upcoming support for Instagram and Messenger.

Looking for a Lightweight Version?

For those who need a more streamlined and performance-optimized version, check out Evolution API Lite. It's designed specifically for microservices, focusing solely on connectivity without integrations or audio conversion features. Ideal for environments that prioritize simplicity and efficiency.

Types of Connections

Evolution API supports multiple types of connections to WhatsApp, enabling flexible and powerful integration options:

  • WhatsApp API - Baileys:

    • A free API based on WhatsApp Web, leveraging the Baileys library.
    • This connection type allows control over WhatsApp Web functionalities through a RESTful API, suitable for multi-service chats, service bots, and other WhatsApp-integrated systems.
    • Note: This method relies on the web version of WhatsApp and may have limitations compared to official APIs.

  • WhatsApp Cloud API:

    • The official API provided by Meta (formerly Facebook).
    • This connection type offers a robust and reliable solution designed for businesses needing higher volumes of messaging and better integration support.
    • The Cloud API supports features such as end-to-end encryption, advanced analytics, and more comprehensive customer service tools.
    • To use this API, you must comply with Meta's policies and potentially pay for usage based on message volume and other factors.

Integrations

Evolution API supports various integrations to enhance its functionality. Below is a list of available integrations and their uses:

  • Typebot:

    • Build conversational bots using Typebot, integrated directly into Evolution with trigger management.

  • Chatwoot:

    • Direct integration with Chatwoot for handling customer service for your business.

  • RabbitMQ:

    • Receive events from the Evolution API via RabbitMQ.

  • Amazon SQS:

    • Receive events from the Evolution API via Amazon SQS.

  • Socket.io:

    • Receive events from the Evolution API via WebSocket.

  • Dify:

    • Integrate your Evolution API directly with Dify AI for seamless trigger management and multiple agents.

  • OpenAI:

    • Integrate your Evolution API with OpenAI for AI capabilities, including audio-to-text conversion, available across all Evolution integrations.

  • Amazon S3 / Minio:

Telemetry Notice

To continuously improve our services, we have implemented telemetry that collects data on the routes used, the most accessed routes, and the version of the API in use. We would like to assure you that no sensitive or personal data is collected during this process. The telemetry helps us identify improvements and provide a better experience for users.

Evolution Support Premium

Join our Evolution Pro community for expert support and a weekly call to answer questions. Visit the link below to learn more and subscribe:

Click here to learn more

Donate to the project.

Github Sponsors

https://github.com/sponsors/EvolutionAPI

Content Creator Partners

We are proud to collaborate with the following content creators who have contributed valuable insights and tutorials about Evolution API:

License

Evolution API is licensed under the Apache License 2.0, with the following additional conditions:

  1. LOGO and copyright information: In the process of using Evolution API's frontend components, you may not remove or modify the LOGO or copyright information in the Evolution API console or applications. This restriction is inapplicable to uses of Evolution API that do not involve its frontend components.

  2. Usage Notification Requirement: If Evolution API is used as part of any project, including closed-source systems (e.g., proprietary software), the user is required to display a clear notification within the system that Evolution API is being utilized. This notification should be visible to system administrators and accessible from the system's documentation or settings page. Failure to comply with this requirement may result in the necessity for a commercial license, as determined by the producer.

Please contact [email protected] to inquire about licensing matters.

Apart from the specific conditions mentioned above, all other rights and restrictions follow the Apache License 2.0. Detailed information about the Apache License 2.0 can be found at http://www.apache.org/licenses/LICENSE-2.0.

© 2024 Evolution API