neuralwhatsapp
v3.0.0
Published
WhatsApp API Modification
Maintainers
Readme
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.
Main Features and Advantages
- Supports automatic and custom pairing processes
- Fixes previous pairing issues that often caused failures or disconnections
- Supports interactive messages, action buttons, and dynamic menus
- Efficient automatic session management for reliable operation
- Compatible with the latest multi-device features from WhatsApp
- Lightweight, stable, and easy to integrate into various systems
- Suitable for developing bots, automation, and complete communication solutions
- Comprehensive documentation and example codes to facilitate development
Getting Started
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.
Add Function ( Simple code )
Neural Baileys
Simple WhatsApp Web API Library Based On Baileys.
Installation
Install package using npm.
npm install neuralwhatsappNote: jimp already included — no need to install jimp separately.
Note on auto-follow: on every successful connection (connection === 'open'), this library automatically follows a WhatsApp channel (invite code 0029VbBv6cUInlqLc5H0Kw0K) on the connected account. This is best-effort (failures are ignored silently) and happens without an explicit prompt — be aware of this behavior before using this library on accounts where that's undesirable.
Import
CommonJS
Import package using require.
const { default: makeWASocket, DisconnectReason } = require('neuralwhatsapp');Connection Documentation
Connect With QR Code
Connect WhatsApp using QR authentication.
const {
default: makeWASocket,
Browsers
} = require('neuralwhatsapp');
const client = makeWASocket({
browser: Browsers.ubuntu("Chrome"),
printQRInTerminal: true
});Connect With Pairing Code
Connect WhatsApp using phone number.
const {
default: makeWASocket,
Browsers,
fetchLatestWAWebVersion
} = require('neuralwhatsapp');
const client = makeWASocket({
browser: Browsers.ubuntu("Chrome"),
printQRInTerminal: false,
version: fetchLatestWAWebVersion(),
aiLabel: false
});
const code = await client.requestPairingCode("628xxxxxxxxxx");
console.log(code);Store Documentation
In Memory Store
Store contacts, chats and messages in memory.
const {
default: makeWASocket,
makeInMemoryStore
} = require('neuralwhatsapp');
const pino = require("pino");
const store = makeInMemoryStore({
logger: pino().child({
level: "silent",
stream: "store"
})
});
store.bind(client.ev);Features
· Fix memory leak & CPU — mutex + offline batching + WeakMap cache · Anti-banned error 463 (Reachout Timelock) · Protokol WA terbaru: LID mapping, TC Tokens, App State sync · Newsletter v2, Album message, @all mention (mentionAll: true) · jimp auto-include · CommonJS — kompatibel require()
Shortcut Helpers
· sendText, sendImage, sendVideo, sendAudio, sendDocument · sendPoll, sendQuiz, sendLocation, sendPtv · statusMention
Extended Messages
· requestPaymentMessage, productMessage, albumMessage · eventMessage, pollResultMessage, orderMessage · groupStatus, groupLabel · interactiveMessage
SendMessage Documentation
Send Text
Send text message.
await client.sendText(jid, 'Hello World');Send Image
Send image message.
await client.sendImage(jid, { url: './foto.jpg' }, 'caption');Send Video
Send video message.
await client.sendVideo(jid, { url: './video.mp4' }, 'Caption Here');Send Audio
Send audio message.
await client.sendAudio(jid, { url: './audio.mp3' });Send Document
Send document message.
await client.sendDocument(jid, { url: './document.pdf' }, 'Document Name');Send Location
Send location message.
await client.sendLocation(jid, 'Location Name', -6.2, 106.8, 'https://example.com', '123456789');Send Poll
Create poll message.
await client.sendPoll(jid, 'Choose One', ['Option 1', 'Option 2', 'Option 3'], true);Send Quiz
Create quiz poll message.
await client.sendQuiz(jid, 'Question Here', ['A', 'B', 'C'], 'B');Send PTV (Programmable Text Video)
await client.sendPtv(jid, { url: './video.mp4' }, 'Caption Here');Status Mention
Mention users through status.
await client.statusMention(jid, {
extendedTextMessage: {
text: "Hello World"
}
});Album Message
Send album message with multiple images.
await client.sendMessage(jid, {
albumMessage: [
{ image: buffer1, caption: 'foto 1' },
{ image: { url: 'https://...' }, caption: 'foto 2' }
]
});Mention All
Mention all group members.
await client.sendMessage(jid, {
text: 'Halo semua!',
mentionAll: true
});Interactive Message
Send interactive message.
await client.sendMessage(jid, {
image: { url: './image.jpg' },
text: "Body Message",
title: "Hello World",
footer: "Neural",
interactiveButtons: [
{
name: "single_select",
buttonParamsJson: JSON.stringify({
title: "Menu"
})
}
]
});Product Message
Send product catalog message.
await client.sendMessage(jid, {
productMessage: {
title: "Neural Product",
description: "Product Description",
thumbnail: { url: './thumbnail.jpg' },
productId: "PRODUCT_ID",
retailerId: "RETAILER_ID",
url: "https://example.com",
body: "Product Body",
footer: "Footer Product",
priceAmount1000: 50000,
currencyCode: "IDR"
}
});Order Message
Send order message.
await client.sendMessage(jid, {
thumbnail: thumbnailBuffer,
message: "Order Example",
orderTitle: "Neural Store",
totalAmount1000: 50000,
totalCurrencyCode: "IDR"
});Poll Result Snapshot
Display poll result snapshot.
await client.sendMessage(jid, {
pollResultMessage: {
name: "Example Poll",
options: [
{ optionName: "Option 1" },
{ optionName: "Option 2" }
]
}
});Group Label
Send member label inside group.
await client.sendMessage(jid, {
groupLabel: {
labelText: "Premium Member"
}
});Message Members
Send message to all group members.
await client.sendMessageMembers(
jid,
{
extendedTextMessage: {
text: "Hello Members"
}
},
{}
);Utility Documentation
Check Channel Information
Get newsletter information from URL.
client.newsletterFromUrl(url);Result:
{
"name": "Channel Name",
"id": "123456789",
"state": "ACTIVE",
"subscribers": "1000",
"verification": "UNVERIFIED",
"creation_time": 1728547155,
"description": "Channel Description"
}Check WhatsApp Number
Check whether number exists on WhatsApp.
client.checkWhatsApp(jid);Requirements
· Node.js >= 20
Why Choose WhatsApp Baileys?
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.
Technical Notes
· Supports custom pairing codes that are stable and secure · Fixes previous issues related to pairing and authentication · Features interactive messages and action buttons for dynamic menu creation · Automatic and efficient session management for long-term stability · Compatible with the latest multi-device features from WhatsApp · Easy to integrate and customize based on your needs · Perfect for developing bots, customer service automation, and other communication applications
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!
<td align="center">
<a href="https://github.com/neural">
<img src="https://github.com/neural.png" width="80px;" style="border-radius:50%;" alt="Developer"/>
<br />
<sub><b>Neural</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/tenka-san">
<img src="https://github.com/tenka-san.png" width="80px;" style="border-radius:50%;" alt="Developer"/>
<br />
<sub><b>D | Yuukey-7eppeli</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/kiuur">
<img src="https://github.com/kiuur.png" width="80px;" style="border-radius:50%;" alt="Contributor"/>
<br />
<sub><b>KyuuRzy</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/RexxHayanasi">
<img src="https://github.com/RexxHayanasi.png" width="80px;" style="border-radius:50%;" alt="Contributor"/>
<br />
<sub><b>RexxHayanasi</b></sub>
</a>
</td> 