@alannxd/baileys
Advanced tools
A WebSockets library for interacting with WhatsApp Web — fork of Baileys with extra socket layers (communities, interop, privacy, GraphQL) and special message helpers.
WhatsApp Baileys is an open-source library designed to help developers build automation solutions and integrations with WhatsApp efficiently and directly. Using websocket technology without the need for a browser, this library supports a wide range of features such as message management, chat handling, group administration, as well as interactive messages and action buttons for a more dynamic user experience.
Actively developed and maintained, baileys continuously receives updates to enhance stability and performance. One of the main focuses is to improve the pairing and authentication processes to be more stable and secure. Pairing features can be customized with your own codes, making the process more reliable and less prone to interruptions.
This library is highly suitable for building business bots, chat automation systems, customer service solutions, and various other communication automation applications that require high stability and comprehensive features. With a lightweight and modular design, baileys is easy to integrate into different systems and platforms.
Begin by installing the library via your preferred package manager, then follow the provided configuration guide. You can also utilize the ready-made example codes to understand how the features work. Use session storage and interactive messaging features to build complete, stable solutions tailored to your business or project needs.
sharp or jimp (image processing), link-preview-js (link previews), audio-decode (audio waveform)npm install @alannxd/baileys
Or alias it as baileys / @whiskeysockets/baileys in your package.json:
{
"dependencies": {
"@alannxd/baileys": "latest"
}
}
import makeWASocket from '@alannxd/baileys'
// or, CommonJS:
const { default: makeWASocket } = require('@alannxd/baileys')
import makeWASocket, { Browsers, useMultiFileAuthState } from '@alannxd/baileys'
const { state, saveCreds } = await useMultiFileAuthState('auth_info')
const client = makeWASocket({
browser: Browsers.ubuntu('Chrome'),
printQRInTerminal: true,
auth: state
})
client.ev.on('creds.update', saveCreds)
import makeWASocket, { Browsers, fetchLatestWAWebVersion, useMultiFileAuthState } from '@alannxd/baileys'
const { state, saveCreds } = await useMultiFileAuthState('auth_info')
const { version } = await fetchLatestWAWebVersion()
const client = makeWASocket({
browser: Browsers.ubuntu('Chrome'),
printQRInTerminal: false,
version,
auth: state
})
client.ev.on('creds.update', saveCreds)
if (!client.authState?.creds?.registered) {
const phoneNumber = '628XXXXXXXXXX' // international format, no '+'
const code = await client.requestPairingCode(phoneNumber)
// custom pairing code (8 characters):
// const code = await client.requestPairingCode(phoneNumber, 'YYYYYYYY')
console.log('Pairing code:', code)
}
makeInMemoryStore builds a local cache of chats/contacts/messages, which
Baileys does not persist automatically by default.
import makeWASocket, { makeInMemoryStore } from '@alannxd/baileys'
import pino from 'pino'
const store = makeInMemoryStore({
logger: pino().child({ level: 'silent', stream: 'store' })
})
const client = makeWASocket({ /* ...other options */ })
store.bind(client.ev)
client.ev.on('contacts.upsert', () => {
console.log('New contact:', Object.values(store.contacts))
})
Need a persistent store (Redis, etc.)? Use makeCacheManagerStore — see API Reference.
makeInMemoryStore can read/write its state to a local JSON file, so it
survives restarts without needing an external database:
const store = makeInMemoryStore({ /* ... */ })
// load once on startup, then auto-save every 10s
const stopAutoSave = store.writeToFileInterval('./store.json')
process.on('SIGINT', () => {
stopAutoSave()
process.exit(0)
})
Or handle it manually with store.readFromFile(path) / store.writeToFile(path) — see API Reference for details.
// relayMessage — send a raw message object, bypassing the sendMessage pipeline
await client.relayMessage(jid, { conversation: 'Hello from Baileys' }, {})
// sendMessage — the common way to send a message
await client.sendMessage(jid, { text: 'Hello from Baileys' })
All the sendX functions below are shortcuts on top of sendMessage.
await client.sendText(jid, 'Hi!', { contextInfo: { mentionedJid: [jid] } })
await client.sendImage(jid, { url: './photo.jpg' }, 'image caption')
await client.sendVideo(jid, { url: './clip.mp4' }, 'video caption')
await client.sendAudio(jid, { url: './clip.mp3' })
await client.sendLocation(jid, 'Location name', -6.2, 106.8, 'https://maps.example', '1234567890')
await client.sendPoll(jid, 'Pick one', ['Option 1', 'Option 2', 'Option 3'], /* multiSelect */ true)
await client.sendQuiz(jid, 'Correct answer?', ['1', '2', '3'], /* correctIndex */ '2')
Handled internally by the Socket/luxu.js helper, invoked automatically via
sendMessage/relayMessage whenever the content includes one of the fields below.
// Product message (catalog)
await client.relayMessage(jid, {
productMessage: {
title: 'Product Name',
description: 'Product description',
thumbnail: { url: './product.jpg' },
productId: 'PRODUCT_ID',
retailerId: 'RETAILER_ID',
url: 'https://store.example/product',
body: 'Body text',
footer: 'Footer text',
priceAmount1000: 72502, // price x 1000
currencyCode: 'IDR'
}
}, {})
// Order message
await client.sendMessage(jid, {
thumbnail: fs.readFileSync('./thumb.jpg'),
message: 'Order details',
orderTitle: 'Store Name',
totalAmount1000: 72502,
totalCurrencyCode: 'IDR'
}, { quoted: m })
// Poll result snapshot (usually from a newsletter)
await client.sendMessage(jid, {
pollResultMessage: {
name: 'Poll Title',
options: [{ optionName: 'Option 1' }, { optionName: 'Option 2' }],
newsletter: { newsletterName: 'Newsletter Name', newsletterJid: '1234567890@newsletter' }
}
})
// Interactive message (button)
await client.sendMessage(jid, {
image: { url: './banner.jpg' },
text: 'Message body',
title: 'Title',
footer: 'Footer',
interactiveButtons: [{
name: 'cta_url',
buttonParamsJson: JSON.stringify({ display_text: 'Visit', url: 'https://example.com' })
}]
})
// Group member label
await client.sendMessage(jid, {
groupLabel: { labelText: 'Admin' }
})
// Broadcast to specific group members
await client.sendMessageMembers(jid, { extendedTextMessage: { text: 'Announcement' } }, {})
Fields like
senderandparticipant: truein the second argument ofsendMessage/relayMessageare used for group-participant send context — seedocs/API.mdfor details on each socket layer.
All interaction happens through events on client.ev:
client.ev.on('connection.update', ({ connection, lastDisconnect }) => {
console.log('Connection status:', connection)
})
client.ev.on('messages.upsert', ({ messages, type }) => {
for (const m of messages) {
console.log('Incoming message:', m.message)
}
})
client.ev.on('creds.update', saveCreds)
See the full list of events in lib/Types/Events.js.
Ready-to-run scripts live in examples/:
examples/qr-login.js — QR login with auto-reconnectexamples/pairing-code.js — pairing code loginexamples/store-usage.js — using the in-memory store.d.ts for lib/ — only WAProto ships TypeScript types. Full autocomplete requires the TS source, which isn't included in this build.imported, an ASCII art banner and promotional link are printed to stdout. In production or multi-instance setups this becomes log noise.optionHash for per-option image polls is not implemented — it appears to require further reverse-engineering at the WhatsApp APK level.docs/API.md for other technical notes.Because this library offers high stability, full features, and an actively improved pairing process. It is ideal for developers aiming to create professional and secure WhatsApp automation solutions. Support for the latest WhatsApp features ensures compatibility with platform updates.
For complete documentation, installation guides, and implementation examples, please visit the official repository and community forums. We continually update and improve this library to meet the needs of developers and users of modern WhatsApp automation solutions.
Thank you for choosing WhatsApp Baileys as your WhatsApp automation solution!
For questions, support, or collaboration, feel free to contact the developer:
Thanks to the following awesome contributors who help improve this project
AlannXD |
Xaz zepysK |
KyuuRzy |
Xcoursed |
FAQs
security holding package
The npm package @alannxd/baileys receives a total of 0 weekly downloads. As such, @alannxd/baileys popularity was classified as not popular.
We found that @alannxd/baileys demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Security News
/Application Security
A practical guide to securing GitHub Actions against supply chain attacks, covering malicious pull requests, credential theft, dependency risks, and release pipelines.
Security News
Composer 2.11 adds dependency cooldowns, joining package managers that delay new releases to reduce supply chain risks while allowing urgent security updates.
Threat Research
/Security News
Cursor removed a malicious Claude Code 2.1.313 extension from its marketplace. Socket examines registry records and the initial claims about its distribution.