Skip to main content

⚡ Quick Start

This guide will help you get started quickly with Whinself, your self-hosted WhatsApp API.

Note: Whinself is an unofficial third-party tool and is not affiliated with WhatsApp or Meta Platforms, Inc.

Prerequisites​

  • Docker installed on your system
  • A WhatsApp account
  • Basic knowledge of terminal commands

Step 1: Create Configuration File​

Create a directory for Whinself:

mkdir -p ~/whinself
cd ~/whinself

Create a config.json file:

{
  "slotid": "my-whatsapp-bot",
  "nrurl": "https://webhook.site/your-unique-id",
  "portin": 9001,
  "devicename": "My WhatsApp Bot",
  "logstdout": true
}

Replace the nrurl with your webhook URL or use a service like webhook.site for testing.

Step 2: Run the Docker Container​

docker run -d \
  --name whatsapp-bot \
  --restart unless-stopped \
  -p 9001:9001 \
  -v $(pwd)/config.json:/app/config/config.json \
  inutil/whingo:latest

Step 3: Access the Dashboard​

Open a browser and navigate to:

http://localhost:9001

Step 4: Create an Account & Connect​

  1. Register a new account (or login if you already have one)
  2. Click "Subscribe" to activate your free trial (no payment info required)
  3. Scan the QR code with WhatsApp on your phone:
    • Open WhatsApp > Settings > Linked Devices > Link a Device
    • Scan the QR code from the Whinself dashboard

Once connected, the status indicators will turn green and show your connected phone number.

Step 5: Test Sending a Message​

curl -X POST http://localhost:9001/wspout \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hello from Whinself!",
    "jid": "[email protected]"
  }'

Replace 1234567890 with the recipient's phone number (including country code).

What's Next?​

Remember that you're responsible for ensuring your usage complies with WhatsApp's Terms of Service.