ZUCKZAPGO

Prerequisites

To run ZUCKZAPGO, you need:

• Go (Go Programming Language)
• Docker (optional, for containerization)
• Postgres (optional, can work standalone using SQLite)

Compilation

Compile the project with the following command:

go build .

Configuration

ZuckZapGo uses a .env file for configuration. Here are the required settings:

For PostgresSQL

ZUCKZAPGO_ADMIN_TOKEN=your_admin_token_here
USER=zuckzapgo
PASSWORD=zuckzapgo
NAME=zuckzapgo
HOST=localhost
PORT=5432
America/New_York

For SQLite

ZUCKZAPGO_ADMIN_TOKEN=your_admin_token_here
TZ=America/New_York

Execution

By default, the service will start on port 8080. You can change the behavior with the following parameters:

• -address: defines the IP address to bind the server (default 0.0.0.0)
• -port: defines the port number (default 8080)
• -logtype: format for logs, console (default) or json
• -wadebug: enables whatsmeow debug, INFO or DEBUG levels are supported
• -sslcertificate: SSL Certificate File
• -sslprivatekey: SSL Private Key File
• -skipmedia: Do not automatically download media from received messages
• -osname: Connection OSName in Whatsapp (default "Mac OS 10")
• -admintoken: Security Token to authorize admin actions (list/create/remove users)

./zuckzapgo -logtype json

Creating Users

To open sessions, you first need to create a user and define an authentication token for it. You can do this login into the Dashboard, or using the API directly:

curl -X POST http://localhost:8080/admin/users \
-H "Authorization: $ZUCKZAPGO_ADMIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "John", "token": "Z1234ABCCXD"}'

Once users are created, you can communicate with the API by passing the Token header as a simple authentication method. You can have multiple users (different numbers) on the same server. For every user you will need to Connect to whatsapp and then either scan a QR Code or Pair via phone number.

Web Resources

The daemon also serves some static web files, useful for development/testing that you can load with your browser:

• A Swagger API reference at /api
• An example web page to connect and scan QR codes at /login (where you will need to pass ?token=1234ABCD)
• A management dashboard at /dashboard