# ๐ฑ @itsliaaa/baileys
[](https://www.npmjs.com/package/@itsliaaa/baileys)
Enhanced Baileys v7 with fixes for newsletter media uploads, plus support for interactive messages, albums, and additional message types.
โ For donation: [Saweria](https://saweria.co/itsliaaa)
### โจ Highlights
This fork designed for production use with a focus on clarity and safety:
- ๐ซ No obfuscation. Easy to read and audit.
- ๐ซ No auto-follow channel (newsletter) behavior.
> [!NOTE]
> ๐ This project is maintained with limited scope and is not intended to replace upstream Baileys.
>
> ๐ And, really sorry for my bad english.
### ๐ ๏ธ Internal Adjustments
- ๐ผ๏ธ Fixed an issue where media could not be sent to newsletters due to an upstream issue.
- ๐ Reintroduced [`makeInMemoryStore`](#%EF%B8%8F-implementing-data-store) with a minimal ESM adaptation and small adjustments for Baileys v7.
- ๐ฆ Switched FFmpeg execution from `exec` to `spawn` for safer process handling.
- ๐๏ธ Added [`@napi-rs/image`](https://www.npmjs.com/package/@napi-rs/image) as a supported image processing backend in [`getImageProcessingLibrary()`](#%EF%B8%8F-image-processing), offering a balance between performance and compatibility.
### ๐จ Messages Handling & Compatibility
- ๐ฉ Expanded messages support for:
- ๐ผ๏ธ [Album Message](#%EF%B8%8F-album-image--video)
- ๐ค [Group Status Message](#%E2%80%8D%E2%80%8D-group-status)
- ๐๐ป [Interactive Message](#-sending-interactive-messages) (buttons, lists, native flows, templates, carousels).
- ๐๏ธ [Status Mention Message](#%EF%B8%8F-status-mention)
- ๐ฆ [Sticker Pack Message](#-sticker-pack)
- โจ [Rich Response Message](#-rich-response) **[NEW]**
- ๐งพ [Message with Code Blocks](#-message-with-code-block) **[NEW]**
- [๐ Message with Inline Entities](#-message-with-inline-entities) **[NEW]**
- ๐ [Message with Table](#-message-with-table) **[NEW]**
- ๐ณ [Payment-related Message](#-sending-payment-messages) (payment requests, invites, orders, invoices).
- ๐ฐ Simplified sending messages with ad thumbnail using [`externalAdReply`](#-external-ad-reply), without requiring manual `contextInfo`.
- ๐ญ Added support for quoting messages inside channel (newsletter). **[NEW]**
- ๐ Added support for [custom button icon](#%EF%B8%8F-interactive). **[NEW]**
### ๐งฉ Additional Message Options
- ๐๏ธ Added optional boolean flags for message handling:
- ๐ค [`ai`](#-ai-icon) - AI icon on message
- ๐ฃ [`mentionAll`](#-mention) - Mention all group participants without requiring their JIDs in `mentions` or `mentionedJid` **[NEW]**
- ๐ง [`ephemeral`](#-ephemeral), [`groupStatus`](#%E2%80%8D%E2%80%8D-group-status), [`isLottie`](#-lottie-sticker), [`spoiler`](#-spoiler), [`viewOnce`](#%EF%B8%8F-view-once), [`viewOnceV2`](#%EF%B8%8F-view-once-v2), [`viewOnceV2Extension`](#%EF%B8%8F-view-once-v2-extension), [`interactiveAsTemplate`](#%EF%B8%8F-interactive) - Message wrappers
- ๐ [`secureMetaServiceLabel`](#%EF%B8%8F-secure-meta-service-label) - Secure meta service label on message **[NEW]**
- ๐ [`raw`](#-raw) - Build your message manually **(DO NOT USE FOR EXPLOITATION)**
### ๐ Table of Contents
- [โจ Highlights](#-highlights)
- [๐ ๏ธ Internal Adjustments](#%EF%B8%8F-internal-adjustments)
- [๐จ Messages Handling & Compatibility](#-highlights)
- [๐งฉ Additional Message Options](#-additional-message-options)
- [๐ฅ Installation](#-installation)
- [๐งฉ Import (ESM & CJS)](#-import-esm--cjs)
- [๐ Connect to WhatsApp (Quick Step)](#-connect-to-whatsapp-quick-step)
- [๐ Auth State](#-auth-state)
- [๐๏ธ Implementing Data Store](#%EF%B8%8F-implementing-data-store)
- [๐ชช WhatsApp IDs Explain](#-whatsapp-ids-explain)
- [โ๏ธ Sending Messages](#%EF%B8%8F-sending-messages)
- [๐ Text](#-text)
- [๐ Mention](#-mention)
- [๐ Reaction](#-reaction)
- [๐ Pin Message](#-pin-message)
- [โก๏ธ Forward Message](#%EF%B8%8F-forward-message)
- [๐ค Contact](#-contact)
- [๐ Location](#-location)
- [๐๏ธ Event](#%EF%B8%8F-event)
- [๐ฅ Group Invite](#-group-invite)
- [๐๏ธ Product](#%EF%B8%8F-product)
- [๐ Poll](#-poll)
- [๐ญ Button Response](#-button-response)
- [โจ Rich Response](#-rich-response)
- [๐งพ Message with Code Block](#-message-with-code-block)
- [๐ Message with Inline Entities](#-message-with-inline-entities)
- [๐ Message with Table](#-message-with-table)
- [๐๏ธ Status Mention](#%EF%B8%8F-status-mention)
- [๐ Sending Media Messages](#-sending-media-messages)
- [๐ผ๏ธ Image](#%EF%B8%8F-image)
- [๐ฅ Video](#-video)
- [๐ Sticker](#-sticker)
- [๐ฝ Audio](#-audio)
- [๐๏ธ Document](#%EF%B8%8F-document)
- [๐ผ๏ธ Album (Image & Video)](#%EF%B8%8F-album-image--video)
- [๐ฆ Sticker Pack](#-sticker-pack)
- [๐๐ป Sending Interactive Messages](#-sending-interactive-messages)
- [๐ Buttons](#-buttons)
- [๐ List](#-list)
- [๐๏ธ Interactive](#%EF%B8%8F-interactive)
- [๐ซ Hydrated Template](#-hydrated-template)
- [๐ณ Sending Payment Messages](#-sending-payment-messages)
- [โ Invite Payment](#-invite-payment)
- [๐งพ Invoice](#-invoice)
- [๐๏ธ Order](#%EF%B8%8F-order)
- [๐ณ Request Payment](#-request-payment)
- [๐๏ธ Other Message Options](#%EF%B8%8F-other-message-options)
- [๐ค AI Icon](#-ai-icon)
- [๐ Ephemeral](#-ephemeral)
- [๐ฐ External Ad Reply](#-external-ad-reply)
- [๐งโ๐งโ๐ง Group Status](#%E2%80%8D%E2%80%8D-group-status)
- [๐ฑ Lottie Sticker](#-lottie-sticker)
- [๐งฉ Raw](#-raw)
- [๐ท๏ธ Secure Meta Service Label](#%EF%B8%8F-secure-meta-service-label)
- [๐ Spoiler](#-spoiler)
- [๐๏ธ View Once](#%EF%B8%8F-view-once)
- [๐๏ธ View Once V2](#%EF%B8%8F-view-once-v2)
- [๐๏ธ View Once V2 Extension](#%EF%B8%8F-view-once-v2-extension)
- [โป๏ธ Modify Messages](#%EF%B8%8F-modify-messages)
- [๐๏ธ Delete Messages](#%EF%B8%8F-delete-messages)
- [โ๏ธ Edit Messages](#%EF%B8%8F-edit-messages)
- [๐งฐ Additional Contents](#-additional-contents)
- [๐ท๏ธ Find User ID (JID|PN/LID)](#%EF%B8%8F-find-user-id-jidpnlid)
- [๐ Request Custom Pairing Code](#-request-custom-pairing-code)
- [๐ผ๏ธ Image Processing](#%EF%B8%8F-image-processing)
- [๐ฃ Newsletter Management](#-newsletter-management)
- [๐ฅ Group Management](#-group-management)
- [๐ฅ Community Management](#-community-management)
- [๐ค Profile Management](#-profile-management)
- [๐ Business Management](#-business-management)
- [๐ Privacy Management](#-privacy-management)
- [๐ก Events](#-events)
- [๐ Try the Bot](#-try-the-bot)
- [๐ฆ Fork Base](#-fork-base)
- [๐ฃ Credits](#-credits)
### ๐ฅ Installation
- ๐ Via `package.json`
```json
# NPM
"dependencies": {
"@itsliaaa/baileys": "latest"
}
# GitHub
"dependencies": {
"@itsliaaa/baileys": "github:itsliaaa/baileys"
}
```
- โจ๏ธ Via terminal
```bash
# NPM
npm i @itsliaaa/baileys@latest
# GitHub
npm i github:itsliaaa/baileys
```
#### ๐งฉ Import (ESM & CJS)
```javascript
// --- ESM
import { makeWASocket } from '@itsliaaa/baileys'
// --- CJS (tested and working on Node.js 24 โ
)
const { makeWASocket } = require('@itsliaaa/baileys')
```
### ๐ Connect to WhatsApp (Quick Step)
```javascript
import { makeWASocket, delay, DisconnectReason, useMultiFileAuthState } from '@itsliaaa/baileys'
import { Boom } from '@hapi/boom'
import pino from 'pino'
// --- Connect with pairing code
const myPhoneNumber = '6288888888888'
const logger = pino({ level: 'silent' })
const connectToWhatsApp = async () => {
const { state, saveCreds } = await useMultiFileAuthState('session')
const sock = makeWASocket({
logger,
auth: state
})
sock.ev.on('creds.update', saveCreds)
sock.ev.on('connection.update', (update) => {
const { connection, lastDisconnect } = update
if (connection === 'connecting' && !sock.authState.creds.registered) {
await delay(1500)
const code = await sock.requestPairingCode(myPhoneNumber)
console.log('๐ Pairing code', ':', code)
}
else if (connection === 'close') {
const shouldReconnect = new Boom(connection?.lastDisconnect?.error)?.output?.statusCode !== DisconnectReason.loggedOut
console.log('โ ๏ธ Connection closed because', lastDisconnect.error, ', reconnecting ', shouldReconnect)
if (shouldReconnect) {
connectToWhatsApp()
}
}
else if (connection === 'open') {
console.log('โ
Successfully connected to WhatsApp')
}
})
sock.ev.on('messages.upsert', async ({ messages }) => {
for (const message of messages) {
if (!message.message) continue
console.log('๐ Got new message', ':', message)
await sock.sendMessage(message.key.remoteJid, {
text: '๐๐ป Hello world'
})
}
})
}
connectToWhatsApp()
```
#### ๐ Auth State
> [!NOTE]
> You can use the experimental `useSingleFileAuthState` as an alternative to `useMultiFileAuthState`. However, `useSingleFileAuthState` already includes an internal caching mechanism, so there is no need to wrap `state.keys` with `makeCacheableSignalKeyStore`.
### ๐๏ธ Implementing Data Store
> [!CAUTION]
> I highly recommend building your own data store, as keeping an entire chat history in memory can lead to excessive RAM usage.
```javascript
import { makeWASocket, makeInMemoryStore, delay, DisconnectReason, useMultiFileAuthState } from '@itsliaaa/baileys'
import { Boom } from '@hapi/boom'
import pino from 'pino'
const myPhoneNumber = '6288888888888'
// --- Create your store path
const storePath = './store.json'
const logger = pino({ level: 'silent' })
const connectToWhatsApp = async () => {
const { state, saveCreds } = await useMultiFileAuthState('session')
const sock = makeWASocket({
logger,
auth: state
})
const store = makeInMemoryStore({
logger,
socket: sock
})
store.bind(sock.ev)
sock.ev.on('creds.update', saveCreds)
sock.ev.on('connection.update', (update) => {
const { connection, lastDisconnect } = update
if (connection === 'connecting' && !sock.authState.creds.registered) {
await delay(1500)
const code = await sock.requestPairingCode(myPhoneNumber)
console.log('๐ Pairing code', ':', code)
}
else if (connection === 'close') {
const shouldReconnect = new Boom(connection?.lastDisconnect?.error)?.output?.statusCode !== DisconnectReason.loggedOut
console.log('โ ๏ธ Connection closed because', lastDisconnect.error, ', reconnecting ', shouldReconnect)
if (shouldReconnect) {
connectToWhatsApp()
}
}
else if (connection === 'open') {
console.log('โ
Successfully connected to WhatsApp')
}
})
sock.ev.on('chats.upsert', () => {
console.log('โ๏ธ Got chats', store.chats.all())
})
sock.ev.on('contacts.upsert', () => {
console.log('๐ฅ Got contacts', Object.values(store.contacts))
})
// --- Read store from file
store.readFromFile(storePath)
// --- Save store every 3 minutes
setInterval(() => {
store.writeToFile(storePath)
}, 180000)
}
connectToWhatsApp()
```
### ๐ชช WhatsApp IDs Explain
`id` is the WhatsApp ID, called `jid` and `lid` 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` and `12699999999@lid`.
- For groups, it must be in the format `123456789-123345@g.us`.
- For Meta AI, it's `11111111111@bot`.
- For broadcast lists, it's `[timestamp of creation]@broadcast`.
- For stories, the ID is `status@broadcast`.
### โ๏ธ Sending Messages
> [!NOTE]
> You can get the `jid` from `message.key.remoteJid` in the first example.
#### ๐ Text
```javascript
// --- Send a regular text message
sock.sendMessage(jid, {
text: '๐๐ป Hello'
}, {
quoted: message
})
// --- Send a text message with a link preview
const urlA = 'https://www.npmjs.com/package/@itsliaaa/baileys'
sock.sendMessage(jid, {
text: urlA + ' ๐๐ป Check it out!',
linkPreview: {
'matched-text': urlA,
title: '๐ฑ @itsliaaa/baileys',
description: 'Underrated Baileys Fork',
previewType: 0, // --- Use 1 for video playback in the link preview
jpegThumbnail: fs.readFileSync('./path/to/image.jpg')
}
})
// --- Send a text message with a large link preview and favicon
import { prepareWAMessageMedia } from '@itsliaaa/baileys'
const urlB = 'https://www.npmjs.com/package/@itsliaaa/baileys#readme'
const { imageMessage: image } = await prepareWAMessageMedia({
image: {
url: './path/to/image.jpg'
}
}, {
upload: sock.waUploadToServer,
mediaTypeOverride: 'thumbnail-link'
})
// --- Set the thumbnail display size
image.height = 720
image.width = 480
sock.sendMessage(jid, {
text: urlB + ' ๐๐ป Check it out!',
linkPreview: {
'matched-text': urlB,
title: '๐ฑ @itsliaaa/baileys',
description: 'Underrated Baileys Fork',
previewType: 0,
jpegThumbnail: fs.readFileSync('./path/to/image.jpg'),
highQualityThumbnail: image,
linkPreviewMetadata: {
linkMediaDuration: 0, // --- Duration in seconds (for video/audio content)
socialMediaPostType: 1, // --- Enum: 0 = NONE, 1 = REEL, 2 = LIVE_VIDEO, 3 = LONG_VIDEO, 4 = SINGLE_IMAGE, 5 = CAROUSEL
} // --- Additional metadata for large link preview
},
favicon: {
url: './path/to/tiny-image.png'
}
})
```
#### ๐ Mention
```javascript
// --- Regular mention
sock.sendMessage(jid, {
text: '๐๐ป Hello @628123456789',
mentions: ['628123456789@s.whatsapp.net']
}, {
quoted: message
})
// --- Mention all
sock.sendMessage(jid, {
text: '๐๐ป Hello @all',
mentionAll: true
}, {
quoted: message
})
```
#### ๐ Reaction
```javascript
sock.sendMessage(jid, {
react: {
key: message.key,
text: 'โจ'
}
}, {
quoted: message
})
```
#### ๐ Pin Message
```javascript
sock.sendMessage(jid, {
pin: message.key,
time: 86400, // --- Set the value in seconds: 86400 (1d), 604800 (7d), or 2592000 (30d)
type: 1 // --- Or 0 to remove
}, {
quoted: message
})
```
#### โก๏ธ Forward Message
```javascript
sock.sendMessage(jid, {
forward: message,
force: true // --- Optional
})
```
#### ๐ค Contact
```javascript
const vcard = 'BEGIN:VCARD\n'
+ 'VERSION:3.0\n'
+ 'FN:Lia Wynn\n'
+ 'ORG:Waitress;\n'
+ 'TEL;type=CELL;type=VOICE;waid=628123456789:+62 8123 4567 89\n'
+ 'END:VCARD'
sock.sendMessage(jid, {
contacts: {
displayName: 'Lia Wynn',
contacts: [
{ vcard }
]
}
}, {
quoted: message
})
```
#### ๐ Location
```javascript
sock.sendMessage(jid, {
location: {
degreesLatitude: 24.121231,
degreesLongitude: 55.1121221,
name: '๐๐ป I am here'
}
}, {
quoted: message
})
```
#### ๐๏ธ Event
```javascript
sock.sendMessage(jid, {
event: {
name: '๐ถ Meet & Mingle Party',
description: 'Meet & Mingle Party is a fun, casual gathering to connect, chat, and build new relationships within the community.',
call: 'audio', // --- Or "video", this field is optional
startDate: new Date(Date.now() + 3600000),
endDate: new Date(Date.now() + 28800000),
isCancelled: false, // --- Optional
isScheduleCall: false, // --- Optional
extraGuestsAllowed: false, // --- Optional
location: {
name: 'Jakarta',
degreesLatitude: -6.2,
degreesLongitude: 106.8
}
}
}, {
quoted: message
})
```
#### ๐ฅ Group Invite
```javascript
const inviteCode = groupUrl
.split('chat.whatsapp.com/')[1]
?.split('?')[0]
const groupJid = '1201111111111@g.us'
const groupName = '@itsliaaa/baileys'
sock.sendMessage(jid, {
groupInvite: {
inviteCode,
inviteExpiration: Date.now() + 86400000,
text: '๐๐ป Hello, we invite you to join our group.',
jid: groupJid,
subject: groupName,
}
}, {
quoted: message
})
```
#### ๐๏ธ Product
```javascript
import { randomUUID } from 'crypto'
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
body: '๐๐ป Check my product here!',
footer: '@itsliaaa/baileys',
product: {
currencyCode: 'IDR',
description: '๐๏ธ Interesting product!',
priceAmount1000: 70_000_000,
productId: randomUUID(),
productImageCount: 1,
salePriceAmount1000: 65_000_000,
signedUrl: 'https://www.npmjs.com/package/@itsliaaa/baileys',
title: '๐ฆ Starseed (Premium)',
url: 'https://www.npmjs.com/package/@itsliaaa/baileys'
},
businessOwnerJid: '0@s.whatsapp.net'
})
```
#### ๐ Poll
```javascript
// --- Regular poll message
sock.sendMessage(jid, {
poll: {
name: '๐ฅ Voting time',
values: ['Yes', 'No'],
selectableCount: 1,
toAnnouncementGroup: false
}
}, {
quoted: message
})
// --- Quiz (only for newsletter)
sock.sendMessage('1211111111111@newsletter', {
poll: {
name: '๐ฅ Quiz',
values: ['Yes', 'No'],
correctAnswer: 'Yes',
pollType: 1
}
}, {
quoted: message
})
// --- Poll result
sock.sendMessage(jid, {
pollResult: {
name: '๐ Poll Result',
votes: [{
name: 'Nice',
voteCount: 10
}, {
name: 'Nah',
voteCount: 2
}],
pollType: 0 // Or 1 for quiz
}
}, {
quoted: message
})
// --- Poll update
sock.sendMessage(jid, {
pollUpdate: {
metadata: {},
key: message.key,
vote: {
enclv: /* */,
encPayload: /* */
}
}
}, {
quoted: message
})
```
#### ๐ญ Button Response
```javascript
// --- Using buttonsResponseMessage
sock.sendMessage(jid, {
type: 'plain',
buttonReply: {
id: '#Menu',
displayText: 'โจ Interesting Menu'
}
}, {
quoted: message
})
// --- Using interactiveResponseMessage
sock.sendMessage(jid, {
flowReply: {
format: 0,
text: '๐ญ Response',
name: 'menu_options',
paramsJson: JSON.stringify({
id: '#Menu',
description: 'โจ Interesting Menu'
})
}
}, {
quoted: message
})
// --- Using listResponseMessage
sock.sendMessage(jid, {
listReply: {
title: '๐ See More',
description: 'โจ Interesting Menu',
id: '#Menu'
}
}, {
quoted: message
})
// --- Using templateButtonReplyMessage
sock.sendMessage(jid, {
type: 'template',
buttonReply: {
id: '#Menu',
displayText: 'โจ Interesting Menu',
index: 1
}
}, {
quoted: message
})
```
#### โจ Rich Response
> [!NOTE]
> `richResponse[]` is a representation of [`submessages[]`](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage) inside `richResponseMessage`.
> [!TIP]
> You can still use the original [`submessages[]`](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage) field directly.
> The code example below is just an implementation using a helper, not a required structure.
```javascript
sock.sendMessage(jid, {
disclaimerText: 'RAW submessages structure example',
richResponse: [{
text: 'Example Usage',
}, {
language: 'javascript',
code: [{
highlightType: 0,
codeContent: 'console.log("Hello, World!")'
}]
}, {
text: 'Pretty simple, right?\n'
}, {
text: 'Comparison between Node.js, Bun, and Deno',
}, {
title: 'Runtime Comparison',
table: [{
isHeading: true,
items: ['', 'Node.js', 'Bun', 'Deno']
}, {
isHeading: false,
items: ['Engine', 'V8 (C++)', 'JavaScriptCore (C++)', 'V8 (C++)']
}, {
isHeading: false,
items: ['Performance', '4/5', '5/5', '4/5']
}]
}, {
text: 'Does this help clarify the differences?'
}]
})
```
> [!TIP]
> You can easily add syntax highlighting by importing `tokenizeCode` directly from Baileys.
```javascript
import { tokenizeCode } from '@itsliaaa/baileys'
const language = 'javascript'
const code = 'console.log("Hello, World!")'
sock.sendMessage(jid, {
disclaimerText: 'Example of tokenizing Code Block',
richResponse: [{
text: 'Example Usage',
}, {
language,
code: tokenizeCode(code, language)
}, {
text: 'Pretty simple, right?'
}]
})
```
#### ๐งพ Message with Code Block
> [!NOTE]
> This feature already includes a built-in tokenizer.
```javascript
sock.sendMessage(jid, {
disclaimerText: 'Code Block',
headerText: '## Example Usage',
contentText: '---',
code: 'console.log("Hello, World!")',
language: 'javascript',
footerText: 'Pretty simple, right?'
})
```
#### ๐ Message with Inline Entities
```javascript
sock.sendMessage(jid, {
disclaimerText: 'Inline Entities',
headerText: '## Check Out!',
contentText: '---',
links: [{
text: '1. Google',
title: 'Popular Search Engine',
url: 'https://www.google.com/'
}, {
text: '2. YouTube',
title: 'Popular Streaming Platform',
url: 'https://www.youtube.com/'
}, {
text: '3. Modded Baileys',
title: 'Underrated Baileys Fork',
url: 'https://www.npmjs.com/package/@itsliaaa/baileys'
}],
footerText: '---'
})
```
#### ๐ Message with Table
```javascript
sock.sendMessage(jid, {
disclaimerText: 'Table',
headerText: '## Comparison between Node.js, Bun, and Deno',
contentText: '---',
title: 'Runtime Comparison',
table: [
['', 'Node.js', 'Bun', 'Deno'],
['Engine', 'V8 (C++)', 'JavaScriptCore (C++)', 'V8 (C++)'],
['Performance', '4/5', '5/5', '4/5']
],
noHeading: false, // --- Optional
footerText: 'Does this help clarify the differences?'
})
```
#### ๐๏ธ Status Mention
```javascript
sock.sendMessage([jidA, jidB, jidC], {
text: 'Hello! ๐๐ป'
})
```
### ๐ Sending Media Messages
> [!NOTE]
> For media messages, you can pass a `Buffer` directly, or an object with either `{ stream: Readable }` or `{ url: string }` (local file path or HTTP/HTTPS URL).
#### ๐ผ๏ธ Image
```javascript
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
caption: '๐ฅ Superb'
}, {
quoted: message
})
```
#### ๐ฅ Video
```javascript
sock.sendMessage(jid, {
video: {
url: './path/to/video.mp4'
},
gifPlayback: false, // --- Set true if you want to send video as GIF
ptv: false, // --- Set true if you want to send video as PTV
caption: '๐ฅ Superb'
}, {
quoted: message
})
```
#### ๐ Sticker
```javascript
sock.sendMessage(jid, {
sticker: {
url: './path/to/sticker.webp'
}
}, {
quoted: message
})
```
#### ๐ฝ Audio
```javascript
sock.sendMessage(jid, {
audio: {
url: './path/to/audio.mp3'
},
ptt: false // --- Set true if you want to send audio as Voice Note
}, {
quoted: message
})
```
#### ๐๏ธ Document
```javascript
sock.sendMessage(jid, {
document: {
url: './path/to/document.pdf'
},
mimetype: 'application/pdf',
caption: 'โจ My work!'
}, {
quoted: message
})
```
#### ๐ผ๏ธ Album (Image & Video)
```javascript
sock.sendMessage(jid, {
album: [{
image: {
url: './path/to/image.jpg'
},
caption: '1st image'
}, {
video: {
url: './path/to/video.mp4'
},
caption: '1st video'
}, {
image: {
url: './path/to/image.jpg'
},
caption: '2nd image'
}, {
video: {
url: './path/to/video.mp4'
},
caption: '2nd video'
}]
}, {
quoted: message
})
```
#### ๐ฆ Sticker Pack
> [!IMPORTANT]
> If `sharp` or `@napi-rs/image` is not installed, the `cover` and `stickers` must already be in WebP format.
```javascript
sock.sendMessage(jid, {
cover: {
url: './path/to/image.webp'
},
stickers: [{
data: {
url: './path/to/image.webp'
}
}, {
data: {
url: './path/to/image.webp'
}
}, {
data: {
url: './path/to/image.webp'
}
}],
name: '๐ฆ My Sticker Pack',
publisher: '๐ Lia Wynn',
description: '@itsliaaa/baileys'
}, {
quoted: message
})
```
### ๐๐ป Sending Interactive Messages
#### ๐ Buttons
```javascript
// --- Regular buttons message
sock.sendMessage(jid, {
text: '๐๐ป Buttons!',
footer: '@itsliaaa/baileys',
buttons: [{
text: '๐๐ป SignUp',
id: '#SignUp'
}]
}, {
quoted: message
})
// --- Buttons with Media & Native Flow
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
caption: '๐๐ป Buttons and Native Flow!',
footer: '@itsliaaa/baileys',
buttons: [{
text: '๐๐ป Rating',
id: '#Rating'
}, {
text: '๐ Select',
sections: [{
title: 'โจ Section 1',
rows: [{
header: '',
title: '๐ญ Secret Ingredient',
description: '',
id: '#SecretIngredient'
}]
}, {
title: 'โจ Section 2',
highlight_label: '๐ฅ Popular',
rows: [{
header: '',
title: '๐ท๏ธ Coupon',
description: '',
id: '#CouponCode'
}]
}]
}]
}, {
quoted: message
})
```
#### ๐ List
> [!NOTE]
> It only works in private chat (`@s.whatsapp.net`).
```javascript
sock.sendMessage(jid, {
text: '๐ List!',
footer: '@itsliaaa/baileys',
buttonText: '๐ Select',
title: '๐๐ป Hello',
sections: [{
title: '๐ Menu 1',
rows: [{
title: 'โจ AI',
description: '',
rowId: '#AI'
}]
}, {
title: '๐ฑ Menu 2',
rows: [{
title: '๐ Search',
description: '',
rowId: '#Search'
}]
}]
}, {
quoted: message
})
```
#### ๐๏ธ Interactive
```javascript
// --- Native Flow
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
caption: '๐๏ธ๏ธ Interactive!',
footer: '@itsliaaa/baileys',
optionText: '๐๐ป Select Options', // --- Optional, wrap all native flow into a single list
optionTitle: '๐ Select Options', // --- Optional
offerText: '๐ท๏ธ Newest Coupon!', // --- Optional, add an offer into message
offerCode: '@itsliaaa/baileys', // --- Optional
offerUrl: 'https://www.npmjs.com/package/@itsliaaa/baileys', // --- Optional
offerExpiration: Date.now() + 3_600_000, // --- Optional
nativeFlow: [{
text: '๐๐ป Greeting',
id: '#Greeting',
icon: 'review' // --- Optional
}, {
text: '๐ Call',
call: '628123456789'
}, {
text: '๐ Copy',
copy: '@itsliaaa/baileys'
}, {
text: '๐ Source',
url: 'https://www.npmjs.com/package/@itsliaaa/baileys',
useWebview: true // --- Optional
}, {
text: '๐ Select',
sections: [{
title: 'โจ Section 1',
rows: [{
header: '',
title: '๐ท๏ธ Coupon',
description: '',
id: '#CouponCode'
}]
}, {
title: 'โจ Section 2',
highlight_label: '๐ฅ Popular',
rows: [{
header: '',
title: '๐ญ Secret Ingredient',
description: '',
id: '#SecretIngredient'
}]
}],
icon: 'default' // --- Optional
}],
interactiveAsTemplate: false, // --- Optional, wrap the interactive message into a template
}, {
quoted: message
})
// --- Carousel & Native Flow
sock.sendMessage(jid, {
text: '๐๏ธ Interactive with Carousel!',
footer: '@itsliaaa/baileys',
cards: [{
image: {
url: './path/to/image.jpg'
},
caption: '๐ผ๏ธ Image 1',
footer: '๐ท๏ธ๏ธ Pinterest',
nativeFlow: [{
text: '๐ Source',
url: 'https://www.npmjs.com/package/@itsliaaa/baileys',
useWebview: true
}]
}, {
image: {
url: './path/to/image.jpg'
},
caption: '๐ผ๏ธ Image 2',
footer: '๐ท๏ธ Pinterest',
offerText: '๐ท๏ธ New Coupon!',
offerCode: '@itsliaaa/baileys',
offerUrl: 'https://www.npmjs.com/package/@itsliaaa/baileys',
offerExpiration: Date.now() + 3_600_000,
nativeFlow: [{
text: '๐ Source',
url: 'https://www.npmjs.com/package/@itsliaaa/baileys'
}]
}, {
image: {
url: './path/to/image.jpg'
},
caption: '๐ผ๏ธ Image 3',
footer: '๐ท๏ธ Pinterest',
optionText: '๐๐ป Select Options',
optionTitle: '๐๐ป Select Options',
offerText: '๐ท๏ธ New Coupon!',
offerCode: '@itsliaaa/baileys',
offerUrl: 'https://www.npmjs.com/package/@itsliaaa/baileys',
offerExpiration: Date.now() + 3_600_000,
nativeFlow: [{
text: '๐ Product',
id: '#Product',
icon: 'default'
}, {
text: '๐ Source',
url: 'https://www.npmjs.com/package/@itsliaaa/baileys'
}]
}]
}, {
quoted: message
})
// --- Native Flow with Audio in the Footer
sock.sendMessage(jid, {
text: '๐ Music in the footer!',
audioFooter: {
url: './path/to/audio.mp3'
}, // --- Like other media upload methods, buffers and streams are supported
nativeFlow: [{
text: '๐๐ป Good, next',
id: '#Next',
icon: 'review'
}, {
text: '๐๐ป Skip',
id: '#Skip',
icon: 'default'
}]
}, {
quoted: message
})
```
#### ๐ซ Hydrated Template
```javascript
sock.sendMessage(jid, {
title: '๐๐ป Hello',
image: {
url: './path/to/image.jpg'
},
caption: '๐ซ Template!',
footer: '@itsliaaa/baileys',
templateButtons: [{
text: '๐๐ป Tap Here',
id: '#Order'
}, {
text: '๐ Source',
url: 'https://www.npmjs.com/package/@itsliaaa/baileys'
}, {
text: '๐ Call',
call: '628123456789'
}]
}, {
quoted: message
})
```
### ๐ณ Sending Payment Messages
#### โ Invite Payment
```javascript
sock.sendMessage(jid, {
paymentInviteServiceType: 3 // 1, 2, or 3
})
```
#### ๐งพ Invoice
> [!NOTE]
> Invoice message are not supported yet.
```javascript
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
invoiceNote: '๐ท๏ธ Invoice'
})
```
#### ๐๏ธ Order
```javascript
sock.sendMessage(chat, {
orderText: '๐๏ธ Order',
thumbnail: fs.readFileSync('./path/to/image.jpg') // --- Must in buffer format
}, {
quoted: message
})
```
#### ๐ณ Request Payment
```javascript
sock.sendMessage(jid, {
text: '๐ณ Request Payment',
requestPaymentFrom: '0@s.whatsapp.net'
})
```
### ๐๏ธ Other Message Options
#### ๐ค AI Icon
> [!NOTE]
> It only works in private chat (`@s.whatsapp.net`).
```javascript
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
caption: '๐ค With AI icon!',
ai: true
}, {
quoted: message
})
```
#### ๐ Ephemeral
> [!NOTE]
> Wrap message into `ephemeralMessage`
```javascript
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
caption: '๐๏ธ Ephemeral',
ephemeral: true
})
```
#### ๐ฐ External Ad Reply
> [!NOTE]
> Add an ad thumbnail to messages (may not be displayed on some WhatsApp versions).
```javascript
sock.sendMessage(jid, {
text: '๐ฐ External Ad Reply',
externalAdReply: {
title: '๐ Did you know?',
body: 'โ I dont know',
thumbnail: fs.readFileSync('./path/to/image.jpg'), // --- Must in buffer format
largeThumbnail: false, // --- Or true for bigger thumbnail
url: 'https://www.npmjs.com/package/@itsliaaa/baileys' // --- Optional, used for WhatsApp internal thumbnail caching and direct URL
}
}, {
quoted: message
})
```
#### ๐งโ๐งโ๐ง Group Status
> [!NOTE]
> It only works in group chat (`@g.us`)
```javascript
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
caption: '๐ฅ Group Status!',
groupStatus: true
})
```
#### ๐ฑ Lottie Sticker
> [!NOTE]
> Wrap message into `lottieStickerMessage`
```javascript
sock.sendMessage(jid, {
sticker: {
url: './path/to/sticker.webp'
},
isLottie: true
})
```
#### ๐งฉ Raw
```javascript
sock.sendMessage(jid, {
extendedTextMessage: {
text: '๐ Built manually from scratch using the raw WhatsApp proto structure',
contextInfo: {
externalAdReply: {
title: '@itsliaaa/baileys',
thumbnail: fs.readFileSync('./path/to/image.jpg'),
sourceApp: 'whatsapp',
showAdAttribution: true,
mediaType: 1
}
}
},
raw: true
}, {
quoted: message
})
```
#### ๐ท๏ธ Secure Meta Service Label
```javascript
sock.sendMessage(jid, {
text: '๐ท๏ธ Just a label!',
secureMetaServiceLabel: true
})
```
#### ๐ Spoiler
> [!NOTE]
> Wrap message into `spoilerMessage`
```javascript
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
caption: 'โ Spoiler',
spoiler: true
})
```
#### ๐๏ธ View Once
> [!NOTE]
> Wrap message into `viewOnceMessage`
```javascript
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
caption: '๐๏ธ View Once',
viewOnce: true
})
```
#### ๐๏ธ View Once V2
> [!NOTE]
> Wrap message into `viewOnceMessageV2`
```javascript
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
caption: '๐๏ธ View Once V2',
viewOnceV2: true
})
```
#### ๐๏ธ View Once V2 Extension
> [!NOTE]
> Wrap message into `viewOnceMessageV2Extension`
```javascript
sock.sendMessage(jid, {
image: {
url: './path/to/image.jpg'
},
caption: '๐๏ธ View Once V2 Extension',
viewOnceV2Extension: true
})
```
### โป๏ธ Modify Messages
#### ๐๏ธ Delete Messages
```javascript
sock.sendMessage(jid, {
delete: message.key
})
```
#### โ๏ธ Edit Messages
```javascript
// --- Edit plain text
sock.sendMessage(jid, {
text: 'โจ I mean, nice!',
edit: message.key
})
// --- Edit media messages caption
sock.sendMessage(jid, {
caption: 'โจ I mean, here is the image!',
edit: message.key
})
```
### ๐งฐ Additional Contents
#### ๐ท๏ธ Find User ID (JID|PN/LID)
> [!NOTE]
> The ID must contain numbers only (no +, (), or -) and must include the country code with WhatsApp ID format.
```javascript
// --- PN (Phone Number)
const phoneNumber = '6281111111111@s.whatsapp.net'
const ids = await sock.findUserId(phoneNumber)
console.log('๐ท๏ธ Got user ID', ':', ids)
// --- LID (Local Identifier)
const lid = '43411111111111@lid'
const ids = await sock.findUserId(lid)
console.log('๐ท๏ธ Got user ID', ':', ids)
// --- Output
// {
// phoneNumber: '6281111111111@s.whatsapp.net',
// lid: '43411111111111@lid'
// }
// --- Output when failed
// {
// phoneNumber: '6281111111111@s.whatsapp.net',
// lid: undefined
// }
// --- Same output shape regardless of input type
```
#### ๐ Request Custom Pairing Code
> [!NOTE]
> The phone number must contain numbers only (no +, (), or -) and must include the country code.
```javascript
const phoneNumber = '6281111111111'
const customPairingCode = 'STARFALL'
await sock.requestPairingCode(phoneNumber, customPairingCode)
console.log('๐ Pairing code', ':', customPairingCode)
```
#### ๐ผ๏ธ Image Processing
> [!NOTE]
> Automatically use available image processing library: `sharp`, `@napi-rs/image`, or `jimp`
```javascript
import { getImageProcessingLibrary } from '@itsliaaa/baileys'
import { readFile } from 'fs/promises'
const lib = await getImageProcessingLibrary()
const bufferOrFilePath = './path/to/image.jpg'
const width = 512
let output
// --- If sharp installed
if (lib.sharp?.default) {
const img = lib.sharp.default(bufferOrFilePath)
output = await img.resize(width)
.jpeg({ quality: 80 })
.toBuffer()
}
// --- If @napi-rs/image installed
else if (lib.image?.Transformer) {
// --- Must in buffer format
const inputBuffer = Buffer.isBuffer(bufferOrFilePath)
? bufferOrFilePath
: await readFile(bufferOrFilePath)
const img = new lib.image.Transformer(inputBuffer)
output = await img.resize(width, undefined, 0)
.jpeg(50)
}
// --- If jimp installed
else if (lib.jimp?.Jimp) {
const img = await lib.jimp.Jimp.read(bufferOrFilePath)
output = await img
.resize({ w: width, mode: lib.jimp.ResizeStrategy.BILINEAR })
.getBuffer('image/jpeg', { quality: 50 })
}
// --- Fallback
else {
throw new Error('No image processing available')
}
console.log('โ
Process completed!')
console.dir(output, { depth: null })
```
#### ๐ฃ Newsletter Management
```javascript
// --- Create a new one
sock.newsletterCreate('@itsliaaa/baileys', '๐ฃ Fresh updates weekly')
// --- Get info
const metadata = sock.newsletterMetadata('1231111111111@newsletter')
console.dir(metadata, { depth: null })
// --- Get subscribers count
const subscribers = await sock.newsletterSubscribers('1231111111111@newsletter')
console.dir(subscribers, { depth: null })
// --- Follow and Unfollow
sock.newsletterFollow('1231111111111@newsletter')
sock.newsletterUnfollow('1231111111111@newsletter')
// --- Mute and Unmute
sock.newsletterMute('1231111111111@newsletter')
sock.newsletterUnmute('1231111111111@newsletter')
// --- Demote admin
sock.newsletterDemote('1231111111111@newsletter', '6281111111111@s.whatsapp.net')
// --- Change owner
sock.newsletterChangeOwner('1231111111111@newsletter', '6281111111111@s.whatsapp.net')
// --- Update newsletter
sock.newsletterUpdate('1231111111111@newsletter', { name: '@itsliaaa/baileys' })
// --- Change name
sock.newsletterUpdateName('1231111111111@newsletter', '๐ฆ @itsliaaa/baileys')
// --- Change description
sock.newsletterUpdateDescription('1231111111111@newsletter', '๐ฃ Fresh updates weekly')
// --- Change photo
sock.newsletterUpdatePicture('1231111111111@newsletter', {
url: 'path/to/image.jpg'
})
// --- Remove photo
sock.newsletterRemovePicture('1231111111111@newsletter')
// --- React to a message
sock.newsletterReactMessage('1231111111111@newsletter', '100', '๐')
// --- Get admin count
const count = await sock.newsletterAdminCount('1231111111111@newsletter')
// --- Get all subscribed newsletters
const newsletters = await sock.newsletterSubscribed()
console.dir(newsletters, { depth: null })
// --- Fetch newsletter messages
const messages = sock.newsletterFetchMessages('jid', '1231111111111@newsletter', 50, 0, 0)
console.dir(messages, { depth: null })
// --- Delete newsletter
sock.newsletterDelete('1231111111111@newsletter')
```
#### ๐ฅ Group Management
```javascript
// --- Create a new one and add participants using their JIDs
const group = sock.groupCreate('@itsliaaa/baileys', ['628123456789@s.whatsapp.net'])
console.dir(group, { depth: null })
// --- Get info
const metadata = await sock.groupMetadata(jid)
console.dir(metadata, { depth: null })
// --- Get group invite code
const inviteCode = await sock.groupInviteCode(jid)
console.dir(inviteCode, { depth: null })
// --- Revoke invite link
sock.groupRevokeInvite(jid)
// --- Accept group invite
sock.groupAcceptInvite(inviteCode)
// --- Leave group
sock.groupLeave(jid)
// --- Add participants
sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'add')
// --- Remove participants
sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'remove')
// --- Promote to admin
sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'promote')
// --- Demote from admin
sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'demote')
// --- Accept join requests
sock.groupRequestParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'approve')
// --- Change name
sock.groupUpdateSubject(jid, '๐ฆ @itsliaaa/baileys')
// --- Change description
sock.groupUpdateDescription(jid, 'Updated description')
// --- Change photo
sock.updateProfilePicture(jid, {
url: 'path/to/image.jpg'
})
// --- Remove photo
sock.removeProfilePicture(jid)
// --- Set group as admin only for chatting
sock.groupSettingUpdate(jid, 'announcement')
// --- Set group as open to all for chatting
sock.groupSettingUpdate(jid, 'not_announcement')
// --- Set admin only can edit group info
sock.groupSettingUpdate(jid, 'locked')
// --- Set all participants can edit group info
sock.groupSettingUpdate(jid, 'unlocked')
// --- Set admin only can add participants
sock.groupMemberAddMode(jid, 'admin_add')
// --- Set all participants can add participants
sock.groupMemberAddMode(jid, 'all_member_add')
// --- Enable or disable temporary messages with seconds format
sock.groupToggleEphemeral(jid, 86400)
// --- Disable temporary messages
sock.groupToggleEphemeral(jid, 0)
// --- Enable or disable membership approval mode
sock.groupJoinApprovalMode(jid, 'on')
sock.groupJoinApprovalMode(jid, 'off')
// --- Get all groups metadata
const groups = await sock.groupFetchAllParticipating()
console.dir(groups, { depth: null })
// --- Get pending join requests
const requests = await sock.groupRequestParticipantsList(jid)
console.dir(requests, { depth: null })
// --- Get group info from link
const group = await sock.groupGetInviteInfo('ABC123456789')
console.log('๐ฅ Got group info from invite code', ':', group)
// --- Update bot member label
sock.updateMemberLabel(jid, '@itsliaaa/baileys')
```
#### ๐ฅ Community Management
```javascript
// --- Create a new one and add description
const community = await sock.communityCreate('@itsliaaa/baileys', '๐ฃ Fresh updates weekly')
console.dir(community, { depth: null })
// --- Create a subgroup for community and add participants using their JIDs
const group = await sock.communityCreateGroup('๐ข Announcements', ['628123456789@s.whatsapp.net'], communityJid)
// --- Link an existing group
sock.communityLinkGroup(groupJid, communityJid)
// --- Unlink an existing group
sock.communityUnlinkGroup(groupJid, communityJid)
// --- Get info
const metadata = await sock.communityMetadata(jid)
console.dir(metadata, { depth: null })
// --- Get community invite code
const inviteCode = await sock.communityInviteCode(jid)
console.dir(inviteCode, { depth: null })
// --- Revoke invite link
sock.communityRevokeInvite(jid)
// --- Accept community invite
sock.communityAcceptInvite(inviteCode)
// --- Leave community
sock.communityLeave(jid)
// --- Accept join requests
sock.communityRequestParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'approve')
// --- Change name
sock.communityUpdateSubject(jid, '๐ฆ @itsliaaa/baileys')
// --- Change description
sock.communityUpdateDescription(jid, 'Updated description')
// --- Set community as admin only for chatting
sock.communitySettingUpdate(jid, 'announcement')
// --- Set community as open to all for chatting
sock.communitySettingUpdate(jid, 'not_announcement')
// --- Set admin only can edit community info
sock.communitySettingUpdate(jid, 'locked')
// --- Set all participants can edit community info
sock.communitySettingUpdate(jid, 'unlocked')
// --- Set admin only can add participants
sock.communityMemberAddMode(jid, 'admin_add')
// --- Set all participants can add participants
sock.communityMemberAddMode(jid, 'all_member_add')
// --- Enable or disable temporary messages with seconds format
sock.communityToggleEphemeral(jid, 86400)
// --- Disable temporary messages
sock.communityToggleEphemeral(jid, 0)
// --- Enable or disable membership approval mode
sock.communityJoinApprovalMode(jid, 'on')
sock.communityJoinApprovalMode(jid, 'off')
// --- Get all communities metadata
const communities = await sock.communityFetchAllParticipating()
console.dir(communities, { depth: null })
// --- Get all community linked groups
const linked = await sock.communityFetchLinkedGroups(jid)
console.dir(linked, { depth: null })
// --- Get pending join requests
const requests = await sock.communityRequestParticipantsList(jid)
console.dir(requests, { depth: null })
// --- Get community info from link
const community = await sock.communityGetInviteInfo('ABC123456789')
console.log('๐ฅ Got community info from invite code', ':', community)
```
#### ๐ค Profile Management
```javascript
// --- Get user profile picture
const url = await sock.profilePictureUrl(jid, 'image')
console.log('๐ผ๏ธ Got user profile url', url)
// --- Update profile picture
sock.updateProfilePicture(jid, buffer)
sock.updateProfilePicture(jid, { url })
// --- Remove profile picture
sock.removeProfilePicture(jid)
// --- Update profile name
sock.updateProfileName('My Name')
// --- Update profile status
sock.updateProfileStatus('Available')
// --- Presence
sock.sendPresenceUpdate('available', jid)
sock.presenceSubscribe(jid)
// --- Read receipts
sock.readMessages([message.key])
sock.sendReceipt(jid, participant, [messageId], 'read')
// --- Block user
sock.updateBlockStatus(jid, 'block')
// --- Unblock user
sock.updateBlockStatus(jid, 'unblock')
// --- Fetch blocklist
const blocked = await sock.fetchBlocklist()
console.dir(blocked, { depth: null })
// --- Modify chats
sock.chatModify({
archive: true,
lastMessageOrig: message,
lastMessage: message
}, jid)
// --- Star messages
sock.star(jid, [{ id: messageId, fromMe: true }], true)
// --- Contact
sock.addOrEditContact(jid, { displayName: 'Starseed' })
sock.removeContact(jid)
// --- Label
sock.addChatLabel(jid, labelId)
sock.removeChatLabel(jid, labelId)
sock.addMessageLabel(jid, messageId, labelId)
// --- App state sync
sock.resyncAppState(['regular', 'critical_block'], true)
// --- Get business profile
const profile = await sock.getBusinessProfile(jid)
console.dir(profile, { depth: null })
```
#### ๐ Business Management
```javascript
// --- Create a new product
const product = await sock.productCreate({
name: '๐งฉ Starseed (Premium)',
description: 'Get a full version of Starseed!',
price: 100000,
currency: 'IDR',
originCountryCode: 'ID',
images: [
bufferImage,
{
url: './path/to/image.jpg'
}
]
})
console.dir(product, { depth: null })
// --- Update product
await sock.productUpdate(productId, {
name: '๐งฉ Starseed (Premium)',
description: 'Get a full version of Starseed with more features!',
price: 75000,
currency: 'IDR',
images: [
{
url: './path/to/image.jpg'
}
]
})
// --- Delete product
sock.productDelete([productId])
// --- Get catalog info
const { products, nextPageCursor } = await sock.getCatalog({
jid: '628123456789@s.whatsapp.net',
limit: 10
})
// --- Get collections
const collections = await sock.getCollections('628123456789@s.whatsapp.net', 10)
console.dir(collections, { depth: null })
// --- Get order info
const order = await sock.getOrderDetails(orderId, tokenBase64)
console.dir(order, { depth: null })
// --- Update business profile
await sock.updateBusinessProfile({
address: 'Jakarta, Indonesia',
description: '๐ Official Starseed Store',
websites: ['https://www.npmjs.com/package/@itsliaaa/baileys'],
email: 'more-more@gmail.com',
hours: {
timezone: 'Asia/Jakarta',
days: [{ day: 'mon', mode: 'open_24h' }]
}
})
// --- Update cover
sock.updateCoverPhoto({
url: './path/to/image.jpg'
})
// --- Remove cover
sock.removeCoverPhoto(coverId)
// --- Update quick replies
sock.addOrEditQuickReply({
shortcut: 'hello',
message: 'Hello from business account',
})
// --- Remove quick reply
sock.removeQuickReply(timestamp)
```
#### ๐ Privacy Management
```javascript
// --- Update last seen privacy
sock.updateLastSeenPrivacy('all')
sock.updateLastSeenPrivacy('contacts')
sock.updateLastSeenPrivacy('contact_blacklist')
sock.updateLastSeenPrivacy('nobody')
// --- Update online privacy
sock.updateOnlinePrivacy('all')
sock.updateOnlinePrivacy('match_last_seen')
// --- Update profile picture privacy
sock.updateProfilePicturePrivacy('contacts')
// --- Update status privacy
sock.updateStatusPrivacy('contacts')
// --- Update read receipts privacy
sock.updateReadReceiptsPrivacy('all')
sock.updateReadReceiptsPrivacy('none')
// --- Update groups add privacy
sock.updateGroupsAddPrivacy('all')
sock.updateGroupsAddPrivacy('contacts')
// --- Update messages privacy
sock.updateMessagesPrivacy('all')
sock.updateMessagesPrivacy('contacts')
sock.updateMessagesPrivacy('nobody')
// --- Update call privacy
sock.updateCallPrivacy('everyone')
// --- Update default disappearing mode
sock.updateDefaultDisappearingMode(86400)
// --- Update link previews privacy
sock.updateDisableLinkPreviewsPrivacy(true)
```
#### ๐ก Events
```javascript
sock.ev.on('connection.update', (update) => {})
sock.ev.on('creds.update', (update) => {})
sock.ev.on('messaging-history.set', (update) => {})
sock.ev.on('messaging-history.status', (update) => {})
sock.ev.on('chats.upsert', (update) => {})
sock.ev.on('chats.update', (update) => {})
sock.ev.on('chats.delete', (update) => {})
sock.ev.on('chats.lock', (update) => {})
sock.ev.on('lid-mapping.update', (update) => {})
sock.ev.on('presence.update', (update) => {})
sock.ev.on('contacts.upsert', (update) => {})
sock.ev.on('contacts.update', (update) => {})
sock.ev.on('messages.delete', (update) => {})
sock.ev.on('messages.update', (update) => {})
sock.ev.on('messages.media-update', (update) => {})
sock.ev.on('messages.upsert', (update) => {})
sock.ev.on('messages.reaction', (update) => {})
sock.ev.on('message-receipt.update', (update) => {})
sock.ev.on('groups.upsert', (update) => {})
sock.ev.on('groups.update', (update) => {})
sock.ev.on('group-participants.update', (update) => {})
sock.ev.on('group.join-request', (update) => {})
sock.ev.on('group.member-tag.update', (update) => {})
sock.ev.on('blocklist.set', (update) => {})
sock.ev.on('blocklist.update', (update) => {})
sock.ev.on('call', (update) => {})
sock.ev.on('labels.edit', (update) => {})
sock.ev.on('labels.association', (update) => {})
sock.ev.on('newsletter.reaction', (update) => {})
sock.ev.on('newsletter.view', (update) => {})
sock.ev.on('newsletter-participants.update', (update) => {})
sock.ev.on('newsletter-settings.update', (update) => {})
sock.ev.on('settings.update', (update) => {})
```
### ๐ Try the Bot
A fast, lightweight, and modular WhatsApp bot built with [@itsliaaa/baileys](https://www.npmjs.com/package/@itsliaaa/baileys).
Perfect for managing groups, moderating chats, and adding fun with quiz games and handy tools.
๐๐ป [@itsliaaa/starseed](https://github.com/itsliaaa/starseed#readme)
### ๐ฆ Fork Base
This fork is based on [Baileys (GitHub)](https://github.com/WhiskeySockets/Baileys)
### ๐ฃ Credits
Full credit is attributed to the original maintainers and contributors of Baileys:
- [purpshell](https://github.com/purpshell)
- [jlucaso1](https://github.com/jlucaso1)
- [adiwajshing](https://github.com/adiwajshing)
This fork includes additional enhancements and modifications by [Lia Wynn](https://github.com/itsliaaa)
Special thanks to [itsreimau](https://github.com/itsreimau) for the fix to the `updateBlockStatus` implementation.
> [!CAUTION]
> โ ๏ธ **Modification, removal, or misrepresentation of these credits is strictly prohibited. Any redistribution or fork must preserve this section in its original form without exception.**