WhatsMiau

WhatsMiau is a backend service for WhatsApp, built with Go. It uses the Whatsmeow library to connect to WhatsApp and provides an HTTP API to send and receive messages.

Community Whatsapp (BR)

This project provides a robust, scalable, and production-ready solution for integrating WhatsApp functionalities into your applications. It is extremely lightweight, consuming very little memory, making it ideal for resource-constrained environments.

It's designed to be compatible with the Evolution API, making it a flexible choice for developers familiar with that ecosystem.

• Lightweight & Efficient: Optimized for low memory consumption.
• Production Ready: Stable and reliable for use in production environments.
• WhatsApp Integration: Connects to WhatsApp to send and receive messages.
• HTTP API: Exposes an HTTP API for easy integration with other services.
• Redis Support: Uses Redis for session storage and caching.
• SQLite Database: Utilizes SQLite for persistent data storage.
• Environment-based Configuration: Easily configure the application using environment variables.
• Structured Logging: Implements structured logging with Zap for better monitoring and debugging.
• Group & Community Management: Full support for WhatsApp group and community operations.
• All Evolution API Message Types: Compatible with all Evolution API message types for sending and receiving.
• Message Reactions: Support for sending and receiving emoji reactions.
• Message Deletion: Ability to delete messages for everyone.
• Call Signaling: Emits sanitized WhatsApp call signaling events for RTC integration work.

To get a local copy up and running follow these simple steps.

• Go 1.26 or higher
• Redis
• SQLite

1. Clone the repo

   git clone https://github.com/verbeux-ai/whatsmiau.git

2. Install Go packages

   go mod tidy

3. Set up your environment variables by copying .env.example to .env and filling in the required values.

   cp .env.example .env

4. Run the application

   go run main.go

You can also run the application using Docker and Docker Compose.

1. Build and run the containers:

   docker-compose up -d --build

2. View the logs:

   docker-compose logs -f

3. Stop the containers:

   docker-compose down

Official Docker images are available on Docker Hub.

• Latest stable release: impedr029/whatsmiau:vX.Y.Z (see versions)
• Development version: impedr029/whatsmiau:develop

You can pull the latest stable image with (example):

docker pull impedr029/whatsmiau:vX.Y.Z

Or the development image with:

docker pull impedr029/whatsmiau:develop

The application is configured using environment variables. The following variables are available:

WhatsMiau ships an English Swagger 2.0 contract for every application route: canonical endpoints, Evolution API compatibility aliases, instance management, messages, chats, groups, communities, webhooks, calls, and documentation delivery itself.

• Open the Swagger UI at GET /docs. Use Swagger's Authorize dialog to enter the regular apikey before sending “Try it out” API requests.
• Download the machine-readable contract with GET /v1/swagger.json or GET /v1/swagger.yaml, using the standard apikey header.
• All /v1 operations remain authenticated exclusively through apikey. A Swagger UI page does not change that requirement; it only adds the header when an operation is executed.
• The Swagger UI and its read-only contract documents are public so the UI can load before the key is entered. API operations and the /v1 contract downloads remain protected by the normal apikey middleware.

Use HTTPS whenever the UI is exposed outside a trusted development network, because the API key is sent in request headers during “Try it out”.

We use SemVer for versioning. For the versions available, see the tags on this repository.

This API is designed to be compatible with the Evolution API. This means that you can use clients and tools designed for the Evolution API with this project.

It exclusively supports webhooks in the Evolution API format, offering two distinct approaches for their implementation, providing flexibility for different use cases.

WhatsMiau is designed to be a lightweight, drop-in replacement for the Evolution API. If you are running WhatsMiau on the same host and port as your previous Evolution API instance, migration is seamless.

Since WhatsMiau maintains compatibility with the Evolution API's routes, you only need to stop your Evolution API server and start the WhatsMiau server. No changes to your existing API calls are necessary.

For instance, if you were sending a text message using a curl command to an Evolution API server running on localhost:8080, the exact same command will work with WhatsMiau.

Before (Evolution API):

curl -X POST 'http://localhost:8080/message/sendText/my-instance' \
-H 'Content-Type: application/json' \
-H 'apikey: YOUR_API_KEY' \
-d ".{\"number\": \"1234567890\",\"textMessage\": {\"text\": \"Hello from Evolution API!\"}}"

After (WhatsMiau):

Simply point your application to the WhatsMiau server URL. The same request will be handled by WhatsMiau:

curl -X POST 'http://localhost:8080/v1/message/sendText/my-instance' \
-H 'Content-Type: application/json' \
-H 'apikey: YOUR_API_KEY' \
-d ".{\"number\": \"1234567890\",\"textMessage\": {\"text\": \"Hello from WhatsMiau!\"}}"

Webhook configuration and webhook payloads use different event identifiers to preserve Evolution API compatibility. Configure subscriptions with the uppercase value. The emitted payload uses the lowercase value in its event field.

Payload-style values such as messages.upsert remain accepted in configuration for compatibility with older Manager UI versions. WhatsMiau stores and returns configured values as provided; it normalizes them only when matching subscriptions.

Donate: https://buy.stripe.com/8x28wI5vKfPbe9b8ih1VK0f