API Documentation

Complete reference for WhatsApp Gateway API

info

Public Documentation — Placeholder Values

Ganti placeholder berikut dengan nilai aktual Anda:

{base_url} → URL Node.js server Anda (contoh: http://localhost:3998)

{your_api_key} → API Key dari Client Apps

{device_id} → ID device yang terhubung

Overview

WhatsApp Gateway provides a programmatic interface to send and receive WhatsApp messages. The Node.js server exposes REST API endpoints and real-time Socket.IO events.

Base URL

{base_url}

Authentication Methods

Direct (deviceId)

Pass deviceId in the JSON body. Used for server-internal calls and session management.

API Key (Gateway)

Pass X-API-Key header. Routes through the app's assigned gateway device. No deviceId needed.

Available Features

📱 Device Manager

Create, connect, and manage WhatsApp devices

💬 Messaging

Send text, image, document, and interactive list messages

🤖 Auto Reply Bot

Keyword-based auto-reply rules (exact match or contains)

📢 Broadcast Campaigns

Send bulk messages with delivery tracking

🔌 Webhook

Receive incoming messages via HTTP callbacks

🧠 AI Assistant

AI-powered auto-replies using Groq, OpenRouter, or DeepSeek

🔄 Socket.IO Events

Real-time QR scanning, connection status, and device events

🌐 Gateway Center

Client apps, API key auth, and device routing

Standard Response Format

All REST endpoints return JSON:

{
  "success": true|false,
  "message": "Human-readable description",
  "error": "Error message (only if failed)"
}