Baileys API

Baileys is a simple, fast and easy to use WhatsApp Web API written in TypeScript. It is designed to be simple to use and is optimized for usage in Node.js.

An implementation of @WhiskeySockets/Baileys as a simple REST API with multiple device support

Project continued from @ookamiiixd/baileys-api

Requirements

• NodeJS version 18.19.0 or higher (Recommended version 20 and above)
• Prisma supported databases. Tested on MySQL and PostgreSQL

Installation

1. Download latest release. If you want to skip the build step, you can download the release (file with the baileys-api.tgz name pattern) from the release page
2. Enter to the project directory
3. Install the dependencies

npm install

4. Build the project using the build script

npm run build

You can skip this part if you're using the prebuilt one from the release page

Setup

1. Copy the .env.example file and rename it into .env, then update your connection url in the DATABASE_URL field
2. Update your provider in the prisma/schema.prisma file if you're using database other than MySQL
3. Run your migration

npx prisma migrate (dev|deploy)

or push the schema

npx prisma db push

Don't forget to always re-run those whenever there's a change on the prisma/schema.prisma file

.env Configurations

# Listening Port HTTP and Socket.io
PORT="3000"

# Project Mode (development|production)
NODE_ENV="development"

# Global URL Webhook
URL_WEBHOOK="http://localhost:3000/webhook"

# Enable Webhook
ENABLE_WEBHOOK="true"

# Enable websocket
ENABLE_WEBSOCKET="true"

# Name browser bot
BOT_NAME="Whatsapp Bot"

# Database Connection URL
DATABASE_URL="mysql://root:@localhost:3306/baileys_api"

# Pino Logger Level
LOG_LEVEL="debug"

# Reconnect Interval (in Milliseconds)
RECONNECT_INTERVAL="5000"

# Maximum Reconnect Attempts
MAX_RECONNECT_RETRIES="5"

# Maximum SSE QR Generation Attempts
SSE_MAX_QR_GENERATION="10"

# Name session config
SESSION_CONFIG_ID="session-config"

# API Key (for Authorization Header and Socket.io Token)
API_KEY="a6bc226axxxxxxxxxxxxxx"

Usage

1. Make sure you have completed the Installation and Setup step
2. You can then start the app using the dev for development and start script for production

# Development
npm run dev

# Production
npm run start

1. Now the endpoint should be available according to your environment variables configuration. Default is at http://localhost:3000

API Docs

The API Documentation can fork Postman Collection in your workspace Postman

Notes

• I only provide a simple authentication method, please modify according to your own needs.

Notice

This project is intended for learning purpose only, don't use it for spamming or any activities that's prohibited by WhatsApp