feat(docker): 🚀 Update server port to 8025
- Change default server port from 8080 to 8025 across all configurations. - Update Dockerfile, docker-compose.yml, and related documentation. - Ensure all CLI commands and API endpoints reflect the new port. - Adjust example configurations and health check URLs accordingly.
This commit is contained in:
@@ -18,6 +18,7 @@ Get a list of all configured WhatsApp accounts.
|
||||
**Endpoint:** `GET /api/accounts`
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
@@ -45,6 +46,7 @@ Add a new WhatsApp account to the system.
|
||||
**Endpoint:** `POST /api/accounts/add`
|
||||
|
||||
**Request Body (WhatsApp Web/WhatsMe ow):**
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "my-account",
|
||||
@@ -57,6 +59,7 @@ Add a new WhatsApp account to the system.
|
||||
```
|
||||
|
||||
**Request Body (Business API):**
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "business-account",
|
||||
@@ -74,6 +77,7 @@ Add a new WhatsApp account to the system.
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
@@ -82,6 +86,7 @@ Add a new WhatsApp account to the system.
|
||||
```
|
||||
|
||||
**Status Codes:**
|
||||
|
||||
- `201 Created` - Account added successfully
|
||||
- `400 Bad Request` - Invalid request body
|
||||
- `500 Internal Server Error` - Failed to connect or save config
|
||||
@@ -95,6 +100,7 @@ Update an existing WhatsApp account configuration.
|
||||
**Endpoint:** `POST /api/accounts/update` or `PUT /api/accounts/update`
|
||||
|
||||
**Request Body:**
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "business-account",
|
||||
@@ -112,6 +118,7 @@ Update an existing WhatsApp account configuration.
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
@@ -120,12 +127,14 @@ Update an existing WhatsApp account configuration.
|
||||
```
|
||||
|
||||
**Notes:**
|
||||
|
||||
- The `id` field is required to identify which account to update
|
||||
- The `type` field cannot be changed (preserved from original)
|
||||
- If the account is enabled, it will be disconnected and reconnected with new settings
|
||||
- Configuration is saved to disk after successful update
|
||||
|
||||
**Status Codes:**
|
||||
|
||||
- `200 OK` - Account updated successfully
|
||||
- `400 Bad Request` - Invalid request or missing ID
|
||||
- `404 Not Found` - Account not found
|
||||
@@ -140,6 +149,7 @@ Disable a WhatsApp account (disconnect and prevent auto-connect on restart).
|
||||
**Endpoint:** `POST /api/accounts/disable`
|
||||
|
||||
**Request Body:**
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "my-account"
|
||||
@@ -147,6 +157,7 @@ Disable a WhatsApp account (disconnect and prevent auto-connect on restart).
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
@@ -155,12 +166,14 @@ Disable a WhatsApp account (disconnect and prevent auto-connect on restart).
|
||||
```
|
||||
|
||||
**Behavior:**
|
||||
|
||||
- Disconnects the account immediately
|
||||
- Sets `disabled: true` in config
|
||||
- Account will not auto-connect on server restart
|
||||
- Account remains in config (can be re-enabled)
|
||||
|
||||
**Status Codes:**
|
||||
|
||||
- `200 OK` - Account disabled successfully
|
||||
- `400 Bad Request` - Invalid request body
|
||||
- `404 Not Found` - Account not found
|
||||
@@ -175,6 +188,7 @@ Enable a previously disabled WhatsApp account.
|
||||
**Endpoint:** `POST /api/accounts/enable`
|
||||
|
||||
**Request Body:**
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "my-account"
|
||||
@@ -182,6 +196,7 @@ Enable a previously disabled WhatsApp account.
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
@@ -190,12 +205,14 @@ Enable a previously disabled WhatsApp account.
|
||||
```
|
||||
|
||||
**Behavior:**
|
||||
|
||||
- Sets `disabled: false` in config
|
||||
- Connects the account immediately
|
||||
- Account will auto-connect on server restart
|
||||
- If connection fails, account remains disabled
|
||||
|
||||
**Status Codes:**
|
||||
|
||||
- `200 OK` - Account enabled and connected successfully
|
||||
- `400 Bad Request` - Invalid request body
|
||||
- `404 Not Found` - Account not found
|
||||
@@ -210,6 +227,7 @@ Permanently remove a WhatsApp account from the system.
|
||||
**Endpoint:** `POST /api/accounts/remove` or `DELETE /api/accounts/remove`
|
||||
|
||||
**Request Body:**
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "my-account"
|
||||
@@ -217,6 +235,7 @@ Permanently remove a WhatsApp account from the system.
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok"
|
||||
@@ -224,11 +243,13 @@ Permanently remove a WhatsApp account from the system.
|
||||
```
|
||||
|
||||
**Behavior:**
|
||||
|
||||
- Disconnects the account
|
||||
- Removes from config permanently
|
||||
- Session data is NOT deleted (manual cleanup required)
|
||||
|
||||
**Status Codes:**
|
||||
|
||||
- `200 OK` - Account removed successfully
|
||||
- `400 Bad Request` - Invalid request body
|
||||
- `404 Not Found` - Account not found
|
||||
@@ -270,25 +291,25 @@ Account settings are stored in `config.json`:
|
||||
|
||||
### Configuration Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
|-------|------|----------|-------------|
|
||||
| `id` | string | Yes | Unique identifier for the account |
|
||||
| `type` | string | Yes | Account type: `whatsmeow` or `business-api` |
|
||||
| `phone_number` | string | Yes | Phone number with country code |
|
||||
| `disabled` | boolean | No | If `true`, account won't connect (default: `false`) |
|
||||
| `session_path` | string | No | Session storage path (whatsmeow only) |
|
||||
| `show_qr` | boolean | No | Display QR code in logs (whatsmeow only) |
|
||||
| `business_api` | object | Conditional | Required for `business-api` type |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------- | ------- | ----------- | --------------------------------------------------- |
|
||||
| `id` | string | Yes | Unique identifier for the account |
|
||||
| `type` | string | Yes | Account type: `whatsmeow` or `business-api` |
|
||||
| `phone_number` | string | Yes | Phone number with country code |
|
||||
| `disabled` | boolean | No | If `true`, account won't connect (default: `false`) |
|
||||
| `session_path` | string | No | Session storage path (whatsmeow only) |
|
||||
| `show_qr` | boolean | No | Display QR code in logs (whatsmeow only) |
|
||||
| `business_api` | object | Conditional | Required for `business-api` type |
|
||||
|
||||
### Business API Configuration
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
|-------|------|----------|-------------|
|
||||
| `phone_number_id` | string | Yes | WhatsApp Business phone number ID |
|
||||
| `access_token` | string | Yes | Meta Graph API access token |
|
||||
| `business_account_id` | string | No | Business account ID |
|
||||
| `api_version` | string | No | API version (default: `v21.0`) |
|
||||
| `verify_token` | string | No | Webhook verification token |
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------- | ------ | -------- | --------------------------------- |
|
||||
| `phone_number_id` | string | Yes | WhatsApp Business phone number ID |
|
||||
| `access_token` | string | Yes | Meta Graph API access token |
|
||||
| `business_account_id` | string | No | Business account ID |
|
||||
| `api_version` | string | No | API version (default: `v21.0`) |
|
||||
| `verify_token` | string | No | Webhook verification token |
|
||||
|
||||
---
|
||||
|
||||
@@ -297,11 +318,13 @@ Account settings are stored in `config.json`:
|
||||
### cURL Examples
|
||||
|
||||
**List accounts:**
|
||||
|
||||
```bash
|
||||
curl -u username:password http://localhost:8080/api/accounts
|
||||
curl -u username:password http://localhost:8025/api/accounts
|
||||
```
|
||||
|
||||
**Add account:**
|
||||
|
||||
```bash
|
||||
curl -u username:password \
|
||||
-X POST \
|
||||
@@ -313,10 +336,11 @@ curl -u username:password \
|
||||
"session_path": "./sessions/new-account",
|
||||
"show_qr": true
|
||||
}' \
|
||||
http://localhost:8080/api/accounts/add
|
||||
http://localhost:8025/api/accounts/add
|
||||
```
|
||||
|
||||
**Update account:**
|
||||
|
||||
```bash
|
||||
curl -u username:password \
|
||||
-X POST \
|
||||
@@ -331,34 +355,37 @@ curl -u username:password \
|
||||
"api_version": "v21.0"
|
||||
}
|
||||
}' \
|
||||
http://localhost:8080/api/accounts/update
|
||||
http://localhost:8025/api/accounts/update
|
||||
```
|
||||
|
||||
**Disable account:**
|
||||
|
||||
```bash
|
||||
curl -u username:password \
|
||||
-X POST \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"id": "my-account"}' \
|
||||
http://localhost:8080/api/accounts/disable
|
||||
http://localhost:8025/api/accounts/disable
|
||||
```
|
||||
|
||||
**Enable account:**
|
||||
|
||||
```bash
|
||||
curl -u username:password \
|
||||
-X POST \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"id": "my-account"}' \
|
||||
http://localhost:8080/api/accounts/enable
|
||||
http://localhost:8025/api/accounts/enable
|
||||
```
|
||||
|
||||
**Remove account:**
|
||||
|
||||
```bash
|
||||
curl -u username:password \
|
||||
-X POST \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"id": "my-account"}' \
|
||||
http://localhost:8080/api/accounts/remove
|
||||
http://localhost:8025/api/accounts/remove
|
||||
```
|
||||
|
||||
---
|
||||
@@ -419,11 +446,13 @@ All endpoints return proper HTTP status codes and JSON error messages:
|
||||
```
|
||||
|
||||
Or plain text for simple errors:
|
||||
|
||||
```
|
||||
Account ID required in path
|
||||
```
|
||||
|
||||
Common error scenarios:
|
||||
|
||||
- Account already exists (when adding)
|
||||
- Account not found (when updating/removing)
|
||||
- Connection failed (when enabling)
|
||||
|
||||
40
CLI.md
40
CLI.md
@@ -52,7 +52,7 @@ Create a configuration file at `~/.whatshooked/cli.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"server_url": "http://localhost:8080",
|
||||
"server_url": "http://localhost:8025",
|
||||
"auth_key": "your-api-key-here",
|
||||
"username": "",
|
||||
"password": ""
|
||||
@@ -63,7 +63,7 @@ Or use API key authentication:
|
||||
|
||||
```json
|
||||
{
|
||||
"server_url": "http://localhost:8080",
|
||||
"server_url": "http://localhost:8025",
|
||||
"auth_key": "your-secure-api-key"
|
||||
}
|
||||
```
|
||||
@@ -72,7 +72,7 @@ Or use username/password authentication:
|
||||
|
||||
```json
|
||||
{
|
||||
"server_url": "http://localhost:8080",
|
||||
"server_url": "http://localhost:8025",
|
||||
"username": "admin",
|
||||
"password": "your-secure-password"
|
||||
}
|
||||
@@ -90,14 +90,14 @@ cp .whatshooked-cli.example.json .whatshooked-cli.json
|
||||
Set environment variables (useful for CI/CD):
|
||||
|
||||
```bash
|
||||
export WHATSHOOKED_SERVER_URL="http://localhost:8080"
|
||||
export WHATSHOOKED_SERVER_URL="http://localhost:8025"
|
||||
export WHATSHOOKED_AUTH_KEY="your-api-key-here"
|
||||
```
|
||||
|
||||
Or with username/password:
|
||||
|
||||
```bash
|
||||
export WHATSHOOKED_SERVER_URL="http://localhost:8080"
|
||||
export WHATSHOOKED_SERVER_URL="http://localhost:8025"
|
||||
export WHATSHOOKED_USERNAME="admin"
|
||||
export WHATSHOOKED_PASSWORD="your-password"
|
||||
```
|
||||
@@ -107,7 +107,7 @@ export WHATSHOOKED_PASSWORD="your-password"
|
||||
Pass credentials via command-line flags:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli --server http://localhost:8080 health
|
||||
./bin/whatshook-cli --server http://localhost:8025 health
|
||||
```
|
||||
|
||||
Note: Currently, authentication credentials can only be set via config file or environment variables. Command-line flags for auth credentials may be added in future versions.
|
||||
@@ -118,7 +118,7 @@ If your server doesn't require authentication, simply omit the authentication fi
|
||||
|
||||
```json
|
||||
{
|
||||
"server_url": "http://localhost:8080"
|
||||
"server_url": "http://localhost:8025"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -134,12 +134,12 @@ The CLI looks for configuration files in the following locations (in order):
|
||||
|
||||
### Configuration Options
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `server_url` | string | `http://localhost:8080` | WhatsHooked server URL |
|
||||
| `auth_key` | string | `""` | API key for authentication |
|
||||
| `username` | string | `""` | Username for Basic Auth |
|
||||
| `password` | string | `""` | Password for Basic Auth |
|
||||
| Option | Type | Default | Description |
|
||||
| ------------ | ------ | ----------------------- | -------------------------- |
|
||||
| `server_url` | string | `http://localhost:8025` | WhatsHooked server URL |
|
||||
| `auth_key` | string | `""` | API key for authentication |
|
||||
| `username` | string | `""` | Username for Basic Auth |
|
||||
| `password` | string | `""` | Password for Basic Auth |
|
||||
|
||||
## Commands
|
||||
|
||||
@@ -178,6 +178,7 @@ Add a new webhook interactively:
|
||||
```
|
||||
|
||||
You'll be prompted for:
|
||||
|
||||
- Hook ID
|
||||
- Hook Name
|
||||
- Webhook URL
|
||||
@@ -188,6 +189,7 @@ You'll be prompted for:
|
||||
**Available Event Types:**
|
||||
|
||||
WhatsApp Connection Events:
|
||||
|
||||
- `whatsapp.connected` - WhatsApp client connected
|
||||
- `whatsapp.disconnected` - WhatsApp client disconnected
|
||||
- `whatsapp.qr.code` - QR code generated for pairing
|
||||
@@ -198,6 +200,7 @@ WhatsApp Connection Events:
|
||||
- `whatsapp.pair.event` - Generic pairing event
|
||||
|
||||
Message Events:
|
||||
|
||||
- `message.received` - Message received from WhatsApp
|
||||
- `message.sent` - Message sent successfully
|
||||
- `message.failed` - Message sending failed
|
||||
@@ -205,6 +208,7 @@ Message Events:
|
||||
- `message.read` - Message read by recipient
|
||||
|
||||
Hook Events:
|
||||
|
||||
- `hook.triggered` - Hook was triggered
|
||||
- `hook.success` - Hook executed successfully
|
||||
- `hook.failed` - Hook execution failed
|
||||
@@ -239,6 +243,7 @@ Add a new WhatsApp account interactively:
|
||||
```
|
||||
|
||||
You'll be prompted for:
|
||||
|
||||
- Account ID
|
||||
- Phone Number (with country code, e.g., +1234567890)
|
||||
- Session Path (where to store session data)
|
||||
@@ -256,6 +261,7 @@ Send a text message interactively:
|
||||
```
|
||||
|
||||
You'll be prompted for:
|
||||
|
||||
- Account ID
|
||||
- Recipient (phone number or JID)
|
||||
- Message text
|
||||
@@ -299,7 +305,7 @@ Supported formats: PDF, DOC, DOCX, XLS, XLSX, TXT, ZIP, and more
|
||||
mkdir -p ~/.whatshooked
|
||||
cat > ~/.whatshooked/cli.json <<EOF
|
||||
{
|
||||
"server_url": "http://localhost:8080",
|
||||
"server_url": "http://localhost:8025",
|
||||
"auth_key": "my-secure-api-key"
|
||||
}
|
||||
EOF
|
||||
@@ -315,7 +321,7 @@ EOF
|
||||
|
||||
```bash
|
||||
# Set environment variables
|
||||
export WHATSHOOKED_SERVER_URL="https://my-server.com:8080"
|
||||
export WHATSHOOKED_SERVER_URL="https://my-server.com:8025"
|
||||
export WHATSHOOKED_AUTH_KEY="production-api-key"
|
||||
|
||||
# Use CLI without config file
|
||||
@@ -375,7 +381,7 @@ export WHATSHOOKED_AUTH_KEY="production-api-key"
|
||||
{
|
||||
"server": {
|
||||
"host": "0.0.0.0",
|
||||
"port": 8080,
|
||||
"port": 8025,
|
||||
"auth_key": "super-secret-production-key"
|
||||
}
|
||||
}
|
||||
@@ -452,7 +458,7 @@ cp .whatshooked-cli.example.json ~/.whatshooked/cli.json
|
||||
Verify the server is running:
|
||||
|
||||
```bash
|
||||
curl http://localhost:8080/health
|
||||
curl http://localhost:8025/health
|
||||
```
|
||||
|
||||
### Authentication Required
|
||||
|
||||
83
DOCKER.md
83
DOCKER.md
@@ -10,6 +10,7 @@ This guide explains how to run WhatsHooked using Docker and Docker Compose.
|
||||
## Quick Start
|
||||
|
||||
1. **Copy the example configuration file:**
|
||||
|
||||
```bash
|
||||
cp config.example.json config.json
|
||||
```
|
||||
@@ -21,54 +22,64 @@ This guide explains how to run WhatsHooked using Docker and Docker Compose.
|
||||
- Server settings (port, authentication)
|
||||
|
||||
3. **Create required directories:**
|
||||
|
||||
```bash
|
||||
mkdir -p sessions data/media
|
||||
```
|
||||
|
||||
4. **Build and start the server:**
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
5. **View logs to scan QR code (first run):**
|
||||
|
||||
```bash
|
||||
docker-compose logs -f whatshooked
|
||||
```
|
||||
|
||||
Scan the QR code with WhatsApp on your phone to authenticate.
|
||||
|
||||
6. **Check server health:**
|
||||
```bash
|
||||
curl http://localhost:8080/health
|
||||
curl http://localhost:8025/health
|
||||
```
|
||||
|
||||
## Docker Commands
|
||||
|
||||
### Build the image
|
||||
|
||||
```bash
|
||||
docker-compose build
|
||||
```
|
||||
|
||||
### Start the service
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### Stop the service
|
||||
|
||||
```bash
|
||||
docker-compose down
|
||||
```
|
||||
|
||||
### View logs
|
||||
|
||||
```bash
|
||||
docker-compose logs -f
|
||||
```
|
||||
|
||||
### Restart the service
|
||||
|
||||
```bash
|
||||
docker-compose restart
|
||||
```
|
||||
|
||||
### Access the container shell
|
||||
|
||||
```bash
|
||||
docker-compose exec whatshooked sh
|
||||
```
|
||||
@@ -87,9 +98,10 @@ These volumes ensure your data persists across container restarts.
|
||||
|
||||
### Port Mapping
|
||||
|
||||
By default, the server runs on port 8080. To change the port:
|
||||
By default, the server runs on port 8025. To change the port:
|
||||
|
||||
**Option 1: Update config.json**
|
||||
|
||||
```json
|
||||
{
|
||||
"server": {
|
||||
@@ -97,16 +109,19 @@ By default, the server runs on port 8080. To change the port:
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Then update docker-compose.yml:
|
||||
|
||||
```yaml
|
||||
ports:
|
||||
- "9090:9090"
|
||||
```
|
||||
|
||||
**Option 2: Map to different host port**
|
||||
|
||||
```yaml
|
||||
ports:
|
||||
- "3000:8080" # Access via localhost:3000, server still runs on 8080 internally
|
||||
- "3000:8025" # Access via localhost:3000, server still runs on 8025 internally
|
||||
```
|
||||
|
||||
### Authentication
|
||||
@@ -114,6 +129,7 @@ ports:
|
||||
Set authentication in config.json:
|
||||
|
||||
**Option 1: API Key**
|
||||
|
||||
```json
|
||||
{
|
||||
"server": {
|
||||
@@ -123,6 +139,7 @@ Set authentication in config.json:
|
||||
```
|
||||
|
||||
**Option 2: Username/Password**
|
||||
|
||||
```json
|
||||
{
|
||||
"server": {
|
||||
@@ -140,10 +157,10 @@ Uncomment the deploy section in docker-compose.yml to set resource limits:
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: '1.0'
|
||||
cpus: "1.0"
|
||||
memory: 512M
|
||||
reservations:
|
||||
cpus: '0.25'
|
||||
cpus: "0.25"
|
||||
memory: 128M
|
||||
```
|
||||
|
||||
@@ -152,6 +169,7 @@ deploy:
|
||||
When you first start the server, you'll need to scan a QR code to authenticate with WhatsApp.
|
||||
|
||||
### View QR Code in Logs
|
||||
|
||||
```bash
|
||||
docker-compose logs -f whatshooked
|
||||
```
|
||||
@@ -159,19 +177,22 @@ docker-compose logs -f whatshooked
|
||||
The QR code will be displayed in ASCII art in the terminal along with a browser link. You have two options:
|
||||
|
||||
**Option 1: Scan from Terminal**
|
||||
|
||||
1. Open WhatsApp
|
||||
2. Go to Settings > Linked Devices
|
||||
3. Tap "Link a Device"
|
||||
4. Scan the QR code from the terminal
|
||||
|
||||
**Option 2: View in Browser**
|
||||
1. Look for the line: `Or open in browser: http://localhost:8080/api/qr/{account_id}`
|
||||
|
||||
1. Look for the line: `Or open in browser: http://localhost:8025/api/qr/{account_id}`
|
||||
2. Open that URL in your web browser to see a larger PNG image
|
||||
3. Scan the QR code from your browser
|
||||
|
||||
### Alternative: Use CLI Tool
|
||||
|
||||
You can also use the CLI tool outside Docker to link accounts, then mount the session:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli accounts add
|
||||
```
|
||||
@@ -183,33 +204,39 @@ The Docker image includes both the server and CLI binaries in the `/app/bin` dir
|
||||
### Available CLI Commands
|
||||
|
||||
List all hooks:
|
||||
|
||||
```bash
|
||||
docker exec whatshooked-server /app/bin/whatshook-cli --server http://localhost:8080 hooks list
|
||||
docker exec whatshooked-server /app/bin/whatshook-cli --server http://localhost:8025 hooks list
|
||||
```
|
||||
|
||||
Add a new hook:
|
||||
|
||||
```bash
|
||||
docker exec -it whatshooked-server /app/bin/whatshook-cli --server http://localhost:8080 hooks add
|
||||
docker exec -it whatshooked-server /app/bin/whatshook-cli --server http://localhost:8025 hooks add
|
||||
```
|
||||
|
||||
Remove a hook:
|
||||
|
||||
```bash
|
||||
docker exec whatshooked-server /app/bin/whatshook-cli --server http://localhost:8080 hooks remove <hook_id>
|
||||
docker exec whatshooked-server /app/bin/whatshook-cli --server http://localhost:8025 hooks remove <hook_id>
|
||||
```
|
||||
|
||||
List WhatsApp accounts:
|
||||
|
||||
```bash
|
||||
docker exec whatshooked-server /app/bin/whatshook-cli --server http://localhost:8080 accounts list
|
||||
docker exec whatshooked-server /app/bin/whatshook-cli --server http://localhost:8025 accounts list
|
||||
```
|
||||
|
||||
Send a message:
|
||||
|
||||
```bash
|
||||
docker exec -it whatshooked-server /app/bin/whatshook-cli --server http://localhost:8080 send
|
||||
docker exec -it whatshooked-server /app/bin/whatshook-cli --server http://localhost:8025 send
|
||||
```
|
||||
|
||||
Check server health:
|
||||
|
||||
```bash
|
||||
docker exec whatshooked-server /app/bin/whatshook-cli --server http://localhost:8080 health
|
||||
docker exec whatshooked-server /app/bin/whatshook-cli --server http://localhost:8025 health
|
||||
```
|
||||
|
||||
### Authentication with CLI
|
||||
@@ -217,9 +244,10 @@ docker exec whatshooked-server /app/bin/whatshook-cli --server http://localhost:
|
||||
If your server has authentication enabled, you need to configure it in the CLI:
|
||||
|
||||
**Option 1: Using command-line flags**
|
||||
|
||||
```bash
|
||||
docker exec whatshooked-server /app/bin/whatshook-cli \
|
||||
--server http://localhost:8080 \
|
||||
--server http://localhost:8025 \
|
||||
--api-key your-api-key \
|
||||
hooks list
|
||||
```
|
||||
@@ -227,15 +255,17 @@ docker exec whatshooked-server /app/bin/whatshook-cli \
|
||||
**Option 2: Create a CLI config file**
|
||||
|
||||
1. Access the container:
|
||||
|
||||
```bash
|
||||
docker exec -it whatshooked-server sh
|
||||
```
|
||||
|
||||
2. Create the CLI config:
|
||||
|
||||
```bash
|
||||
cat > /app/.whatshooked-cli.json <<EOF
|
||||
{
|
||||
"server_url": "http://localhost:8080",
|
||||
"server_url": "http://localhost:8025",
|
||||
"api_key": "your-api-key"
|
||||
}
|
||||
EOF
|
||||
@@ -251,10 +281,11 @@ docker exec whatshooked-server /app/bin/whatshook-cli \
|
||||
Create an alias on your host machine for easier CLI access:
|
||||
|
||||
```bash
|
||||
alias whatshook-cli='docker exec -it whatshooked-server /app/bin/whatshook-cli --server http://localhost:8080'
|
||||
alias whatshook-cli='docker exec -it whatshooked-server /app/bin/whatshook-cli --server http://localhost:8025'
|
||||
```
|
||||
|
||||
Then use it like:
|
||||
|
||||
```bash
|
||||
whatshook-cli hooks list
|
||||
whatshook-cli send
|
||||
@@ -265,25 +296,33 @@ Add this to your `~/.bashrc` or `~/.zshrc` to make it permanent.
|
||||
## Troubleshooting
|
||||
|
||||
### Container won't start
|
||||
|
||||
Check logs for errors:
|
||||
|
||||
```bash
|
||||
docker-compose logs
|
||||
```
|
||||
|
||||
### Config file not found
|
||||
|
||||
Ensure config.json exists in the project root:
|
||||
|
||||
```bash
|
||||
ls -la config.json
|
||||
```
|
||||
|
||||
### Permission issues with volumes
|
||||
|
||||
Fix ownership of mounted directories:
|
||||
|
||||
```bash
|
||||
sudo chown -R $(id -u):$(id -g) sessions data
|
||||
```
|
||||
|
||||
### QR code not displaying
|
||||
|
||||
Ensure `show_qr: true` is set in config.json:
|
||||
|
||||
```json
|
||||
{
|
||||
"whatsapp": [
|
||||
@@ -295,12 +334,15 @@ Ensure `show_qr: true` is set in config.json:
|
||||
```
|
||||
|
||||
### Cannot connect to server
|
||||
|
||||
Check if the container is running:
|
||||
|
||||
```bash
|
||||
docker-compose ps
|
||||
```
|
||||
|
||||
Check health status:
|
||||
|
||||
```bash
|
||||
docker inspect whatshooked-server | grep -A 10 Health
|
||||
```
|
||||
@@ -332,11 +374,13 @@ docker inspect whatshooked-server | grep -A 10 Health
|
||||
### Example with Reverse Proxy (nginx)
|
||||
|
||||
Create a network:
|
||||
|
||||
```bash
|
||||
docker network create whatshooked-net
|
||||
```
|
||||
|
||||
Update docker-compose.yml:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
whatshooked:
|
||||
@@ -344,7 +388,7 @@ services:
|
||||
- whatshooked-net
|
||||
# Don't expose ports to host, only to network
|
||||
# ports:
|
||||
# - "8080:8080"
|
||||
# - "8025:8025"
|
||||
|
||||
networks:
|
||||
whatshooked-net:
|
||||
@@ -352,6 +396,7 @@ networks:
|
||||
```
|
||||
|
||||
Configure nginx to proxy to the container:
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 443 ssl;
|
||||
@@ -361,7 +406,7 @@ server {
|
||||
ssl_certificate_key /path/to/key.pem;
|
||||
|
||||
location / {
|
||||
proxy_pass http://whatshooked:8080;
|
||||
proxy_pass http://whatshooked:8025;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
}
|
||||
@@ -373,6 +418,7 @@ server {
|
||||
### Health Checks
|
||||
|
||||
The compose file includes a health check that runs every 30 seconds:
|
||||
|
||||
```bash
|
||||
docker inspect --format='{{.State.Health.Status}}' whatshooked-server
|
||||
```
|
||||
@@ -380,6 +426,7 @@ docker inspect --format='{{.State.Health.Status}}' whatshooked-server
|
||||
### Log Management
|
||||
|
||||
Limit log size to prevent disk space issues:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
whatshooked:
|
||||
@@ -395,11 +442,13 @@ services:
|
||||
To update to the latest version:
|
||||
|
||||
1. Pull latest code:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
```
|
||||
|
||||
2. Rebuild the image:
|
||||
|
||||
```bash
|
||||
docker-compose build --no-cache
|
||||
```
|
||||
|
||||
@@ -34,7 +34,7 @@ COPY --from=builder /build/bin ./bin
|
||||
RUN mkdir -p /app/sessions /app/data/media /app/data/certs
|
||||
|
||||
# Expose the default server port
|
||||
EXPOSE 8080
|
||||
EXPOSE 8025
|
||||
|
||||
# Run the server
|
||||
ENTRYPOINT ["/app/bin/whatshook-server"]
|
||||
|
||||
@@ -56,11 +56,13 @@ Add the following to your `config.json`:
|
||||
### Published Events
|
||||
|
||||
Events are published to topics in the format:
|
||||
|
||||
```
|
||||
{topic_prefix}/{account_id}/{event_type}
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
- `whatshooked/my-account/message.received`
|
||||
- `whatshooked/my-account/whatsapp.connected`
|
||||
- `whatshooked/business-account/message.sent`
|
||||
@@ -68,6 +70,7 @@ Examples:
|
||||
### Sending Messages (Subscribe Mode)
|
||||
|
||||
When `subscribe: true` is enabled, you can send WhatsApp messages by publishing to:
|
||||
|
||||
```
|
||||
{topic_prefix}/{account_id}/send
|
||||
```
|
||||
@@ -145,6 +148,7 @@ When `subscribe: true` is enabled, you can send WhatsApp messages by publishing
|
||||
```
|
||||
|
||||
**Payload Fields:**
|
||||
|
||||
- `type`: Message type - "text", "image", "video", or "document" (default: "text")
|
||||
- `to`: Phone number in JID format (required)
|
||||
- `text`: Message text (required for text messages)
|
||||
@@ -161,6 +165,7 @@ When `subscribe: true` is enabled, you can send WhatsApp messages by publishing
|
||||
Available event types for filtering:
|
||||
|
||||
### WhatsApp Connection Events
|
||||
|
||||
- `whatsapp.connected`
|
||||
- `whatsapp.disconnected`
|
||||
- `whatsapp.pair.success`
|
||||
@@ -171,6 +176,7 @@ Available event types for filtering:
|
||||
- `whatsapp.pair.event`
|
||||
|
||||
### Message Events
|
||||
|
||||
- `message.received`
|
||||
- `message.sent`
|
||||
- `message.failed`
|
||||
@@ -178,6 +184,7 @@ Available event types for filtering:
|
||||
- `message.read`
|
||||
|
||||
### Hook Events
|
||||
|
||||
- `hook.triggered`
|
||||
- `hook.success`
|
||||
- `hook.failed`
|
||||
@@ -263,7 +270,7 @@ script:
|
||||
{
|
||||
"server": {
|
||||
"host": "0.0.0.0",
|
||||
"port": 8080
|
||||
"port": 8025
|
||||
},
|
||||
"whatsapp": [
|
||||
{
|
||||
|
||||
130
README.md
130
README.md
@@ -3,6 +3,7 @@
|
||||
A Go library and service that connects to WhatsApp and forwards messages to registered webhooks. Supports both personal WhatsApp accounts (via whatsmeow) and WhatsApp Business API. Enables two-way communication by allowing webhooks to respond with messages to be sent through WhatsApp.
|
||||
|
||||
**Use WhatsHooked as:**
|
||||
|
||||
- 📦 **Go Library** - Import into your own applications for programmatic WhatsApp integration
|
||||
- 🚀 **Standalone Server** - Run as a service with HTTP API and CLI management
|
||||
- 🔧 **Custom Integration** - Mount individual handlers in your existing HTTP servers
|
||||
@@ -59,7 +60,7 @@ Or with programmatic configuration:
|
||||
|
||||
```go
|
||||
wh, err := whatshooked.New(
|
||||
whatshooked.WithServer("0.0.0.0", 8080),
|
||||
whatshooked.WithServer("0.0.0.0", 8025),
|
||||
whatshooked.WithAuth("my-api-key", "", ""),
|
||||
whatshooked.WithWhatsmeowAccount("personal", "+1234567890", "./session", true),
|
||||
)
|
||||
@@ -79,7 +80,9 @@ make build
|
||||
When using personal WhatsApp accounts (whatsmeow), you'll need to pair the device on first launch. The QR code will be displayed in two ways:
|
||||
|
||||
### Terminal Display
|
||||
|
||||
The QR code is shown as ASCII art directly in the terminal:
|
||||
|
||||
```
|
||||
========================================
|
||||
WhatsApp QR Code for account: personal
|
||||
@@ -89,25 +92,29 @@ Scan this QR code with WhatsApp on your phone:
|
||||
|
||||
[ASCII QR Code displayed here]
|
||||
|
||||
Or open in browser: http://localhost:8080/api/qr/personal
|
||||
Or open in browser: http://localhost:8025/api/qr/personal
|
||||
========================================
|
||||
```
|
||||
|
||||
### Browser Display
|
||||
|
||||
For easier scanning, open the provided URL in your browser to view a larger PNG image:
|
||||
- URL format: `http://localhost:8080/api/qr/{account_id}`
|
||||
|
||||
- URL format: `http://localhost:8025/api/qr/{account_id}`
|
||||
- No authentication required for this endpoint
|
||||
- The QR code updates automatically when a new code is generated
|
||||
|
||||
### Webhook Events
|
||||
|
||||
The QR code URL is also included in the `whatsapp.qr.code` event:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "whatsapp.qr.code",
|
||||
"data": {
|
||||
"account_id": "personal",
|
||||
"qr_code": "2@...",
|
||||
"qr_url": "http://localhost:8080/api/qr/personal"
|
||||
"qr_url": "http://localhost:8025/api/qr/personal"
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -152,6 +159,7 @@ The system uses a central event bus to decouple components:
|
||||
- Webhook responses trigger message sends
|
||||
|
||||
This architecture enables:
|
||||
|
||||
- Loose coupling between WhatsApp and webhooks
|
||||
- Easy addition of new event subscribers
|
||||
- Centralized event logging and monitoring
|
||||
@@ -202,7 +210,7 @@ func main() {
|
||||
// Your own handlers
|
||||
mux.HandleFunc("/api/v1/custom", yourCustomHandler)
|
||||
|
||||
http.ListenAndServe(":8080", mux)
|
||||
http.ListenAndServe(":8025", mux)
|
||||
}
|
||||
```
|
||||
|
||||
@@ -212,7 +220,7 @@ Configure WhatsHooked entirely in code without a config file:
|
||||
|
||||
```go
|
||||
wh, err := whatshooked.New(
|
||||
whatshooked.WithServer("0.0.0.0", 8080),
|
||||
whatshooked.WithServer("0.0.0.0", 8025),
|
||||
whatshooked.WithAuth("my-api-key", "", ""),
|
||||
whatshooked.WithWhatsmeowAccount(
|
||||
"personal",
|
||||
@@ -347,6 +355,7 @@ make build
|
||||
```
|
||||
|
||||
Or manually:
|
||||
|
||||
```bash
|
||||
mkdir -p bin
|
||||
go build -o bin/whatshook-server ./cmd/server
|
||||
@@ -362,6 +371,7 @@ cp config.example.json config.json
|
||||
```
|
||||
|
||||
Or use one of the HTTPS examples:
|
||||
|
||||
```bash
|
||||
# Self-signed certificate (development)
|
||||
cp config.https-self-signed.example.json config.json
|
||||
@@ -379,7 +389,7 @@ Edit the configuration file to add your WhatsApp accounts and webhooks:
|
||||
{
|
||||
"server": {
|
||||
"host": "localhost",
|
||||
"port": 8080,
|
||||
"port": 8025,
|
||||
"default_country_code": "27"
|
||||
},
|
||||
"whatsapp": [
|
||||
@@ -423,23 +433,27 @@ Edit the configuration file to add your WhatsApp accounts and webhooks:
|
||||
### Configuration Options
|
||||
|
||||
**Server Configuration:**
|
||||
|
||||
- `host`: Server hostname (default: "localhost")
|
||||
- `port`: Server port (default: 8080)
|
||||
- `port`: Server port (default: 8025)
|
||||
- `default_country_code`: Default country code for phone number formatting (e.g., "27" for South Africa, "1" for US/Canada)
|
||||
- `username`: Username for HTTP Basic Authentication (optional)
|
||||
- `password`: Password for HTTP Basic Authentication (optional)
|
||||
- `auth_key`: API key for x-api-key header or Authorization Bearer token authentication (optional)
|
||||
|
||||
**WhatsApp Account Configuration:**
|
||||
|
||||
- `id`: Unique identifier for this account
|
||||
- `type`: Client type - `"whatsmeow"` for personal or `"business-api"` for Business API (defaults to "whatsmeow")
|
||||
- `phone_number`: Phone number with country code
|
||||
|
||||
**For whatsmeow (personal) accounts:**
|
||||
|
||||
- `session_path`: Path to store session data (default: `./sessions/{id}`)
|
||||
- `show_qr`: Display QR code in terminal for pairing (default: false)
|
||||
|
||||
**For business-api accounts:**
|
||||
|
||||
- `business_api`: Business API configuration object
|
||||
- `phone_number_id`: WhatsApp Business Phone Number ID from Meta
|
||||
- `access_token`: Access token from Meta Business Manager
|
||||
@@ -448,6 +462,7 @@ Edit the configuration file to add your WhatsApp accounts and webhooks:
|
||||
- `verify_token`: Token for webhook verification (required for receiving messages)
|
||||
|
||||
**Hook Configuration:**
|
||||
|
||||
- `id`: Unique identifier for this hook
|
||||
- `name`: Human-readable name
|
||||
- `url`: Webhook URL to call
|
||||
@@ -480,6 +495,7 @@ Automatically generates and manages self-signed certificates. Ideal for developm
|
||||
```
|
||||
|
||||
Or programmatically:
|
||||
|
||||
```go
|
||||
wh, err := whatshooked.New(
|
||||
whatshooked.WithServer("0.0.0.0", 8443),
|
||||
@@ -488,6 +504,7 @@ wh, err := whatshooked.New(
|
||||
```
|
||||
|
||||
**Features:**
|
||||
|
||||
- Automatically generates certificates on first run
|
||||
- Certificates valid for 1 year
|
||||
- Auto-renewal when expiring within 30 days
|
||||
@@ -516,6 +533,7 @@ Use your own certificate files from a trusted Certificate Authority (CA) or an e
|
||||
```
|
||||
|
||||
Or programmatically:
|
||||
|
||||
```go
|
||||
wh, err := whatshooked.New(
|
||||
whatshooked.WithServer("0.0.0.0", 8443),
|
||||
@@ -524,6 +542,7 @@ wh, err := whatshooked.New(
|
||||
```
|
||||
|
||||
**Features:**
|
||||
|
||||
- Use certificates from any CA (Let's Encrypt, DigiCert, etc.)
|
||||
- Full control over certificate lifecycle
|
||||
- Validates certificate files on startup
|
||||
@@ -551,6 +570,7 @@ Automatically obtains and renews SSL certificates from Let's Encrypt. Best for p
|
||||
```
|
||||
|
||||
Or programmatically:
|
||||
|
||||
```go
|
||||
wh, err := whatshooked.New(
|
||||
whatshooked.WithServer("0.0.0.0", 443),
|
||||
@@ -559,6 +579,7 @@ wh, err := whatshooked.New(
|
||||
```
|
||||
|
||||
**Features:**
|
||||
|
||||
- Automatic certificate provisioning from Let's Encrypt
|
||||
- Automatic certificate renewal before expiration
|
||||
- Fully managed - no manual intervention required
|
||||
@@ -566,6 +587,7 @@ wh, err := whatshooked.New(
|
||||
- Production and staging modes available
|
||||
|
||||
**Requirements:**
|
||||
|
||||
- Server must be publicly accessible
|
||||
- Port 443 (HTTPS) must be open
|
||||
- Port 80 (HTTP) must be open for ACME challenges
|
||||
@@ -573,6 +595,7 @@ wh, err := whatshooked.New(
|
||||
- Email address for Let's Encrypt notifications
|
||||
|
||||
**Important Notes:**
|
||||
|
||||
- Set `production: false` for testing to use Let's Encrypt staging environment (avoids rate limits)
|
||||
- Set `production: true` for production deployments to get trusted certificates
|
||||
- Ensure your domain's DNS A/AAAA record points to your server's IP
|
||||
@@ -586,21 +609,21 @@ All TLS configuration options:
|
||||
{
|
||||
"server": {
|
||||
"tls": {
|
||||
"enabled": true, // Enable HTTPS (default: false)
|
||||
"mode": "self-signed", // Mode: "self-signed", "custom", or "autocert" (required if enabled)
|
||||
"enabled": true, // Enable HTTPS (default: false)
|
||||
"mode": "self-signed", // Mode: "self-signed", "custom", or "autocert" (required if enabled)
|
||||
|
||||
// Self-signed mode options
|
||||
"cert_dir": "./data/certs", // Directory for generated certificates (default: ./data/certs)
|
||||
"cert_dir": "./data/certs", // Directory for generated certificates (default: ./data/certs)
|
||||
|
||||
// Custom mode options
|
||||
"cert_file": "/path/to/cert", // Path to certificate file (required for custom mode)
|
||||
"key_file": "/path/to/key", // Path to private key file (required for custom mode)
|
||||
"key_file": "/path/to/key", // Path to private key file (required for custom mode)
|
||||
|
||||
// Autocert mode options
|
||||
"domain": "example.com", // Domain name (required for autocert mode)
|
||||
"domain": "example.com", // Domain name (required for autocert mode)
|
||||
"email": "admin@example.com", // Email for Let's Encrypt notifications (optional)
|
||||
"cache_dir": "./data/autocert", // Cache directory for certificates (default: ./data/autocert)
|
||||
"production": true // Use Let's Encrypt production (default: false/staging)
|
||||
"production": true // Use Let's Encrypt production (default: false/staging)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -614,7 +637,7 @@ To disable HTTPS and use HTTP, set `enabled: false` or omit the `tls` section en
|
||||
{
|
||||
"server": {
|
||||
"host": "localhost",
|
||||
"port": 8080
|
||||
"port": 8025
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -624,13 +647,14 @@ To disable HTTPS and use HTTP, set `enabled: false` or omit the `tls` section en
|
||||
The server supports two authentication methods to protect API endpoints:
|
||||
|
||||
#### 1. HTTP Basic Authentication
|
||||
|
||||
Set both `username` and `password` in the server configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"server": {
|
||||
"host": "localhost",
|
||||
"port": 8080,
|
||||
"port": 8025,
|
||||
"username": "admin",
|
||||
"password": "secure_password"
|
||||
}
|
||||
@@ -638,31 +662,34 @@ Set both `username` and `password` in the server configuration:
|
||||
```
|
||||
|
||||
Clients must provide credentials in the Authorization header:
|
||||
|
||||
```bash
|
||||
curl -u admin:secure_password http://localhost:8080/api/hooks
|
||||
curl -u admin:secure_password http://localhost:8025/api/hooks
|
||||
```
|
||||
|
||||
#### 2. API Key Authentication
|
||||
|
||||
Set `auth_key` in the server configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"server": {
|
||||
"host": "localhost",
|
||||
"port": 8080,
|
||||
"port": 8025,
|
||||
"auth_key": "your-secret-api-key"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Clients can provide the API key using either:
|
||||
|
||||
- **x-api-key header**:
|
||||
```bash
|
||||
curl -H "x-api-key: your-secret-api-key" http://localhost:8080/api/hooks
|
||||
curl -H "x-api-key: your-secret-api-key" http://localhost:8025/api/hooks
|
||||
```
|
||||
- **Authorization Bearer token**:
|
||||
```bash
|
||||
curl -H "Authorization: Bearer your-secret-api-key" http://localhost:8080/api/hooks
|
||||
curl -H "Authorization: Bearer your-secret-api-key" http://localhost:8025/api/hooks
|
||||
```
|
||||
|
||||
#### Authentication Notes
|
||||
@@ -716,6 +743,7 @@ Add a Business API account to your `config.json`:
|
||||
```
|
||||
|
||||
**Important Notes:**
|
||||
|
||||
- Use a **permanent access token**, not the temporary 24-hour token
|
||||
- The `verify_token` is a random string you create - it will be used to verify Meta's webhook requests
|
||||
- Keep your access token secure and never commit it to version control
|
||||
@@ -727,7 +755,7 @@ To receive incoming messages from WhatsApp Business API, you must register your
|
||||
1. **Start the WhatsHooked server** with your Business API configuration
|
||||
2. **Ensure your server is publicly accessible** (use ngrok for testing):
|
||||
```bash
|
||||
ngrok http 8080
|
||||
ngrok http 8025
|
||||
```
|
||||
3. **In Meta for Developers**, go to **WhatsApp** → **Configuration**
|
||||
4. **Add Webhook URL**:
|
||||
@@ -750,11 +778,13 @@ Once configured, start the server and the Business API account will connect auto
|
||||
```
|
||||
|
||||
Look for logs indicating successful connection:
|
||||
|
||||
```
|
||||
Business API client connected account_id=business phone=+1234567890
|
||||
```
|
||||
|
||||
Send a test message:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli send
|
||||
# Select your business account
|
||||
@@ -765,6 +795,7 @@ Send a test message:
|
||||
### Business API Features
|
||||
|
||||
**Supported:**
|
||||
|
||||
- ✅ Send/receive text messages
|
||||
- ✅ Send/receive images with captions
|
||||
- ✅ Send/receive videos with captions
|
||||
@@ -783,6 +814,7 @@ Send a test message:
|
||||
- ✅ Event publishing to webhooks (same format as whatsmeow)
|
||||
|
||||
**Differences from whatsmeow:**
|
||||
|
||||
- No QR code pairing (uses access token authentication)
|
||||
- Rate limits apply based on your Meta Business tier
|
||||
- Official support from Meta
|
||||
@@ -816,6 +848,7 @@ You can run both personal (whatsmeow) and Business API accounts at the same time
|
||||
```
|
||||
|
||||
Both accounts will:
|
||||
|
||||
- Receive messages independently
|
||||
- Trigger the same webhooks
|
||||
- Publish identical event formats
|
||||
@@ -846,6 +879,7 @@ The QR code is also published as an event (`whatsapp.qr.code`) so you can handle
|
||||
### Using the CLI
|
||||
|
||||
The CLI uses Cobra and supports configuration from multiple sources with the following priority:
|
||||
|
||||
1. Command-line flags (highest priority)
|
||||
2. Environment variables
|
||||
3. Configuration file (lowest priority)
|
||||
@@ -853,34 +887,40 @@ The CLI uses Cobra and supports configuration from multiple sources with the fol
|
||||
#### Configuration
|
||||
|
||||
Create a CLI configuration file (optional):
|
||||
|
||||
```bash
|
||||
cp .whatshooked-cli.example.json .whatshooked-cli.json
|
||||
```
|
||||
|
||||
Or set via environment variable:
|
||||
|
||||
```bash
|
||||
export WHATSHOOKED_SERVER_URL=http://localhost:8080
|
||||
export WHATSHOOKED_SERVER_URL=http://localhost:8025
|
||||
```
|
||||
|
||||
Or use command-line flag:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli --server http://localhost:8080 health
|
||||
./bin/whatshook-cli --server http://localhost:8025 health
|
||||
```
|
||||
|
||||
#### Commands
|
||||
|
||||
Get help:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli --help
|
||||
./bin/whatshook-cli hooks --help
|
||||
```
|
||||
|
||||
Check server health:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli health
|
||||
```
|
||||
|
||||
List all hooks:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli hooks list
|
||||
# or just
|
||||
@@ -888,16 +928,19 @@ List all hooks:
|
||||
```
|
||||
|
||||
Add a new hook:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli hooks add
|
||||
```
|
||||
|
||||
Remove a hook:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli hooks remove <hook_id>
|
||||
```
|
||||
|
||||
List WhatsApp accounts:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli accounts list
|
||||
# or just
|
||||
@@ -905,11 +948,13 @@ List WhatsApp accounts:
|
||||
```
|
||||
|
||||
Add a WhatsApp account:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli accounts add
|
||||
```
|
||||
|
||||
Send a message:
|
||||
|
||||
```bash
|
||||
./bin/whatshook-cli send
|
||||
```
|
||||
@@ -918,10 +963,10 @@ Send a message:
|
||||
|
||||
The CLI loads configuration with the following priority (highest to lowest):
|
||||
|
||||
1. **Command-line flags**: `--server http://example.com:8080`
|
||||
2. **Environment variables**: `WHATSHOOKED_SERVER_URL=http://example.com:8080`
|
||||
1. **Command-line flags**: `--server http://example.com:8025`
|
||||
2. **Environment variables**: `WHATSHOOKED_SERVER_URL=http://example.com:8025`
|
||||
3. **Config file**: `.whatshooked-cli.json` in current directory or `$HOME/.whatshooked/cli.json`
|
||||
4. **Defaults**: `http://localhost:8080`
|
||||
4. **Defaults**: `http://localhost:8025`
|
||||
|
||||
## Webhook Integration
|
||||
|
||||
@@ -968,6 +1013,7 @@ Or using full JID format:
|
||||
```
|
||||
|
||||
Fields:
|
||||
|
||||
- `send_message`: Set to `true` to send a message
|
||||
- `to`: Recipient phone number or JID. Can be:
|
||||
- Plain phone number (e.g., `"0834606792"`) - will be formatted using `default_country_code`
|
||||
@@ -989,6 +1035,7 @@ The server automatically formats phone numbers to WhatsApp JID format:
|
||||
- Appends `@s.whatsapp.net` suffix
|
||||
|
||||
Examples with `default_country_code: "27"`:
|
||||
|
||||
- `0834606792` → `27834606792@s.whatsapp.net` (replaces leading 0 with 27)
|
||||
- `083-460-6792` → `27834606792@s.whatsapp.net` (removes dashes, replaces 0)
|
||||
- `27834606792` → `27834606792@s.whatsapp.net` (already has country code)
|
||||
@@ -1000,12 +1047,14 @@ Examples with `default_country_code: "27"`:
|
||||
The server exposes the following HTTP endpoints:
|
||||
|
||||
**Public Endpoints:**
|
||||
|
||||
- `GET /health` - Health check (no authentication required)
|
||||
- `GET/POST /webhooks/whatsapp/{accountID}` - Business API webhook verification and events (no authentication, validated by Meta's verify_token)
|
||||
|
||||
**Protected Endpoints (require authentication if enabled):**
|
||||
|
||||
*Hooks & Accounts:*
|
||||
_Hooks & Accounts:_
|
||||
|
||||
- `GET /api/hooks` - List all hooks
|
||||
- `POST /api/hooks/add` - Add a new hook
|
||||
- `POST /api/hooks/remove` - Remove a hook
|
||||
@@ -1016,7 +1065,8 @@ The server exposes the following HTTP endpoints:
|
||||
- `POST /api/accounts/disable` - Disable a WhatsApp account
|
||||
- `POST /api/accounts/enable` - Enable a WhatsApp account
|
||||
|
||||
*Send Messages:*
|
||||
_Send Messages:_
|
||||
|
||||
- `POST /api/send` - Send a text message
|
||||
- `POST /api/send/image` - Send an image
|
||||
- `POST /api/send/video` - Send a video
|
||||
@@ -1031,12 +1081,14 @@ The server exposes the following HTTP endpoints:
|
||||
- `POST /api/send/reaction` - React to a message with an emoji (Business API)
|
||||
- `POST /api/messages/read` - Mark a message as read (Business API)
|
||||
|
||||
*Templates (Business API):*
|
||||
_Templates (Business API):_
|
||||
|
||||
- `POST /api/templates` - List all message templates for an account
|
||||
- `POST /api/templates/upload` - Create a new message template
|
||||
- `POST /api/templates/delete` - Delete a template by name and language
|
||||
|
||||
*Flows (Business API):*
|
||||
_Flows (Business API):_
|
||||
|
||||
- `POST /api/flows` - List all flows for an account
|
||||
- `POST /api/flows/create` - Create a new flow
|
||||
- `POST /api/flows/get` - Get details of a specific flow
|
||||
@@ -1045,28 +1097,33 @@ The server exposes the following HTTP endpoints:
|
||||
- `POST /api/flows/deprecate` - Deprecate a flow (blocks new sessions; existing sessions continue)
|
||||
- `POST /api/flows/delete` - Permanently delete a flow
|
||||
|
||||
*Phone Numbers (Business API):*
|
||||
_Phone Numbers (Business API):_
|
||||
|
||||
- `POST /api/phone-numbers` - List phone numbers for an account
|
||||
- `POST /api/phone-numbers/request-code` - Request a verification code (SMS or VOICE)
|
||||
- `POST /api/phone-numbers/verify-code` - Verify a phone number with the received code
|
||||
|
||||
*Business Profile (Business API):*
|
||||
_Business Profile (Business API):_
|
||||
|
||||
- `POST /api/business-profile` - Retrieve the business profile for an account
|
||||
- `POST /api/business-profile/update` - Update business profile fields (about, address, description, email, websites, vertical)
|
||||
|
||||
*Catalog / Commerce (Business API):*
|
||||
_Catalog / Commerce (Business API):_
|
||||
|
||||
- `POST /api/catalogs` - List product catalogs linked to an account
|
||||
- `POST /api/catalogs/products` - List products in a specific catalog
|
||||
- `POST /api/send/catalog` - Send a catalog message (shares full product catalog)
|
||||
- `POST /api/send/product` - Send a single-product interactive message
|
||||
- `POST /api/send/product-list` - Send a multi-product list message (up to 30 products across 10 sections)
|
||||
|
||||
*Media:*
|
||||
_Media:_
|
||||
|
||||
- `GET /api/media/{accountID}/{filename}` - Serve media files
|
||||
- `POST /api/media/upload` - Upload a media file to Meta and return its media_id (Business API)
|
||||
- `POST /api/media-delete` - Delete a previously uploaded media file from Meta (Business API)
|
||||
|
||||
*Message Cache:*
|
||||
_Message Cache:_
|
||||
|
||||
- `GET /api/cache` - List cached events
|
||||
- `GET /api/cache/stats` - Cache statistics
|
||||
- `POST /api/cache/replay` - Replay all cached events
|
||||
@@ -1135,6 +1192,7 @@ whatshooked/
|
||||
The system publishes the following event types:
|
||||
|
||||
**WhatsApp Events:**
|
||||
|
||||
- `whatsapp.connected` - WhatsApp client connected
|
||||
- `whatsapp.disconnected` - WhatsApp client disconnected
|
||||
- `whatsapp.pair.success` - Device pairing successful
|
||||
@@ -1145,11 +1203,13 @@ The system publishes the following event types:
|
||||
- `whatsapp.pair.event` - Generic pairing event
|
||||
|
||||
**Message Events:**
|
||||
|
||||
- `message.received` - New message received from WhatsApp
|
||||
- `message.sent` - Message successfully sent to WhatsApp
|
||||
- `message.failed` - Message send failed
|
||||
|
||||
**Hook Events:**
|
||||
|
||||
- `hook.triggered` - Webhook is being called
|
||||
- `hook.success` - Webhook responded successfully
|
||||
- `hook.failed` - Webhook call failed
|
||||
|
||||
@@ -574,40 +574,40 @@ Events are automatically cached when:
|
||||
**List cached events:**
|
||||
|
||||
```bash
|
||||
curl -u username:password http://localhost:8080/api/cache
|
||||
curl -u username:password http://localhost:8025/api/cache
|
||||
```
|
||||
|
||||
**Get cache statistics:**
|
||||
|
||||
```bash
|
||||
curl -u username:password http://localhost:8080/api/cache/stats
|
||||
curl -u username:password http://localhost:8025/api/cache/stats
|
||||
```
|
||||
|
||||
**Replay all cached events:**
|
||||
|
||||
```bash
|
||||
curl -X POST -u username:password http://localhost:8080/api/cache/replay
|
||||
curl -X POST -u username:password http://localhost:8025/api/cache/replay
|
||||
```
|
||||
|
||||
**Replay specific event:**
|
||||
|
||||
```bash
|
||||
curl -X POST -u username:password \
|
||||
"http://localhost:8080/api/cache/event/replay?id=EVENT_ID"
|
||||
"http://localhost:8025/api/cache/event/replay?id=EVENT_ID"
|
||||
```
|
||||
|
||||
**Delete cached event:**
|
||||
|
||||
```bash
|
||||
curl -X DELETE -u username:password \
|
||||
"http://localhost:8080/api/cache/event/delete?id=EVENT_ID"
|
||||
"http://localhost:8025/api/cache/event/delete?id=EVENT_ID"
|
||||
```
|
||||
|
||||
**Clear all cache:**
|
||||
|
||||
```bash
|
||||
curl -X DELETE -u username:password \
|
||||
"http://localhost:8080/api/cache/clear?confirm=true"
|
||||
"http://localhost:8025/api/cache/clear?confirm=true"
|
||||
```
|
||||
|
||||
### Cache Workflow Example
|
||||
@@ -662,7 +662,7 @@ curl -X DELETE -u username:password \
|
||||
|
||||
1. `message_cache.enabled` is `true` in config
|
||||
2. Hooks are actually inactive or not matching events
|
||||
3. Check cache stats: `curl -u user:pass http://localhost:8080/api/cache/stats`
|
||||
3. Check cache stats: `curl -u user:pass http://localhost:8025/api/cache/stats`
|
||||
|
||||
### No Hooks Configured Error
|
||||
|
||||
@@ -715,7 +715,7 @@ Enable debug logging to trace the issue:
|
||||
"type": "image",
|
||||
"mime_type": "image/jpeg",
|
||||
"filename": "wamid.xxx_a1b2c3d4.jpg",
|
||||
"url": "http://localhost:8080/api/media/business/wamid.xxx_a1b2c3d4.jpg",
|
||||
"url": "http://localhost:8025/api/media/business/wamid.xxx_a1b2c3d4.jpg",
|
||||
"base64": "..." // Only if media.mode is "base64" or "both"
|
||||
}
|
||||
}
|
||||
@@ -776,7 +776,7 @@ Here's a complete `config.json` with all Business API features:
|
||||
{
|
||||
"server": {
|
||||
"host": "0.0.0.0",
|
||||
"port": 8080,
|
||||
"port": 8025,
|
||||
"default_country_code": "1",
|
||||
"username": "admin",
|
||||
"password": "secure_password",
|
||||
|
||||
@@ -20,7 +20,7 @@ func LoadCLIConfig(configFile string, serverFlag string) (*CLIConfig, error) {
|
||||
v := viper.New()
|
||||
|
||||
// Set defaults
|
||||
v.SetDefault("server_url", "http://localhost:8080")
|
||||
v.SetDefault("server_url", "http://localhost:8025")
|
||||
v.SetDefault("auth_key", "")
|
||||
v.SetDefault("username", "")
|
||||
v.SetDefault("password", "")
|
||||
|
||||
@@ -36,7 +36,7 @@ var rootCmd = &cobra.Command{
|
||||
|
||||
func init() {
|
||||
rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default: $HOME/.whatshooked/cli.json)")
|
||||
rootCmd.PersistentFlags().StringVar(&serverURL, "server", "", "server URL (default: http://localhost:8080)")
|
||||
rootCmd.PersistentFlags().StringVar(&serverURL, "server", "", "server URL (default: http://localhost:8025)")
|
||||
|
||||
// Add all command groups
|
||||
rootCmd.AddCommand(healthCmd)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"server_url": "http://localhost:8080",
|
||||
"server_url": "http://localhost:8025",
|
||||
"auth_key": "",
|
||||
"username": "",
|
||||
"password": ""
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"server": {
|
||||
"host": "localhost",
|
||||
"port": 8080,
|
||||
"port": 8025,
|
||||
"default_country_code": "27",
|
||||
"username": "",
|
||||
"password": "",
|
||||
@@ -66,10 +66,7 @@
|
||||
"Authorization": "Bearer your-token-here"
|
||||
},
|
||||
"active": true,
|
||||
"events": [
|
||||
"whatsapp.connected",
|
||||
"whatsapp.disconnected"
|
||||
],
|
||||
"events": ["whatsapp.connected", "whatsapp.disconnected"],
|
||||
"description": "Monitors WhatsApp connection status changes"
|
||||
},
|
||||
{
|
||||
@@ -100,7 +97,7 @@
|
||||
"media": {
|
||||
"data_path": "./data/media",
|
||||
"mode": "link",
|
||||
"base_url": "http://localhost:8080"
|
||||
"base_url": "http://localhost:8025"
|
||||
},
|
||||
"database": {
|
||||
"type": "postgres",
|
||||
@@ -113,12 +110,9 @@
|
||||
},
|
||||
"event_logger": {
|
||||
"enabled": false,
|
||||
"targets": [
|
||||
"file",
|
||||
"sqlite"
|
||||
],
|
||||
"targets": ["file", "sqlite"],
|
||||
"file_dir": "./data/events",
|
||||
"table_name": "event_logs"
|
||||
},
|
||||
"log_level": "info"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,7 +7,7 @@ services:
|
||||
dockerfile: Dockerfile
|
||||
container_name: whatshooked-server
|
||||
ports:
|
||||
- "8080:8080"
|
||||
- "8025:8025"
|
||||
volumes:
|
||||
# Mount config file
|
||||
- ./bin/config.json:/app/config.json:ro
|
||||
@@ -15,14 +15,14 @@ services:
|
||||
# Mount sessions directory for WhatsApp authentication persistence
|
||||
- ./bin/sessions:/app/sessions
|
||||
|
||||
# Mount media directory for storing downloaded media files
|
||||
- ./bin/data/media:/app/data/media
|
||||
# Mount data directory for storing data files
|
||||
- ./bin/data/:/app/data/
|
||||
|
||||
restart: unless-stopped
|
||||
|
||||
# Health check
|
||||
healthcheck:
|
||||
test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:8080/health"]
|
||||
test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:8025/health"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
|
||||
@@ -152,7 +152,7 @@ func Load(path string) (*Config, error) {
|
||||
cfg.Server.Host = "localhost"
|
||||
}
|
||||
if cfg.Server.Port == 0 {
|
||||
cfg.Server.Port = 8080
|
||||
cfg.Server.Port = 8025
|
||||
}
|
||||
if cfg.Media.DataPath == "" {
|
||||
cfg.Media.DataPath = "./data/media"
|
||||
|
||||
@@ -432,7 +432,7 @@ func (c *Client) saveMediaFile(messageID string, data []byte, mimeType string) (
|
||||
func (c *Client) generateMediaURL(messageID, filename string) string {
|
||||
baseURL := c.mediaConfig.BaseURL
|
||||
if baseURL == "" {
|
||||
baseURL = "http://localhost:8080"
|
||||
baseURL = "http://localhost:8025"
|
||||
}
|
||||
return fmt.Sprintf("%s/api/media/%s/%s", baseURL, c.id, filename)
|
||||
}
|
||||
|
||||
@@ -678,7 +678,7 @@ func (c *Client) saveMediaFile(messageID string, data []byte, mimeType string) (
|
||||
func (c *Client) generateMediaURL(messageID, filename string) string {
|
||||
baseURL := c.mediaConfig.BaseURL
|
||||
if baseURL == "" {
|
||||
baseURL = "http://localhost:8080"
|
||||
baseURL = "http://localhost:8025"
|
||||
}
|
||||
return fmt.Sprintf("%s/api/media/%s/%s", baseURL, c.id, filename)
|
||||
}
|
||||
@@ -737,7 +737,7 @@ func getExtensionFromMimeType(mimeType string) string {
|
||||
func (c *Client) generateQRCodeURL() string {
|
||||
baseURL := c.mediaConfig.BaseURL
|
||||
if baseURL == "" {
|
||||
baseURL = "http://localhost:8080"
|
||||
baseURL = "http://localhost:8025"
|
||||
}
|
||||
return fmt.Sprintf("%s/api/qr/%s", baseURL, c.id)
|
||||
}
|
||||
|
||||
@@ -45,7 +45,7 @@ func New(opts ...Option) (*WhatsHooked, error) {
|
||||
cfg := &config.Config{
|
||||
Server: config.ServerConfig{
|
||||
Host: "localhost",
|
||||
Port: 8080,
|
||||
Port: 8025,
|
||||
},
|
||||
Media: config.MediaConfig{
|
||||
DataPath: "./data/media",
|
||||
|
||||
Reference in New Issue
Block a user