balmacefa/whatsapp_web_client_api repository overview

⁠WhatsApp Web Client API

A Dockerized Node.js wrapper around wwebjs⁠ to expose a simple and secure REST API for managing WhatsApp sessions and interactions.

repo: https://github.com/balmacefa/whatsapp_web_client_api⁠

⁠🚀 Features

SWAGGER UI WEEBHOOK NOTIFICATIONS

• Client Management

  • Create, list, delete WhatsApp client instances
  • Get client status
  • Update webhook URLs for notifications

• Messaging

  • Send text messages and media (images, videos, documents)
  • Send audio files as voice messages
  • React to existing messages

• QR Code Authentication

  • Retrieve QR codes in base64 or PNG format for new sessions

• Contacts & Chats

  • Fetch contact list for a client
  • Retrieve chat history with a contact

• Security

  • API key authentication using a Bearer token in the Authorization header

• Validation

  • Input validation using celebrate and Joi for body and parameter checks

• Documentation

  • Built-in Swagger (OpenAPI) annotations for auto-generated, interactive API docs

Run this image using:

Pull version 1.0.5

docker pull balmacefa/whatsapp_web_client_api:1.0.5

Create a pod for version 1.0.5

docker run -p 3000:3000 \
  -e PORT=3000 \
  -e API_KEYS=supersecretkey \
  -e PROD_HOST=http://localhost:3000 \
  -v ~/whatsapp-data:/app/data \
  balmacefa/whatsapp_web_client_api:1.0.5

Pull latest

docker pull balmacefa/whatsapp_web_client_api:latest

Run latest

docker run -p 3000:3000 -e PORT=3000 -e API_KEYS=supersecretkey -e PROD_HOST=http://localhost:3000 balmacefa/whatsapp_web_client_api:latest