baileys-x
Version:
Custom Baileys WhatsApp API
1,630 lines (1,392 loc) • 67.3 kB
Markdown
# <div align='center'>🚀 Baileys-X</div>
<div align="center">
<img src="https://files.catbox.moe/jzwzve.png" />
<a href="https://www.npmjs.com/package/baileys-x">
<img src="https://img.shields.io/npm/v/baileys-x?color=00ff88&label=Version&logo=npm&style=for-the-badge" alt="npm version" />
</a>
<a href="https://www.npmjs.com/package/baileys-x">
<img src="https://img.shields.io/npm/dt/baileys-x?color=ff6b6b&label=Downloads&logo=npm&style=for-the-badge" alt="npm downloads" />
</a>
<a href="https://whatsapp.com/channel/0029VaeRru3ADTOEKPCPom0L">
<img src="https://img.shields.io/badge/WhatsApp-Channel-25D366?logo=whatsapp&logoColor=white&style=for-the-badge" alt="WhatsApp Channel" />
</a>
<img src="https://img.shields.io/badge/Powered%20by-David%20Cyril%20Tech-blue?style=for-the-badge&logo=lightning&logoColor=white" alt="David Cyril Tech" />
</div>
---
<div align="center">
### ⚡ **The Ultimate WhatsApp API Enhancement** ⚡
*Blazing fast • Feature-rich • Developer-friendly*
**Baileys-X** is the next-generation WhatsApp Web API library that pushes the boundaries of what's possible. Built by **David David Cyril Tech** with cutting-edge enhancements and modern features.
</div>
---
## 🎯 Quick Navigation
- [⚠️ Important Notice](#️-important-notice)
- [📦 Installation](#-installation)
- [✨ Revolutionary Features](#-revolutionary-features)
- [🔥 Feature Showcase](#-feature-showcase)
- [📢 Newsletter Management](#-newsletter-management)
- [🔘 Interactive Messages](#-interactive-messages)
- [🖼️ Album Messages](#️-album-messages)
- [🤖 AI Message Icons](#-ai-message-icons)
- [🔑 Custom Pairing](#-custom-pairing)
- [🐛 Issue Reporting](#-issue-reporting)
- [📝 Important Notes](#-important-notes)
---
## ⚠️ Important Notice
**Baileys-X** represents a revolutionary leap forward from the original Baileys library. While the original repository faced challenges and was eventually maintained by [WhiskeySockets](https://github.com/WhiskeySockets), **David Cyril Tech** has completely reimagined the possibilities.
This isn't just a modification—it's a complete evolution that introduces game-changing features and rock-solid performance improvements that weren't even conceptualized in the original codebase.
---
## 📦 Installation
### Quick Start
**Package.json method:**
```json
{
"dependencies": {
"baileys-x": "latest"
}
}
```
**Terminal installation:**
```bash
npm install baileys-x
```
### Import & Usage
```typescript
// ES Modules (Recommended)
import makeWASocket from 'baileys-x'
// CommonJS
const { default: makeWASocket } = require("baileys-x")
```
---
## ✨ Revolutionary Features
<div align="center">
| 🎭 **Feature** | 🔥 **What Makes It Amazing** |
|:---:|:---|
| **💬 Channel Messaging** | Send rich media and text directly to WhatsApp channels with zero limitations |
| **🔘 Interactive UI** | Create stunning button interfaces and interactive messages that work on both Messenger and Business |
| **🖼️ Album Magic** | Send multiple images as beautiful grouped albums - perfect for storytelling |
| **👥 LID Group Support** | Full compatibility with `@lid` group addressing - future-proof your bots |
| **🤖 AI Message Icons** | Add that premium AI touch to your messages with customizable icons |
| **🖼️ HD Profile Pictures** | Upload full-resolution profile pictures without any quality loss |
| **🔑 Custom Pairing Codes** | Create personalized pairing codes that match your brand |
| **🛠️ Clean Libsignal** | Enjoy crystal-clear logs with our refined libsignal implementation |
</div>
> 🚀 **More revolutionary features are cooking in David Cyril Tech's lab!**
---
## 🔥 Feature Showcase
### 📢 Newsletter Management
<details>
<summary>🎯 <strong>Advanced Newsletter Operations</strong></summary>
#### 📊 Get Newsletter Info
```typescript
const metadata = await sock.newsletterMetadata("invite", "xxxxx")
// Alternative method
const metadata = await sock.newsletterMetadata("jid", "abcd@newsletter")
console.log(metadata)
```
#### ✏️ Update Newsletter Details
```typescript
// Update description
await sock.newsletterUpdateDescription("abcd@newsletter", "🔥 New Epic Description")
// Update name
await sock.newsletterUpdateName("abcd@newsletter", "🚀 David Cyril Tech Newsletter")
// Update profile picture
await sock.newsletterUpdatePicture("abcd@newsletter", buffer)
// Remove profile picture
await sock.newsletterRemovePicture("abcd@newsletter")
```
#### 🔔 Notification Control
```typescript
// Mute notifications
await sock.newsletterMute("abcd@newsletter")
// Unmute notifications
await sock.newsletterUnmute("abcd@newsletter")
```
#### 🏗️ Newsletter Lifecycle
```typescript
// Create newsletter
const metadata = await sock.newsletterCreate("🔥 David Cyril Tech Updates")
// Delete newsletter
await sock.newsletterDelete("abcd@newsletter")
// Follow newsletter
await sock.newsletterFollow("abcd@newsletter")
// Unfollow newsletter
await sock.newsletterUnfollow("abcd@newsletter")
```
#### 🎭 Reactions
```typescript
// React to newsletter message
// Extract ID from URL: https://whatsapp.com/channel/xxxxx/175 (175 is the ID)
const messageId = "175"
await sock.newsletterReactMessage("abcd@newsletter", messageId, "🔥")
```
</details>
### 🔘 Interactive Messages
<details>
<summary>🎨 <strong>Next-Gen Interactive UI</strong></summary>
#### 🔥 Text Buttons
```typescript
const buttons = [
{ buttonId: 'fire', buttonText: { displayText: '🔥 Fire' }, type: 1 },
{ buttonId: 'rocket', buttonText: { displayText: '🚀 Rocket' }, type: 1 }
]
const buttonMessage = {
text: "🎯 Choose your power-up!",
footer: '⚡ Powered by David Cyril Tech',
buttons,
headerType: 1
}
await sock.sendMessage(id, buttonMessage, { quoted: null })
```
#### 🖼️ Image Buttons
```typescript
const buttons = [
{ buttonId: 'awesome', buttonText: { displayText: '😎 Awesome' }, type: 1 },
{ buttonId: 'epic', buttonText: { displayText: '🔥 Epic' }, type: 1 }
]
const buttonMessage = {
image: { url: "https://example.com/cyril-tech.jpg" },
caption: "🎨 Interactive image with buttons!",
footer: '🚀 David Cyril Tech Innovation',
buttons,
headerType: 1
}
await sock.sendMessage(id, buttonMessage, { quoted: null })
```
#### 🎬 Video Buttons
```typescript
const buttons = [
{ buttonId: 'play', buttonText: { displayText: '▶️ Play' }, type: 1 },
{ buttonId: 'share', buttonText: { displayText: '📤 Share' }, type: 1 }
]
const buttonMessage = {
video: { url: "https://example.com/cyril-demo.mp4" },
caption: "🎬 Interactive video experience!",
footer: '⚡ David Cyril Tech Media',
buttons,
headerType: 1
}
await sock.sendMessage(id, buttonMessage, { quoted: null })
```
#### 🎭 Advanced Interactive Messages
```typescript
const interactiveButtons = [
{
name: "quick_reply",
buttonParamsJson: JSON.stringify({
display_text: "⚡ Quick Reply",
id: "CYRIL_QUICK"
})
},
{
name: "cta_url",
buttonParamsJson: JSON.stringify({
display_text: "🌐 Visit David Cyril Tech",
url: "https://cyril-tech.com/"
})
},
{
name: "cta_copy",
buttonParamsJson: JSON.stringify({
display_text: "📋 Copy Code",
id: "CYRIL123",
copy_code: "CYRIL123"
})
}
]
const interactiveMessage = {
text: "🔥 Welcome to David Cyril Tech!",
title: "🚀 Interactive Experience",
footer: "⚡ Powered by Baileys-X",
interactiveButtons
}
await sock.sendMessage(id, interactiveMessage, { quoted: null })
```
#### 📋 Interactive Lists
```typescript
const interactiveButtons = [
{
name: "single_select",
buttonParamsJson: JSON.stringify({
title: "🎯 Select Your Option",
sections: [
{
title: "🔥 David Cyril Tech Services",
highlight_label: "⭐ Premium",
rows: [
{
header: "🚀 DEVELOPMENT",
title: "Custom Solutions",
description: "Tailored tech solutions for your needs",
id: "CYRIL_DEV"
},
{
header: "🎨 DESIGN",
title: "UI/UX Excellence",
description: "Beautiful and functional designs",
id: "CYRIL_DESIGN"
}
]
}
]
})
}
];
const interactiveMessage = {
text: "🌟 Choose your David Cyril Tech service!",
title: "🏆 Premium Services",
footer: "⚡ Quality guaranteed",
interactiveButtons
};
await sock.sendMessage(id, interactiveMessage, { quoted: null });
```
</details>
### 🖼️ Album Messages
<details>
<summary>📸 <strong>Stunning Media Albums</strong></summary>
```typescript
// Create beautiful media albums
const media = [
{
image: { url: "https://example.com/cyril-tech-1.jpg" }
},
{
image: await getBuffer("https://example.com/cyril-showcase.jpg")
},
{
video: { url: "https://example.com/cyril-demo.mp4" }
}
]
await sock.sendMessage(id, {
album: media,
caption: "🎨 David Cyril Tech Portfolio - Where Innovation Meets Excellence!"
}, { quoted: null })
```
</details>
### 🤖 AI Message Icons
<details>
<summary>🎭 <strong>AI-Powered Message Enhancement</strong></summary>
```typescript
// Add that premium AI touch to your messages
await sock.sendMessage(id, {
text: "🤖 Hello! I'm powered by David Cyril Tech's AI technology!",
ai: true
});
```
</details>
### 🔑 Custom Pairing
<details>
<summary>🎯 <strong>Branded Pairing Experience</strong></summary>
```typescript
if(usePairingCode && !sock.authState.creds.registered) {
const phoneNumber = await question('📱 Enter your mobile number:\n');
// Create your custom branded pairing code
const customPairingCode = "CYRILTECH";
const code = await sock.requestPairingCode(phoneNumber, customPairingCode);
console.log(`🔑 Your David Cyril Tech Pairing Code: ${code?.match(/.{1,4}/g)?.join('-') || code}`);
}
```
</details>
---
## 🐛 Issue Reporting
Found a bug or have a feature request? **David Cyril Tech** is here to help!
🔗 **[Report Issues Here](https://github.com/DavidCyril1/baileys-x/issues)**
Our team monitors issues 24/7 and provides lightning-fast responses!
---
## 📝 Important Notes
**Baileys-X** maintains full backward compatibility with the original Baileys library while adding revolutionary new features. Everything from the original repository works seamlessly, but now with **David Cyril Tech's** premium enhancements.
**Original Repository:** [WhiskeySockets/Baileys](https://github.com/WhiskeySockets/Baileys)
---
<div align="center">
# Index
- [Connecting Account](#connecting-account)
- [Connect with QR-CODE](#starting-socket-with-qr-code)
- [Connect with Pairing Code](#starting-socket-with-pairing-code)
- [Receive Full History](#receive-full-history)
- [Important Notes About Socket Config](#important-notes-about-socket-config)
- [Caching Group Metadata (Recommended)](#caching-group-metadata-recommended)
- [Improve Retry System & Decrypt Poll Votes](#improve-retry-system--decrypt-poll-votes)
- [Receive Notifications in Whatsapp App](#receive-notifications-in-whatsapp-app)
- [Custom generateMessageID Function](#custom-generatemessageid-function)
- [Save Auth Info](#saving--restoring-sessions)
- [Handling Events](#handling-events)
- [Example to Start](#example-to-start)
- [Decrypt Poll Votes](#decrypt-poll-votes)
- [Summary of Events on First Connection](#summary-of-events-on-first-connection)
- [Implementing a Data Store](#implementing-a-data-store)
- [Whatsapp IDs Explain](#whatsapp-ids-explain)
- [Utility Functions](#utility-functions)
- [Sending Messages](#sending-messages)
- [Non-Media Messages](#non-media-messages)
- [Buttons Message](#buttons-message)
- [Buttons Flow](#buttons-flow)
- [Interactive Message](#interactive-message)
- [Text Message](#text-message)
- [Quote Message](#quote-message-works-with-all-types)
- [Mention User](#mention-user-works-with-most-types)
- [Mention Status](#mention-status)
- [Result Poll From Newsletter](#result-poll-from-newsletter)
- [SendAlbumMessage](#send-album-message)
- [List Message](#list-message)
- [Carousel Message](#carousel-message)
- [Interactive Response](#interactive-response)
- [Request Payment](#request-payment)
- [Event Message](#event-message)
- [Interactive](#interactive)
- [Forward Messages](#forward-messages)
- [Location Message](#location-message)
- [Contact Message](#contact-message)
- [Reaction Message](#reaction-message)
- [Pin Message](#pin-message)
- [Poll Message](#poll-message)
- [Sending with Link Preview](#sending-messages-with-link-previews)
- [Media Messages](#media-messages)
- [Gif Message](#gif-message)
- [Video Message](#video-message)
- [Audio Message](#audio-message)
- [Image Message](#image-message)
- [ViewOnce Message](#view-once-message)
- [Modify Messages](#modify-messages)
- [Delete Messages (for everyone)](#deleting-messages-for-everyone)
- [Edit Messages](#editing-messages)
- [Manipulating Media Messages](#manipulating-media-messages)
- [Thumbnail in Media Messages](#thumbnail-in-media-messages)
- [Downloading Media Messages](#downloading-media-messages)
- [Re-upload Media Message to Whatsapp](#re-upload-media-message-to-whatsapp)
- [Reject Call](#reject-call)
- [Send States in Chat](#send-states-in-chat)
- [Reading Messages](#reading-messages)
- [Update Presence](#update-presence)
- [Modifying Chats](#modifying-chats)
- [Archive a Chat](#archive-a-chat)
- [Mute/Unmute a Chat](#muteunmute-a-chat)
- [Mark a Chat Read/Unread](#mark-a-chat-readunread)
- [Delete a Message for Me](#delete-a-message-for-me)
- [Delete a Chat](#delete-a-chat)
- [Star/Unstar a Message](#starunstar-a-message)
- [Disappearing Messages](#disappearing-messages)
- [User Querys](#user-querys)
- [Check If ID Exists in Whatsapp](#check-if-id-exists-in-whatsapp)
- [Query Chat History (groups too)](#query-chat-history-groups-too)
- [Fetch Status](#fetch-status)
- [Fetch Profile Picture (groups too)](#fetch-profile-picture-groups-too)
- [Fetch Bussines Profile (such as description or category)](#fetch-bussines-profile-such-as-description-or-category)
- [Fetch Someone's Presence (if they're typing or online)](#fetch-someones-presence-if-theyre-typing-or-online)
- [Change Profile](#change-profile)
- [Change Profile Status](#change-profile-status)
- [Change Profile Name](#change-profile-name)
- [Change Display Picture (groups too)](#change-display-picture-groups-too)
- [Remove display picture (groups too)](#remove-display-picture-groups-too)
- [Groups](#groups)
- [Create a Group](#create-a-group)
- [Add/Remove or Demote/Promote](#addremove-or-demotepromote)
- [Change Subject (name)](#change-subject-name)
- [Change Description](#change-description)
- [Change Settings](#change-settings)
- [Leave a Group](#leave-a-group)
- [Get Invite Code](#get-invite-code)
- [Revoke Invite Code](#revoke-invite-code)
- [Join Using Invitation Code](#join-using-invitation-code)
- [Get Group Info by Invite Code](#get-group-info-by-invite-code)
- [Query Metadata (participants, name, description...)](#query-metadata-participants-name-description)
- [Join using groupInviteMessage](#join-using-groupinvitemessage)
- [Get Request Join List](#get-request-join-list)
- [Approve/Reject Request Join](#approvereject-request-join)
- [Get All Participating Groups Metadata](#get-all-participating-groups-metadata)
- [Toggle Ephemeral](#toggle-ephemeral)
- [Change Add Mode](#change-add-mode)
- [Newsletter](#newsletter)
- [Subscribe to Newsletter Updates](#subscribe-to-newsletter-updates)
- [Update Reaction Mode](#update-reaction-mode)
- [Update Newsletter Description](#update-newsletter-description)
- [Update Newsletter Name](#update-newsletter-name)
- [Update Newsletter Picture](#update-newsletter-picture)
- [Remove Newsletter Picture](#remove-newsletter-picture)
- [Follow a Newsletter](#follow-a-newsletter)
- [Unfollow a Newsletter](#unfollow-a-newsletter)
- [Mute a Newsletter](#mute-a-newsletter)
- [Unmute a Newsletter](#unmute-a-newsletter)
- [Perform a Newsletter Action (Generic)](#perform-a-newsletter-action-generic)
- [Create a Newsletter](#create-a-newsletter)
- [Fetch Newsletter Metadata](#fetch-newsletter-metadata)
- [Get Admin Count](#get-admin-count)
- [Change Newsletter Owner](#change-newsletter-owner)
- [Demote Newsletter Admin](#demote-newsletter-admin)
- [Delete Newsletter](#delete-newsletter)
- [React to a Message in Newsletter](#react-to-a-message-in-newsletter)
- [Fetch Messages in Newsletter](#fetch-messages-in-newsletter)
- [Fetch Updates in Newsletter](#fetch-updates-in-newsletter)
- [Privacy](#privacy)
- [Block/Unblock User](#blockunblock-user)
- [Get Privacy Settings](#get-privacy-settings)
- [Get BlockList](#get-blocklist)
- [Update LastSeen Privacy](#update-lastseen-privacy)
- [Update Online Privacy](#update-online-privacy)
- [Update Profile Picture Privacy](#update-profile-picture-privacy)
- [Update Status Privacy](#update-status-privacy)
- [Update Read Receipts Privacy](#update-read-receipts-privacy)
- [Update Groups Add Privacy](#update-groups-add-privacy)
- [Update Default Disappearing Mode](#update-default-disappearing-mode)
- [Broadcast Lists & Stories](#broadcast-lists--stories)
- [Send Broadcast & Stories](#send-broadcast--stories)
- [Query a Broadcast List's Recipients & Name](#query-a-broadcast-lists-recipients--name)
- [Writing Custom Functionality](#writing-custom-functionality)
- [Enabling Debug Level in Baileys Logs](#enabling-debug-level-in-baileys-logs)
- [How Whatsapp Communicate With Us](#how-whatsapp-communicate-with-us)
- [Register a Callback for Websocket Events](#register-a-callback-for-websocket-events)
## Connecting Account
WhatsApp provides a multi-device API that allows Baileys to be authenticated as a second WhatsApp client by scanning a **QR code** or **Pairing Code** with WhatsApp on your phone.
### Starting socket with **QR-CODE**
> [!TIP]
> You can customize browser name if you connect with **QR-CODE**, with `Browser` constant, we have some browsers config, **see [here](https://baileys.whiskeysockets.io/types/BrowsersMap.html)**
```javascript
const { default: makeWASocket } = require("baileys-x")
const sock = makeWASocket({
// can provide additional config here
browser: Browsers.ubuntu('My App'),
printQRInTerminal: true
})
```
If the connection is successful, you will see a QR code printed on your terminal screen, scan it with WhatsApp on your phone and you'll be logged in!
### Starting socket with **Pairing Code**
> [!IMPORTANT]
> Pairing Code isn't Mobile API, it's a method to connect Whatsapp Web without QR-CODE, you can connect only with one device, see [here](https://faq.whatsapp.com/1324084875126592/?cms_platform=web)
The phone number can't have `+` or `()` or `-`, only numbers, you must provide country code
```javascript
const { default: makeWASocket } = require("baileys-x")
const sock = makeWASocket({
// can provide additional config here
printQRInTerminal: false //need to be false
})
- Normal Pairing
if (!sock.authState.creds.registered) {
const number = 'XXXXXXXXXXX'
const code = await sock.requestPairingCode(number)
console.log(code)
}
- Costum Pairing
if (!sock.authState.creds.registered) {
const pair = "AB123C4D" // only 8 alphanumeric (no more or less)
const number = 'XXXXXXXXXXX'
const code = await sock.requestPairingCode(number, pair)
console.log(code)
}
```
### Receive Full History
1. Set `syncFullHistory` as `true`
2. Baileys, by default, use chrome browser config
- If you'd like to emulate a desktop connection (and receive more message history), this browser setting to your Socket config:
```javascript
const sock = makeWASocket({
...otherOpts,
// can use Windows, Ubuntu here too
browser: Browsers.macOS('Desktop'),
syncFullHistory: true
})
```
## Important Notes About Socket Config
### Caching Group Metadata (Recommended)
- If you use baileys for groups, we recommend you to set `cachedGroupMetadata` in socket config, you need to implement a cache like this:
```javascript
const groupCache = new NodeCache({stdTTL: 5 * 60, useClones: false})
const sock = makeWASocket({
cachedGroupMetadata: async (jid) => groupCache.get(jid)
})
sock.ev.on('groups.update', async ([event]) => {
const metadata = await sock.groupMetadata(event.id)
groupCache.set(event.id, metadata)
})
sock.ev.on('group-participants.update', async (event) => {
const metadata = await sock.groupMetadata(event.id)
groupCache.set(event.id, metadata)
})
```
### Improve Retry System & Decrypt Poll Votes
- If you want to improve sending message, retrying when error occurs and decrypt poll votes, you need to have a store and set `getMessage` config in socket like this:
```javascript
const sock = makeWASocket({
getMessage: async (key) => await getMessageFromStore(key)
})
```
### Receive Notifications in Whatsapp App
- If you want to receive notifications in whatsapp app, set `markOnlineOnConnect` to `false`
```javascript
const sock = makeWASocket({
markOnlineOnConnect: false
})
```
### Custom generateMessageID Function
- you can modify the messageId generator function against the socket
```javascript
const sock = makeWASocket({
generateMessageID: () => crypto.randomBytes(11).toString('hex').toUpperCase(),
generateMessageIDV2: (userId) => {
const hash = crypto.createHash('sha256').update(userId).digest('hex').toUpperCase();
const randomPart = crypto.randomBytes(11).toString('hex').toUpperCase();
const combined = hash + randomPart;
let result = '';
for (let i = 0; i < 22; i++) {
const randomIndex = crypto.randomBytes(1)[0] % combined.length;
result += combined[randomIndex];
}
return result;
}
})
```
## Saving & Restoring Sessions
You obviously don't want to keep scanning the QR code every time you want to connect.
So, you can load the credentials to log back in:
```javascript
const makeWASocket = require("baileys-x").default;
const { useMultiFileAuthState } = require("baileys-x");
// enable authDebug to display session logs
const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys', { authDebug: true })
// will use the given state to connect
// so if valid credentials are available -- it'll connect without QR
const sock = makeWASocket({ auth: state })
// this will be called as soon as the credentials are updated
sock.ev.on('creds.update', saveCreds)
```
You can sync cache on MultiFileAuthState
```javascript
const { state, saveCreds, cache: authCache } = await useMultiFileAuthState('auth_info_baileys', { syncCache: true })
const sock = makeWASocket({
auth: {
creds: state.creds,
keys: makeCacheableSignalKeyStore(
state.keys,
pino().child({ level: "silent", stream: "store" }),
authCache
)
}
})
sock.ev.on('creds.update', saveCreds)
```
> [!IMPORTANT]
> `useMultiFileAuthState` is a utility function to help save the auth state in a single folder, this function serves as a good guide to help write auth & key states for SQL/no-SQL databases, which I would recommend in any production grade system.
> [!NOTE]
> When a message is received/sent, due to signal sessions needing updating, the auth keys (`authState.keys`) will update. Whenever that happens, you must save the updated keys (`authState.keys.set()` is called). Not doing so will prevent your messages from reaching the recipient & cause other unexpected consequences. The `useMultiFileAuthState` function automatically takes care of that, but for any other serious implementation -- you will need to be very careful with the key state management.
## Handling Events
- Baileys uses the EventEmitter syntax for events.
They're all nicely typed up, so you shouldn't have any issues with an Intellisense editor like VS Code.
> [!IMPORTANT]
> **The events are [these](https://baileys.whiskeysockets.io/types/BaileysEventMap.html)**, it's important you see all events
You can listen to these events like this:
```javascript
const sock = makeWASocket()
sock.ev.on('messages.upsert', ({ messages }) => {
console.log('got messages', messages)
})
```
### Example to Start
> [!NOTE]
> This example includes basic auth storage too
```javascript
const makeWASocket = require("baileys-x").default;
const { DisconnectReason, useMultiFileAuthState } = require("baileys-x");
const Boom = require('@hapi/boom');
async function connectToWhatsApp () {
const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys')
const sock = makeWASocket({
// can provide additional config here
auth: state,
printQRInTerminal: true
})
sock.ev.on('connection.update', (update) => {
const { connection, lastDisconnect } = update
if(connection === 'close') {
const shouldReconnect = (lastDisconnect.error as Boom)?.output?.statusCode !== DisconnectReason.loggedOut
console.log('connection closed due to ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
// reconnect if not logged out
if(shouldReconnect) {
connectToWhatsApp()
}
} else if(connection === 'open') {
console.log('opened connection')
}
})
sock.ev.on('messages.upsert', event => {
for (const m of event.messages) {
console.log(JSON.stringify(m, undefined, 2))
console.log('replying to', m.key.remoteJid)
await sock.sendMessage(m.key.remoteJid!, { text: 'Hello Word' })
}
})
// to storage creds (session info) when it updates
sock.ev.on('creds.update', saveCreds)
}
// run in main file
connectToWhatsApp()
```
> [!IMPORTANT]
> In `messages.upsert` it's recommended to use a loop like `for (const message of event.messages)` to handle all messages in array
### Decrypt Poll Votes
- By default poll votes are encrypted and handled in `messages.update`
- That's a simple example
```javascript
sock.ev.on('messages.update', event => {
for(const { key, update } of event) {
if(update.pollUpdates) {
const pollCreation = await getMessage(key)
if(pollCreation) {
console.log(
'got poll update, aggregation: ',
getAggregateVotesInPollMessage({
message: pollCreation,
pollUpdates: update.pollUpdates,
})
)
}
}
}
})
```
- `getMessage` is a [store](#implementing-a-data-store) implementation (in your end)
### Summary of Events on First Connection
1. When you connect first time, `connection.update` will be fired requesting you to restart sock
2. Then, history messages will be received in `messaging.history-set`
## Implementing a Data Store
- Baileys does not come with a defacto storage for chats, contacts, or messages. However, a simple in-memory implementation has been provided. The store listens for chat updates, new messages, message updates, etc., to always have an up-to-date version of the data.
> [!IMPORTANT]
> I highly recommend building your own data store, as storing someone's entire chat history in memory is a terrible waste of RAM.
It can be used as follows:
```javascript
const makeWASocket = require("baileys-x").default;
const { makeInMemoryStore } = require("baileys-x");
// the store maintains the data of the WA connection in memory
// can be written out to a file & read from it
const store = makeInMemoryStore({ })
// can be read from a file
store.readFromFile('./baileys_store.json')
// saves the state to a file every 10s
setInterval(() => {
store.writeToFile('./baileys_store.json')
}, 10_000)
const sock = makeWASocket({ })
// will listen from this socket
// the store can listen from a new socket once the current socket outlives its lifetime
store.bind(sock.ev)
sock.ev.on('chats.upsert', () => {
// can use 'store.chats' however you want, even after the socket dies out
// 'chats' => a KeyedDB instance
console.log('got chats', store.chats.all())
})
sock.ev.on('contacts.upsert', () => {
console.log('got contacts', Object.values(store.contacts))
})
```
The store also provides some simple functions such as `loadMessages` that utilize the store to speed up data retrieval.
## Whatsapp IDs Explain
- `id` is the WhatsApp ID, called `jid` too, of the person or group you're sending the message to.
- It must be in the format ```[country code][phone number]@s.whatsapp.net```
- Example for people: ```+19999999999@s.whatsapp.net```.
- For groups, it must be in the format ``` 123456789-123345@g.us ```.
- For broadcast lists, it's `[timestamp of creation]@broadcast`.
- For stories, the ID is `status@broadcast`.
## Utility Functions
- `getContentType`, returns the content type for any message
- `getDevice`, returns the device from message
- `makeCacheableSignalKeyStore`, make auth store more fast
- `downloadContentFromMessage`, download content from any message
## Sending Messages
- Send all types of messages with a single function
- **[Here](https://baileys.whiskeysockets.io/types/AnyMessageContent.html) you can see all message contents supported, like text message**
- **[Here](https://baileys.whiskeysockets.io/types/MiscMessageGenerationOptions.html) you can see all options supported, like quote message**
```javascript
const jid: string
const content: AnyMessageContent
const options: MiscMessageGenerationOptions
sock.sendMessage(jid, content, options)
```
### Non-Media Messages
#### Buttons Message
```javascript
// send a buttons message!
sock.sendMessage(jid, {
text: "Hello World !",
footer: "Baileys - 2025",
buttons: [
{
buttonId: `🚀`,
buttonText: {
displayText: '🗿'
},
type: 1
}
],
headerType: 1,
viewOnce: true
},{ quoted: null })
```
#### Buttons Flow
```javascript
sock.sendMessage(jid, {
text: "Hello Wolrd !;",
footer: "© Baileys Pro",
buttons: [
{
buttonId: '.tes',
buttonText: {
displayText: 'TESTING BOT'
},
type: 1,
},
{
buttonId: ' ',
buttonText: {
displayText: 'PRIVATE SCRIPT'
},
type: 1,
},
{
buttonId: 'action',
buttonText: {
displayText: 'ini pesan interactiveMeta'
},
type: 4,
nativeFlowInfo: {
name: 'single_select',
paramsJson: JSON.stringify({
title: 'message',
sections: [
{
title: 'Baileys - 2025',
highlight_label: '😜',
rows: [
{
header: 'HEADER',
title: 'TITLE',
description: 'DESCRIPTION',
id: 'YOUR ID',
},
{
header: 'HEADER',
title: 'TITLE',
description: 'DESCRIPTION',
id: 'YOUR ID',
},
],
},
],
}),
},
},
],
headerType: 1,
viewOnce: true
}, { quoted: m });
```
#### Interactive Message
```javascript
let msg = generateWAMessageFromContent(m.chat, {
viewOnceMessage: {
message: {
"messageContextInfo": {
"deviceListMetadata": {},
"deviceListMetadataVersion": 2
},
interactiveMessage: proto.Message.InteractiveMessage.create({
body: proto.Message.InteractiveMessage.Body.create({
text: "Baileys Pro"
}),
footer: proto.Message.InteractiveMessage.Footer.create({
text: "Bot"
}),
header: proto.Message.InteractiveMessage.Header.create({
title: "Igna",
subtitle: "test",
hasMediaAttachment: false
}),
nativeFlowMessage: proto.Message.InteractiveMessage.NativeFlowMessage.create({
buttons: [
{
"name": "single_select",
"buttonParamsJson": "{\"title\":\"title\",\"sections\":[{\".menu\":\".play dj webito\",\"highlight_label\":\"label\",\"rows\":[{\"header\":\"header\",\"title\":\"title\",\"description\":\"description\",\"id\":\"id\"},{\"header\":\"header\",\"title\":\"title\",\"description\":\"description\",\"id\":\"id\"}]}]}"
},
{
"name": "cta_reply",
"buttonParamsJson": "{\"display_text\":\"quick_reply\",\"id\":\"message\"}"
},
{
"name": "cta_url",
"buttonParamsJson": "{\"display_text\":\"url\",\"url\":\"https://www.google.com\",\"merchant_url\":\"https://www.google.com\"}"
},
{
"name": "cta_call",
"buttonParamsJson": "{\"display_text\":\"call\",\"id\":\"message\"}"
},
{
"name": "cta_copy",
"buttonParamsJson": "{\"display_text\":\"copy\",\"id\":\"123456789\",\"copy_code\":\"message\"}"
},
{
"name": "cta_reminder",
"buttonParamsJson": "{\"display_text\":\"Recordatorio\",\"id\":\"message\"}"
},
{
"name": "cta_cancel_reminder",
"buttonParamsJson": "{\"display_text\":\"cta_cancel_reminder\",\"id\":\"message\"}"
},
{
"name": "address_message",
"buttonParamsJson": "{\"display_text\":\"address_message\",\"id\":\"message\"}"
},
{
"name": "send_location",
"buttonParamsJson": ""
}
],
})
})
}
}
}, {})
return sock.relayMessage(msg.key.remoteJid, msg.message, { messageId: msg.key.id })
```
#### Text Message
```javascript
await sock.sendMessage(jid, { text: 'hello word' })
```
#### Quote Message (works with all types)
```javascript
await sock.sendMessage(jid, { text: 'hello word' }, { quoted: message })
```
#### Mention User (works with most types)
- @number is to mention in text, it's optional
```javascript
await sock.sendMessage(
jid,
{
text: '@12345678901',
mentions: ['12345678901@s.whatsapp.net']
}
)
```
#### Mention Status
- [ jid ] If the Jid Group and Jid Private Chat are included in the JID list, try to make the JID group first starting from the Jid Private Chat or Jid Private Chat in the middle between the group Jid
```javascript
await sock.sendStatusMentions(
{
text: "Hello", // or image / video / audio ( url or buffer )
},
[
"123456789123456789@g.us",
"123456789@s.whatsapp.net",
// Enter jid chat here
]
)
```
#### Result Poll From Newsletter
```javascript
await sock.sendMessage(
jid,
{
pollResult: {
name: "Text poll",
votes: [["Options 1", 10], ["Options 2", 10]], // 10 For Fake Polling Count Results
}
}, { quoted : message }
)
```
#### Send Album Message
- url or buffer ( image or video )
```javascript
await sock.sendAlbumMessage(
jid,
[
{
image: { url: "https://example.jpg" }, // or buffer
caption: "Hello World",
},
{
video: { url: "https://example.mp4" }, // or buffer
caption: "Hello World",
},
],
{
quoted : message,
delay : 2000 // number in seconds
}
)
```
#### List Message
```javascript
const sections = [
{
title: "Section 1",
rows: [
{title: "Option 1", rowId: "option1"},
{title: "Option 2", rowId: "option2", description: "This is a description"}
]
},
{
title: "Section 2",
rows: [
{title: "Option 3", rowId: "option3"},
{title: "Option 4", rowId: "option4", description: "This is a description V2"}
]
},
]
const listMessage = {
text: "This is a list",
footer: "nice footer, link: https://google.com",
title: "Amazing boldfaced list title",
buttonText: "Required, text on the button to view the list",
sections
}
await sock.sendMessage(jid, listMessage)
```
#### Carousel Message
```javascript
sock.sendMessage(jid, {
text: 'hah',
footer: 'ya',
cards: [
{
title: 'oke',
image: { url: 'https://example.com/image.jpeg' },
caption: 'tes'
},
{
title: 'oke',
image: { url: 'https://example.com/image.jpeg' },
caption: 'tes'
}
],
viewOnce: true
})
```
#### Interactive Response
```javascript
await sock.sendMessage(
jid,
{
buttonReply: {
text: 'Text',
nativeFlow: {
version: 3,
},
},
type: 'interactive',
ephemeral: true,
}
)
```
#### Request Payment
```javascript
- Example non media sticker
await sock.sendMessage(
jid,
{
requestPayment: {
currency: "IDR",
amount: "10000000",
from: "123456@s.whatsapp.net",
note: "Hai Guys",
background: { ...background of the message }
}
},
{ quoted : message }
)
- with media sticker buffer
await sock.sendMessage(
jid,
{
requestPayment: {
currency: "IDR",
amount: "10000000",
from: "123456@s.whatsapp.net",
sticker: Buffer,
background: { ...background of the message }
}
},
{ quoted : message }
)
- with media sticker url
await sock.sendMessage(
jid,
{
requestPayment: {
currency: "IDR",
amount: "10000000",
from: "123456@s.whatsapp.net",
sticker: { url: Sticker Url },
background: { ...background of the message }
}
},
{ quoted : message }
)
```
#### Event Message
```javascript
await sock.sendMessage(
jid,
{
event: {
isCanceled: false, // or true for cancel event
name: "Name Event",
description: "Description Event",
location: {
degressLatitude: -0,
degressLongitude: - 0
},
link: Call Link,
startTime: m.messageTimestamp.low,
endTime: m.messageTimestamp.low + 86400, // 86400 is day in seconds
extraGuestsAllowed: true // or false
}
},
{ quoted : message }
)
```
#### Interactive
```javascript
- Example non header media
await sock.sendMessage(
jid,
{
text: "Description Of Messages", //Additional information
title: "Title Of Messages",
subtitle: "Subtitle Message",
footer: "Footer Messages",
interactiveButtons: [
{
name: "quick_reply",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
id: "ID"
})
},
{
name: "cta_url",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
url: "https://www.example.com"
})
}
]
},
{
quoted : message
}
)
// Example with media
await sock.sendMessage(
jid,
{
image: { url : "https://example.jpg" }, // Can buffer
caption: "Description Of Messages", //Additional information
title: "Title Of Messages",
subtitle: "Subtile Message",
footer: "Footer Messages",
media: true,
interactiveButtons: [
{
name: "quick_reply",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
id: "ID"
})
},
{
name: "cta_url",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
url: "https://www.example.com"
})
}
]
},
{
quoted : message
}
)
// Example with header product
await sock.sendMessage(
jid,
{
product: {
productImage: { url: "https://example.jpg }, //or buffer
productImageCount: 1,
title: "Title Product",
description: "Description Product",
priceAmount1000: 20000 * 1000,
currencyCode: "IDR",
retailerId: "Retail",
url: "https://example.com",
},
businessOwnerJid: "1234@s.whatsapp.net",
caption: "Description Of Messages", //Additional information
title: "Title Of Messages",
footer: "Footer Messages",
media: true,
interactiveButtons: [
{
name: "quick_reply",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
id: "ID"
})
},
{
name: "cta_url",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
url: "https://www.example.com"
})
}
]
},
{
quoted : message
}
)
```
#### Forward Messages
- You need to have message object, can be retrieved from [store](#implementing-a-data-store) or use a [message](https://baileys.whiskeysockets.io/types/WAMessage.html) object
```javascript
const msg = getMessageFromStore() // implement this on your end
await sock.sendMessage(jid, { forward: msg }) // WA forward the message!
```
#### Location Message
```javascript
await sock.sendMessage(
jid,
{
location: {
degreesLatitude: 24.121231,
degreesLongitude: 55.1121221
}
}
)
```
#### Contact Message
```javascript
const vcard = 'BEGIN:VCARD\n' // metadata of the contact card
+ 'VERSION:3.0\n'
+ 'FN:Jeff Singh\n' // full name
+ 'ORG:Ashoka Uni;\n' // the organization of the contact
+ 'TEL;type=CELL;type=VOICE;waid=911234567890:+91 12345 67890\n' // WhatsApp ID + phone number
+ 'END:VCARD'
await sock.sendMessage(
id,
{
contacts: {
displayName: 'Jeff',
contacts: [{ vcard }]
}
}
)
```
#### Reaction Message
- You need to pass the key of message, you can retrieve from [store](#implementing-a-data-store) or use a [key](https://baileys.whiskeysockets.io/types/WAMessageKey.html) object
```javascript
await sock.sendMessage(
jid,
{
react: {
text: '💖', // use an empty string to remove the reaction
key: message.key
}
}
)
```
#### Pin Message
- You need to pass the key of message, you can retrieve from [store](#implementing-a-data-store) or use a [key](https://baileys.whiskeysockets.io/types/WAMessageKey.html) object
- Time can be:
| Time | Seconds |
|-------|----------------|
| 24h | 86.400 |
| 7d | 604.800 |
| 30d | 2.592.000 |
```javascript
await sock.sendMessage(
jid,
{
pin: {
type: 1, // 0 to remove
time: 86400
key: message.key
}
}
)
```
#### Poll Message
```javascript
await sock.sendMessage(
jid,
{
poll: {
name: 'My Poll',
values: ['Option 1', 'Option 2', ...],
selectableCount: 1,
toAnnouncementGroup: false // or true
}
}
)
```
### Sending Messages with Link Previews
1. By default, wa does not have link generation when sent from the web
2. Baileys has a function to generate the content for these link previews
3. To enable this function's usage, add `link-preview-js` as a dependency to your project with `yarn add link-preview-js`
4. Send a link:
```javascript
await sock.sendMessage(
jid,
{
text: 'Hi, this was sent using https://github.com/whiskeysockets/baileys'
}
)
```
### Media Messages
Sending media (video, stickers, images) is easier & more efficient than ever.
> [!NOTE]
> In media messages, you can pass `{ stream: Stream }` or `{ url: Url }` or `Buffer` directly, you can see more [here](https://baileys.whiskeysockets.io/types/WAMediaUpload.html)
- When specifying a media url, Baileys never loads the entire buffer into memory; it even encrypts the media as a readable stream.
> [!TIP]
> It's recommended to use Stream or Url to save memory
#### Gif Message
- Whatsapp doesn't support `.gif` files, that's why we send gifs as common `.mp4` video with `gifPlayback` flag
```javascript
await sock.sendMessage(
jid,
{
video: fs.readFileSync('Media/ma_gif.mp4'),
caption: 'hello word',
gifPlayback: true
}
)
```
#### Video Message
```javascript
await sock.sendMessage(
id,
{
video: {
url: './Media/ma_gif.mp4'
},
caption: 'hello word',
ptv: false // if set to true, will send as a `video note`
}
)
```
#### Audio Message
- To audio message work in all devices you need to convert with some tool like `ffmpeg` with this flags:
```bash
codec: libopus //ogg file
ac: 1 //one channel
avoid_negative_ts
make_zero
```
- Example:
```bash
ffmpeg -i input.mp4 -avoid_negative_ts make_zero -ac 1 output.ogg
```
```javascript
await sock.sendMessage(
jid,
{
audio: {
url: './Media/audio.mp3'
},
mimetype: 'audio/mp4'
}
)
```
#### Image Message
```javascript
await sock.sendMessage(
id,
{
image: {
url: './Media/ma_img.png'
},
caption: 'hello word'
}
)
```
#### View Once Message
- You can send all messages above as `viewOnce`, you only need to pass `viewOnce: true` in content object
```javascript
await sock.sendMessage(
id,
{
image: {
url: './Media/ma_img.png'
},
viewOnce: true, //works with video, audio too
caption: 'hello word'
}
)
```
## Modify Messages
### Deleting Messages (for everyone)
```javascript
const msg = await sock.sendMessage(jid, { text: 'hello word' })
await sock.sendMessage(jid, { delete: msg.key })
```
**Note:** deleting for oneself is supported via `chatModify`, see in [this section](#modifying-chats)
### Editing Messages
- You can pass all editable contents here
```javascript
await sock.sendMessage(jid, {
text: 'updated text goes here',
edit: response.key,
});
```
## Manipulating Media Messages
### Thumbnail in Media Messages
- For media messages, the thumbnail can be generated automatically for images & stickers provided you add `jimp` or `sharp` as a dependency in your project using `yarn add jimp` or `yarn add sharp`.
- Thumbnails for videos can also be generated automatically, though, you need to have `ffmpeg` installed on your system.
### Downloading Media Messages
If you want to save the media you received
```javascript
const { createWriteStream } = require('fs');
const { downloadMediaMessage, getContentType } = require("baileys-x");
sock.ev.on('messages.upsert', async ({ [m] }) => {
if (!m.message) return // if there is no text or media message
const messageType = getContentType(m) // get what type of message it is (text, image, video...)
// if the message is an image
if (messageType === 'imageMessage') {
// download the message
const stream = await downloadMediaMessage(
m,
'stream', // can be 'buffer' too
{ },
{
logger,
// pass this so that baileys can request a reupload of media
// that has been deleted
reuploadRequest: sock.updateMediaMessage
}
)
// save to file
const writeStream = createWriteStream('./my-download.jpeg')
stream.pipe(writeStream)
}
}
```
### Re-upload Media Message to Whatsapp
- WhatsApp automatically removes old media from their servers. For the device to access said media -- a re-upload is required by another device that has it. This can be accomplished using:
```javascript
await sock.updateMediaMessage(msg)
```
## Reject Call
- You can obtain `callId` and `callFrom` from `call` event
```javascript
await sock.rejectCall(callId, callFrom)
```
## Send States in Chat
### Reading Messages
- A set of message [keys](https://baileys.whiskeysockets.io/types/WAMessageKey.html) must be explicitly marked read now.
- You cannot mark an entire 'chat' read as it were with Baileys Web.
This means you have to keep track of unread messages.
```javascript
const key: WAMessageKey
// can pass multiple keys to read multiple messages as well
await sock.readMessages([key])
```
The message ID is the unique identifier of the message that you are marking as read.
On a `WAMessage`, the `messageID` can be accessed using ```messageID = message.key.id```.
### Update Presence
- ``` presence ``` can be o