https://github.com/capsulbrasil/zapmeow
Lightweight REST wrapper around WhatsApp protocol, powered by whatsmeow
https://github.com/capsulbrasil/zapmeow
go rest whatsapp whatsapp-bot whatsapp-web whatsmeow
Last synced: 12 months ago
JSON representation
Lightweight REST wrapper around WhatsApp protocol, powered by whatsmeow
- Host: GitHub
- URL: https://github.com/capsulbrasil/zapmeow
- Owner: capsulbrasil
- Created: 2023-08-21T19:32:29.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T15:19:48.000Z (about 1 year ago)
- Last Synced: 2025-07-04T09:07:57.120Z (12 months ago)
- Topics: go, rest, whatsapp, whatsapp-bot, whatsapp-web, whatsmeow
- Language: Go
- Homepage: https://capsulbrasil.github.io/zapmeow/
- Size: 128 KB
- Stars: 55
- Watchers: 3
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## ZapMeow
ZapMeow is a versatile API that allows developers to interact with WhatsApp using the [whatsmeow](https://github.com/tulir/whatsmeow) library. This API was designed to facilitate communication and allow the use of multiple instances of WhatsApp.
### Features
- **Multi-Instance Support**: Seamlessly manage and interact with multiple WhatsApp instances concurrently.
- **Message Sending**: Send text, image, and audio messages to WhatsApp contacts and groups.
- **Phone Number Verification**: Check if phone numbers are registered on WhatsApp.
- **Contact Information**: Obtain contact information.
- **Profile Information**: Obtain profile information.
- **QR Code Generation**: Generate QR codes to initiate WhatsApp login.
- **Instance Status**: Retrieve the connection status of a specific instance of WhatsApp.
### Getting Started
To get started with the ZapMeow API, follow these simple steps:
1. **Clone the Repository**: Clone this repository to your local machine using the following command:
```sh
git clone git@github.com:capsulbrasil/zapmeow.git
```
2. **Configuration**: Set up your project configuration by copying the provided `.env.example` file and updating the environment variables.
- Navigate to the project directory:
```sh
cd zapmeow
```
- Create a copy of the `.env.example` file as `.env`:
```sh
cp .env.example .env
```
- Open the `.env` file using your preferred text editor and update the necessary environment variables.
3. **Install Dependencies**: Install the project dependencies using the following command:
```sh
go mod tidy
```
4. **Start the API**: Run the API server by executing the following command:
```sh
./zapmeow
```
5. **Access Swagger Documentation**: You can access the Swagger documentation by visiting the following URL in your web browser:
```
http://localhost:8900/api/swagger/index.html
```
The Swagger documentation provides detailed information about the available API endpoints, request parameters, and response formats.
Now, your ZapMeow API is up and running, ready for you to start interacting with WhatsApp instances programmatically.