@im-dims/baileys-md
v7.2.3
Published
WhatsApp API Fixed By SSA Team
Readme
Warning !
This Baileys has been re-modified by @Im-Dims. you are free to use, modify, copy, and publish it, but do not use it for illegal purposes, sell it, monetize it, or turn it into a closed-source project.
Important Note
This library was originally a project for CS-2362 at Ashoka University and is in no way affiliated with or endorsed by WhatsApp. Use at your own discretion. Do not spam people with this. We discourage any stalkerware, bulk or automated messaging usage.
Liability and License Notice
Baileys and its maintainers cannot be held liable for misuse of this application, as stated in the MIT license. The maintainers of Baileys do not in any way condone the use of this application in practices that violate the Terms of Service of WhatsApp. The maintainers of this application call upon the personal responsibility of its users to use this application in a fair way, as it is intended to be used.
- Baileys does not require Selenium or any other browser to be interface with WhatsApp Web, it does so directly using a WebSocket.
- Not running Selenium or Chromimum saves you like half a gig of ram :/
- Baileys supports interacting with the multi-device & web versions of WhatsApp.
- Thank you to @pokearaujo for writing his observations on the workings of WhatsApp Multi-Device. Also, thank you to @Sigalor for writing his observations on the workings of WhatsApp Web and thanks to @Rhymen for the go implementation.
[!IMPORTANT] The original repository had to be removed by the original author - we now continue development in this repository here. This is the only official repository and is maintained by the community. Join the Discord here
Example
Do check out & run example.ts to see an example usage of the library. The script covers most common use cases. To run the example script, download or clone the repo and then type the following in a terminal:
cd path/to/Baileysyarnyarn example
Install
Use the stable version:
yarn add @im-dims/baileys-mdUse the edge version (no guarantee of stability, but latest fixes + features)
yarn add github:Im-Dims/baileys-mdThen import your code using:
const makeWASocket = require('@im-dims/baileys-md')Links
Index
- Non-Media Messages
- Text Message
- Quote Message
- Mention User
- Forward Messages
- Location Message
- Live Location Message
- Contact Message
- Reaction Message
- Pin Message
- Keep Message
- Poll Message
- Poll Result Message
- Call Message
- Event Message
- Order Message
- Product Message
- Payment Message
- Payment Invite Message
- Admin Invite Message
- Group Invite Message
- Share Phone Number Message
- Request Phone Number Message
- Buttons Reply Message
- Buttons Message
- Buttons List Message
- Buttons Product List Message
- Buttons Cards Message
- Buttons Template Message
- Buttons Interactive Message
- Status Mentions Message
- Send Album Message
- Shop Message
- Collection Message
- Sending with Link Preview
- Media Messages
- Non-Media Messages
- Create a Group
- Add/Remove or Demote/Promote
- Change Subject (name)
- Change Description
- Change Settings
- Leave a Group
- Get Invite Code
- Revoke Invite Code
- Join Using Invitation Code
- Get Group Info by Invite Code
- Query Metadata (participants, name, description...)
- Join using groupInviteMessage
- Get Request Join List
- Approve/Reject Request Join
- Get All Participating Groups Metadata
- Toggle Ephemeral
- Change Add Mode
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.
[!NOTE] Here is a simple example of event handling
[!TIP] You can see all supported socket configs here (Recommended)
Starting socket with QR-CODE
[!TIP] You can customize browser name if you connect with QR-CODE, with
Browserconstant, we have some browsers config, see here
const makeWASocket = require('@im-dims/baileys-md')
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
The phone number can't have + or () or -, only numbers, you must provide country code
const makeWASocket = require('@im-dims/baileys-md')
const sock = makeWASocket({
// can provide additional config here
printQRInTerminal: false //need to be false
})
if (!sock.authState.creds.registered) {
const number = 'XXXXXXXXXXX'
const code = await sock.requestPairingCode(number) // or await sock.requestPairingCode(number, 'CODEOTPS') custom your pairing code
console.log(code)
}Receive Full History
- Set
syncFullHistoryastrue - 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:
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
cachedGroupMetadatain socket config, you need to implement a cache like this: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
getMessageconfig in socket like this:const sock = makeWASocket({ getMessage: async (key) => await getMessageFromStore(key) })
Receive Notifications in Whatsapp App
- If you want to receive notifications in whatsapp app, set
markOnlineOnConnecttofalseconst sock = makeWASocket({ markOnlineOnConnect: false })
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:
const makeWASocket, { useMultiFileAuthState } = require('@im-dims/baileys-md')
const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys')
// 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)[!IMPORTANT]
useMultiFileAuthStateis 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. TheuseMultiFileAuthStatefunction 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, it's important you see all events
You can listen to these events like this:
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
const makeWASocket, { DisconnectReason, useMultiFileAuthState } = require('@im-dims/baileys-md')
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()For example if you use useSingleFileAuthState and useMongoFileAuthState
const makeWASocket, { useSingleFileAuthState, useMongoFileAuthState } = require('@im-dims/baileys-md')
// Single Auth
const { state, saveState } = await useSingleFileAuthState('./auth_info_baileys.json')
const sock = makeWASocket({
auth: state,
printQRInTerminal: true
})
sock.ev.on('creds.update', saveState)
// Mongo Auth
const { MongoClient } = require("mongodb")
const connectAuth = async() => {
global.client = new MongoClient('mongoURL');
global.client.connect(err => {
if (err) {
console.warn("Warning: MongoDB link is invalid or cannot be connected.");
} else {
console.log('Successfully Connected To MongoDB Server')
}
})
await client.connect()
const collection = client.db("@kasumi").collection("sessions")
return collection
}
const Authentication = await connectAuth();
const { state, saveCreds } = await useMongoFileAuthState(Authentication);
const sock = makeWASocket({
auth: state,
printQRInTerminal: true
})
sock.ev.on('creds.update', saveCreds)[!IMPORTANT] In
messages.upsertit's recommended to use a loop likefor (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
const pino = require("pino");
const { makeInMemoryStore, getAggregateVotesInPollMessage } = require('@im-dims/baileys-md');
const logger = pino({ timestamp: () => `,"time":"${new Date().toJSON()}"` }).child({ class: "@kasumi" });
logger.level = "fatal";
const store = makeInMemoryStore({ logger });
async function getMessage(key){
if (store) {
const msg = await store.loadMessage(key.remoteJid, key.id)
return msg?.message
}
return {
conversation: "Hi There!"
}
}
sock.ev.on("messages.update", async (chatUpdate) => {
for(const { key, update } of chatUpdate) {
if(update.pollUpdates && key.fromMe) {
const pollCreation = await getMessage(key)
if(pollCreation) {
const pollUpdate = await getAggregateVotesInPollMessage({
message: pollCreation,
pollUpdates: update.pollUpdates,
})
const toCmd = pollUpdate.filter(v => v.voters.length !== 0)[0]?.name
if (toCmd == undefined) return
console.log(toCmd)
}
}
}
})Summary of Events on First Connection
- When you connect first time,
connection.updatewill be fired requesting you to restart sock - 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:
const makeWASocket, { makeInMemoryStore } = require('@im-dims/baileys-md')
// 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
idis the WhatsApp ID, calledjidtoo, 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:
[email protected]. - For groups, it must be in the format
[email protected].
- Example for people:
- For broadcast lists, it's
[timestamp of creation]@broadcast. - For stories, the ID is
status@broadcast.
- It must be in the format
Utility Functions
getContentType, returns the content type for any messagegetDevice, returns the device from messagemakeCacheableSignalKeyStore, make auth store more fastdownloadContentFromMessage, download content from any message
Sending Messages
- Send all types of messages with a single function
const jid: string
const content: AnyMessageContent
const options: MiscMessageGenerationOptions
sock.sendMessage(jid, content, options)Non-Media Messages
Text Message
await sock.sendMessage(jid, { text: 'hello word' })Quote Message (works with all types)
await sock.sendMessage(jid, { text: 'hello word' }, { quoted: message })Mention User (works with most types)
- @number is to mention in text, it's optional
await sock.sendMessage(jid, {
text: '@12345678901',
mentions: ['[email protected]']
})Forward Messages
const msg = getMessageFromStore() // implement this on your end
await sock.sendMessage(jid, { forward: msg, force: true or number }) // WA forward the message!Location Message
await sock.sendMessage(jid, {
location: {
degreesLatitude: 24.121231,
degreesLongitude: 55.1121221
}
})Live Location Message
await sock.sendMessage(jid, {
location: {
degreesLatitude: 24.121231,
degreesLongitude: 55.1121221
},
live: true
})Contact Message
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: 'kasumi',
contacts: [{
vcard
}]
}
})Reaction Message
await sock.sendMessage(jid, {
react: {
text: '💖', // use an empty string to remove the reaction
key: message.key
}
})Pin Message
| Time | Seconds | |-------|----------------| | 24h | 86.400 | | 7d | 604.800 | | 30d | 2.592.000 |
await sock.sendMessage(jid, {
pin: {
type: 1, // 2 to remove
time: 86400,
key: Key
}
})Keep Message
await sock.sendMessage(jid, {
keep: {
key: Key,
type: 1 // or 2
}
})Poll Message
await sock.sendMessage(jid, {
poll: {
name: 'My Poll',
values: ['Option 1', 'Option 2', ...],
selectableCount: 1,
toAnnouncementGroup: false // or true
}
})Poll Result Message
await sock.sendMessage(jid, {
pollResult: {
name: 'Hi Everyone',
values: [
[
'Option 1',
1000
],
[
'Option 2',
2000
]
]
}
})Call Message
await sock.sendMessage(jid, {
call: {
name: 'Hi Everyone',
type: 1 // 2 for video
}
})Event Message
await sock.sendMessage(jid, {
event: {
isCanceled: false, // or true
name: 'holiday together!',
description: 'who wants to come along?',
location: {
degreesLatitude: 24.121231,
degreesLongitude: 55.1121221,
name: 'name'
},
startTime: number,
endTime: number,
extraGuestsAllowed: true // or false
}
})Order Message
await sock.sendMessage(jid, {
order: {
orderId: '574xxx',
thumbnail: 'your_thumbnail',
itemCount: 'your_count',
status: 'your_status', // INQUIRY || ACCEPTED || DECLINED
surface: 'CATALOG',
message: 'your_caption',
orderTitle: 'your_title',
sellerJid: 'your_jid',
token: 'your_token',
totalAmount1000: 'your_amount',
totalCurrencyCode: 'IDR'
}
})Product Message
await sock.sendMessage(jid, {
product: {
productImage: { // for using buffer >> productImage: your_buffer
url: 'your_url'
},
productId: 'your_id',
title: 'your_title',
description: 'your_description',
currencyCode: 'IDR',
priceAmount1000: 'your_amount',
retailerId: 'your_reid', // optional use if needed
url: 'your_url', // optional use if needed
productImageCount: 'your_imageCount',
firstImageId: 'your_image', // optional use if needed
salePriceAmount1000: 'your_priceSale',
signedUrl: 'your_url' // optional use if needed
},
businessOwnerJid: 'your_jid'
})Payment Message
await sock.sendMessage(jid, {
payment: {
note: 'Hi!',
currency: 'IDR', // optional
offset: 0, // optional
amount: '10000', // optional
expiry: 0, // optional
from: '[email protected]', // optional
image: { // optional
placeholderArgb: 'your_background', // optional
textArgb: 'your_text', // optional
subtextArgb: 'your_subtext' // optional
}
}
})Payment Invite Message
await sock.sendMessage(id, {
paymentInvite: {
type: number, // 1 || 2 || 3
expiry: 0
}
})Admin Invite Message
await sock.sendMessage(jid, {
adminInvite: {
jid: '123xxx@newsletter',
name: 'Ssa Team',
caption: 'Please be my channel admin',
expiration: 86400,
jpegThumbnail: Buffer // optional
}
})Group Invite Message
await sock.sendMessage(jid, {
groupInvite: {
jid: '[email protected]',
name: 'Ssa Team',
caption: 'Please Join My Whatsapp Group',
code: 'code_invite',
expiration: 86400,
jpegThumbnail: Buffer, // optional
}
})Share Phone Number Message
await sock.sendMessage(jid, {
sharePhoneNumber: {}
})Request Phone Number Message
await sock.sendMessage(jid, {
requestPhoneNumber: {}
})Buttons Reply Message
// List
await sock.sendMessage(jid, {
buttonReply: {
name: 'Hii',
description: 'description',
rowId: 'ID'
},
type: 'list'
})
// Plain
await sock.sendMessage(jid, {
buttonReply: {
displayText: 'Hii',
id: 'ID'
},
type: 'plain'
})
// Template
await sock.sendMessage(jid, {
buttonReply: {
displayText: 'Hii',
id: 'ID',
index: 'number'
},
type: 'template'
})
// Interactive
await sock.sendMessage(jid, {
buttonReply: {
body: 'Hii',
nativeFlows: {
name: 'menu_options',
paramsJson: JSON.stringify({
id: 'ID',
description: 'description'
}),
version: 1 // 2 | 3
}
},
type: 'interactive'
})Buttons Message
await sock.sendMessage(jid, {
text: 'This is a button message!', // image: buffer or // image: { url: url } If you want to use images
caption: 'caption', // Use this if you are using an image or video
footer: '© 2025 - Ssa Team',
buttons: [
{
buttonId: 'Id1',
buttonText: {
displayText: 'Button 1'
}
},
{
buttonId: 'Id2',
buttonText: {
displayText: 'Button 2'
}
},
{
buttonId: 'Id3',
buttonText: {
displayText: 'Button 3'
}
}
]
})Buttons List Message
// Just working in a private chat
await sock.sendMessage(jid, {
text: 'This is a list!',
footer: '© 2025 - Ssa Team',
title: 'Amazing boldfaced list title',
buttonText: 'Required, text on the button to view the list',
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'
}
]
}
]
})Buttons Product List Message
// Just working in a private chat
await sock.sendMessage(jid, {
text: 'This is a list!',
footer: '© 2025 - Ssa Team',
title: 'Amazing boldfaced list title',
buttonText: 'Required, text on the button to view the list',
productList: [{
title: 'This is a title',
products: [
{
productId: '1234'
},
{
productId: '5678'
}
]
}],
businessOwnerJid: '[email protected]',
thumbnail: 'https://example.jpg' // or buffer
})Buttons Cards Message
await sock.sendMessage(jid, {
text: 'Body Message',
title: 'Title Message',
subtile: 'Subtitle Message',
footer: 'Footer Message',
cards: [
{
image: {
url: 'https://example.jpg'
}, // or buffer
title: 'Title Cards',
body: 'Body Cards',
footer: 'Footer Cards',
buttons: [
{
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'
})
}
]
},
{
video: {
url: 'https://example.mp4'
}, // or buffer
title: 'Title Cards',
body: 'Body Cards',
footer: 'Footer Cards',
buttons: [
{
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'
})
}
]
}
]
})Buttons Template Message
await sock.sendMessage(jid, {
text: 'This is a template message!',
footer: '© 2025 - Ssa Team',
templateButtons: [{
index: 1,
urlButton: {
displayText: 'Follow Me',
url: 'https://api.ssateam.my.id'
},
},
{
index: 2,
callButton: {
displayText: 'Call Me!',
phoneNumber: '628xxx'
},
},
{
index: 3,
quickReplyButton: {
displayText: 'This is a reply, just like normal buttons!',
id: 'id-like-buttons-message'
},
}
]
})Buttons Interactive Message
await sock.sendMessage(jid, {
text: 'This is an Interactive message!',
title: 'Hiii',
subtitle: 'There is a subtitle',
footer: '© 2025 - Ssa Team',
interactiveButtons: [
{
name: 'quick_reply',
buttonParamsJson: JSON.stringify({
display_text: 'quick reply',
id: 'your_id'
})
},
{
name: 'cta_url',
buttonParamsJson: JSON.stringify({
display_text: 'cta url',
url: 'https://api.ssateam.my.id',
merchant_url: 'https://api.ssateam.my.id'
})
},
{
name: 'cta_copy',
buttonParamsJson: JSON.stringify({
display_text: 'cta copy',
copy_code: '1234'
})
},
{
name: 'cta_call',
buttonParamsJson: JSON.stringify({
display_text: 'cta call',
phone_number: '628xxx'
})
},
{
name: 'cta_catalog',
buttonParamsJson: JSON.stringify({
business_phone_number: '628xxx'
})
},
{
name: 'cta_reminder',
buttonParamsJson: JSON.stringify({
display_text: 'cta reminder'
})
},
{
name: 'cta_cancel_reminder',
buttonParamsJson: JSON.stringify({
display_text: 'cta cancel reminder'
})
},
{
name: 'address_message',
buttonParamsJson: JSON.stringify({
display_text: 'address message'
})
},
{
name: 'send_location',
buttonParamsJson: JSON.stringify({
display_text: 'send location'
})
},
{
name: 'open_webview',
buttonParamsJson: JSON.stringify({
title: 'open webview',
link: {
in_app_webview: true, // or false
url: 'https://api.ssateam.my.id'
}
})
},
{
name: 'mpm',
buttonParamsJson: JSON.stringify({
product_id: '8816262248471474'
})
},
{
name: 'wa_payment_transaction_details',
buttonParamsJson: JSON.stringify({
transaction_id: '12345848'
})
},
{
name: 'automated_greeting_message_view_catalog',
buttonParamsJson: JSON.stringify({
catalog_id: '12345848'
})
},
{
name: 'single_select',
buttonParamsJson: JSON.stringify({
title: 'single select',
sections: [{
title: 'Title 1',
highlight_label: 'Highlight label 1',
rows: [
{
header: 'Header 1',
title: 'Title 1',
description: 'Description 1',
id: 'Id 1'
},
{
header: 'Header 2',
title: 'Title 2',
description: 'Description 2',
id: 'Id 2'
}
]
}]
})
}
]
})Buttons Interactive Message ( with other options )
// If you want to use an image
await sock.sendMessage(jid, {
image: {
url: 'https://example.jpg'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
interactiveButtons: [{
name: 'quick_reply',
buttonParamsJson: JSON.stringify({
display_text: 'DisplayText',
id: 'ID1'
})
}],
hasMediaAttachment: false // or true
})
// If you want to use an video
await sock.sendMessage(jid, {
video: {
url: 'https://example.mp4'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
interactiveButtons: [{
name: 'quick_reply',
buttonParamsJson: JSON.stringify({
display_text: 'DisplayText',
id: 'ID1'
})
}],
hasMediaAttachment: false // or true
})
// If you want to use an document
await sock.sendMessage(jid, {
document: {
url: 'https://example.jpg'
},
mimetype: 'image/jpeg',
jpegThumbnail: await sock.resize('https://example.jpg', 320, 320),
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
interactiveButtons: [{
name: 'quick_reply',
buttonParamsJson: JSON.stringify({
display_text: 'DisplayText',
id: 'ID1'
})
}],
hasMediaAttachment: false // or true
})
// If you want to use an location
await sock.sendMessage(jid, {
location: {
degressLatitude: -0,
degressLongitude: 0,
name: 'Hi'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
interactiveButtons: [{
name: 'quick_reply',
buttonParamsJson: JSON.stringify({
display_text: 'DisplayText',
id: 'ID1'
})
}],
hasMediaAttachment: false // or true
})
// if you want to use an product
await sock.sendMessage(jid, {
product: {
productImage: {
url: 'https://example.jpg'
},
productId: '836xxx',
title: 'Title',
description: 'Description',
currencyCode: 'IDR',
priceAmount1000: '283xxx',
retailerId: 'kasumi',
url: 'https://api.ssateam.my.id',
productImageCount: 1
},
businessOwnerJid: '[email protected]',
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
interactiveButtons: [{
name: 'quick_reply',
buttonParamsJson: JSON.stringify({
display_text: 'DisplayText',
id: 'ID1'
})
}],
hasMediaAttachment: false // or true
})Status Mentions Message
await sock.sendStatusMentions(jid, {
image: {
url: 'https://api.ssateam.my.id.jpg'
},
caption: 'Hi'
}, 'Check this out')Send Album Message
await sock.sendAlbumMessage(jid, [
{
type: 'image', or video
data: Buffer // or data: { url: 'https://example.jpg' }
caption: 'caption'
}
], { quoted: 'message' , annotations: [] delay: '5000' })Shop Message
await sock.sendMessage(jid, {
text: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
shop: {
surface: 1, // 2 | 3 | 4
id: 'https://api.ssateam.my.id'
},
viewOnce: true
})Shop Message ( with other options )
// Image
await sock.sendMessage(jid, {
image: {
url: 'https://example.jpg'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
shop: {
surface: 1, // 2 | 3 | 4
id: 'https://api.ssateam.my.id'
},
hasMediaAttachment: false, // or true
viewOnce: true
})
// Video
await sock.sendMessage(jid, {
video: {
url: 'https://example.jpg'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
shop: {
surface: 1, // 2 | 3 | 4
id: 'https://api.ssateam.my.id'
},
hasMediaAttachment: false, // or true
viewOnce: true
})
// Document
await sock.sendMessage(jid, {
document: {
url: 'https://example.jpg'
},
mimetype: 'image/jpeg',
jpegThumbnail: await sock.resize('https://example.jpg', 320, 320),
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
shop: {
surface: 1, // 2 | 3 | 4
id: 'https://api.ssateam.my.id'
},
hasMediaAttachment: false, // or true,
viewOnce: true
})
// Location
await sock.sendMessage(jid, {
location: {
degressLatitude: -0,
degressLongitude: 0,
name: 'Hi'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
shop: {
surface: 1, // 2 | 3 | 4
id: 'https://api.ssateam.my.id'
},
hasMediaAttachment: false, // or true
viewOnce: true
})
// Product
await sock.sendMessage(jid, {
product: {
productImage: {
url: 'https://example.jpg'
},
productId: '836xxx',
title: 'Title',
description: 'Description',
currencyCode: 'IDR',
priceAmount1000: '283xxx',
retailerId: 'kasumi',
url: 'https://api.ssateam.my.id',
productImageCount: 1
},
businessOwnerJid: '[email protected]',
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
shop: {
surface: 1, // 2 | 3 | 4
id: 'https://api.ssateam.my.id'
},
hasMediaAttachment: false, // or true
viewOnce: true
})Collection Message
await sock.sendMessage(jid, {
text: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
collection: {
bizJid: 'jid',
id: 'https://api.ssateam.my.id',
version: 1
},
viewOnce: true
})
// Image
await sock.sendMessage(jid, {
image: {
url: 'https://example.jpg'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
collection: {
bizJid: 'jid',
id: 'https://api.ssateam.my.id',
version: 1
},
hasMediaAttachment: false, // or true
viewOnce: true
})
// Video
await sock.sendMessage(jid, {
video: {
url: 'https://example.jpg'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
collection: {
bizJid: 'jid',
id: 'https://api.ssateam.my.id',
version: 1
},
hasMediaAttachment: false, // or true
viewOnce: true
})
// Document
await sock.sendMessage(jid, {
document: {
url: 'https://example.jpg'
},
mimetype: 'image/jpeg',
jpegThumbnail: await sock.resize('https://example.jpg', 320, 320),
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
collection: {
bizJid: 'jid',
id: 'https://api.ssateam.my.id',
version: 1
},
hasMediaAttachment: false, // or true,
viewOnce: true
})
// Location
await sock.sendMessage(jid, {
location: {
degressLatitude: -0,
degressLongitude: 0,
name: 'Hi'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
collection: {
bizJid: 'jid',
id: 'https://api.ssateam.my.id',
version: 1
},
hasMediaAttachment: false, // or true
viewOnce: true
})
// Product
await sock.sendMessage(jid, {
product: {
productImage: {
url: 'https://example.jpg'
},
productId: '836xxx',
title: 'Title',
description: 'Description',
currencyCode: 'IDR',
priceAmount1000: '283xxx',
retailerId: 'kasumi',
url: 'https://api.ssateam.my.id',
productImageCount: 1
},
businessOwnerJid: '[email protected]',
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
collection: {
bizJid: 'jid',
id: 'https://api.ssateam.my.id',
version: 1
},
hasMediaAttachment: false, // or true
viewOnce: true
})Sending Messages with Link Previews
- By default, wa does not have link generation when sent from the web
- Baileys has a function to generate the content for these link previews
- To enable this function's usage, add
link-preview-jsas a dependency to your project withyarn add link-preview-js - Send a link:
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 }orBufferdirectly, you can see more here
- 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
.giffiles, that's why we send gifs as common.mp4video withgifPlaybackflag
await sock.sendMessage(jid, {
video: fs.readFileSync('Media/ma_gif.mp4'),
caption: 'hello word',
gifPlayback: true
})Video Message
await sock.sendMessage(id, {
video: {
url: './Media/ma_gif.mp4'
},
caption: 'hello word',
})Ptv Video Message
await sock.sendMessage(id, {
video: {
url: './Media/ma_gif.mp4'
},
ptv: true
})Audio Message
- To audio message work in all devices you need to convert with some tool like
ffmpegwith this flags:codec: libopus //ogg file ac: 1 //one channel avoid_negative_ts make_zero- Example:
ffmpeg -i input.mp4 -avoid_negative_ts make_zero -ac 1 output.ogg
await sock.sendMessage(jid, {
audio: {
url: './Media/audio.mp3'
},
mimetype: 'audio/mp4'
})Image Message
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 passviewOnce: truein content object
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)
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
Editing Messages
- You can pass all editable contents here
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
jimporsharpas a dependency in your project usingyarn add jimporyarn add sharp. - Thumbnails for videos can also be generated automatically, though, you need to have
ffmpeginstalled on your system.
Downloading Media Messages
If you want to save the media you received
const { createWriteStream } = require('fs')
const { downloadMediaMessage, getContentType } = require('@im-dims/baileys-md')
// Use the built-in logger or console if not available
const logger = console
sock.ev.on('messages.upsert', async ({ messages: [m] }) => {
try {
if (!m.message) return // stop if the message is empty
const messageType = getContentType(m.message) // get the message type
// if the message is an image
if (messageType === 'imageMessage') {
// download the media
const stream = await downloadMediaMessage(m, 'stream', {}, {
logger,
reuploadRequest: sock.updateMediaMessage // request reupload if media is deleted
})
// save to a file
const writeStream = createWriteStream('./my-download.jpeg')
stream.pipe(writeStream)
writeStream.on('finish', () => {
console.log('Image successfully downloaded and saved as my-download.jpeg')
})
}
} catch (error) {
console.error('An error occurred while downloading the image:', error)
}
})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:
await sock.updateMediaMessage(msg)Reject Call
- You can obtain
callIdandcallFromfromcallevent
await sock.rejectCall(callId, callFrom)Send States in Chat
Reading Messages
- A set of message keys 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.
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
presencecan be one of these- The presence expires after about 10 seconds.
- This lets the person/group with
jidknow whether you're online, offline, typing etc.
await sock.sendPresenceUpdate('available', jid) [!NOTE] If a desktop client is active, WA doesn't send push notifications to the device. If you would like to receive said notifications -- mark your Baileys client offline using
sock.sendPresenceUpdate('unavailable')
Modifying Chats
WA uses an encrypted form of communication to send chat/app updates. This has been implemented mostly and you can send the following updates:
[!IMPORTANT] If you mess up one of your updates, WA can log you out of all your devices and you'll have to log in again.
Archive a Chat
const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
await sock.chatModify({ archive: true, lastMessages: [lastMsgInChat] }, jid)Mute/Unmute a Chat
- Supported times:
| Time | Miliseconds | |-------|-----------------| | Remove | null | | 8h | 86.400.000 | | 7d | 604.800.000 |
// mute for 8 hours
await sock.chatModify({ mute: 8 * 60 * 60 * 1000 }, jid)
// unmute
await sock.chatModify({ mute: null }, jid)Mark a Chat Read/Unread
const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
// mark it unread
await sock.chatModify({ markRead: false, lastMessages: [lastMsgInChat] }, jid)Delete a Message for Me
await sock.chatModify({
clear: {
messages: [{
id: 'ATWYHDNNWU81732J',
fromMe: true,
timestamp: '1654823909'
}]
}
}, jid)Delete a Chat
const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
await sock.chatModify({
delete: true,
lastMessages: [{
key: lastMsgInChat.key,
messageTimestamp: lastMsgInChat.messageTimestamp
}]
}, jid)Pin/Unpin a Chat
await sock.chatModify({
pin: true // or `false` to unpin
}, jid)Star/Unstar a Message
await sock.chatModify({
star: {
messages: [{
id: 'messageID',
fromMe: true // or `false`
}],
star: true // - true: Star Message; false: Unstar Message
}
}, jid)Disappearing Messages
- Ephemeral can be:
| Time | Seconds | |-------|----------------| | Remove | 0 | | 24h | 86.400 | | 7d | 604.800 | | 90d | 7.776.000 |
- You need to pass in Seconds, default is 7 days
// turn on disappearing messages
await sock.sendMessage(jid, { disappearingMessagesInChat: WA_DEFAULT_EPHEMERAL }) // this is 1 week in seconds -- how long you want messages to appear for
// will send as a disappearing message
await sock.sendMessage(jid, { text: 'hello' }, { ephemeralExpiration: WA_DEFAULT_EPHEMERAL })
// turn off disappearing messages
await sock.sendMessage(jid, { disappearingMessagesInChat: false })Clear Messages
await sock.clearMessage(jid, key, timestamps) User Querys
Check If ID Exists in Whatsapp
const [result] = await sock.onWhatsApp(jid)
if (result.exists) console.log (`${jid} exists on WhatsApp, as jid: ${result.jid}`)Query Chat History (groups too)
- You need to have oldest message in chat
const msg = await getOldestMessageInChat(jid)
await sock.fetchMessageHistory(
50, //quantity (max: 50 per query)
msg.key,
msg.messageTimestamp
)- Messages will be received in
messaging.history-setevent
Fetch Status
const status = await sock.fetchStatus(jid)
console.log('status: ' + status)Fetch Profile Picture (groups too)
- To get the display picture of some person, group and channel
// for low res picture
const ppUrl = await sock.profilePictureUrl(jid)
console.log(ppUrl)Fetch Bussines Profile (such as description or category)
const profile = await sock.getBusinessProfile(jid)
console.log('business description: ' + profile.description + ', category: ' + profile.category)Fetch Someone's Presence (if they're typing or online)
// the presence update is fetched and called here
sock.ev.on('presence.update', console.log)
// request updates for a chat
await sock.presenceSubscribe(jid) Change Profile
Change Profile Status
await sock.updateProfileStatus('Hello World!')Change Profile Name
await sock.updateProfileName('My name')Change Display Picture (groups too)
- To change your display picture or a group's
[!NOTE] Like media messages, you can pass
{ stream: Stream }or{ url: Url }orBufferdirectly, you can see more here
await sock.updateProfilePicture(jid, { url: './new-profile-picture.jpeg' })Remove display picture (groups too)
await sock.removeProfilePicture(jid)Groups
- To change group properties you need to be admin
Create a Group
// title & participants
const group = await sock.groupCreate('My Fab Group', ['[email protected]', '[email protected]'])
console.log('created group with id: ' + group.gid)
await sock.sendMessage(group.id, { text: 'hello there' }) // say hello to everyone on the groupAdd/Remove or Demote/Promote
// id & people to add to the group (will throw error if it fails)
await sock.groupParticipantsUpdate(jid, ['[email protected]', '[email protected]'], 'add' /** replace this parameter with 'remove' or 'demote' or 'promote'*/ )Change Subject (name)
await sock.groupUpdateSubject(jid, 'New Subject!')Change Description
await sock.groupUpdateDescription(jid, 'New Description!')Change Settings
// only allow admins to send messages
await sock.groupSettingUpdate(jid, 'announcement')
// allow everyone to send messages
await sock.groupSettingUpdate(jid, 'not_announcement')
// allow everyone to modify the group's settings -- like display picture etc.
await sock.groupSettingUpdate(jid, 'unlocked')
// only allow admins to modify the group's settings
await sock.groupSettingUpdate(jid, 'locked')Leave a Group
// will throw error if it fails
await sock.groupLeave(jid)Get Invite Code
- To create link with code use
'https://chat.whatsapp.com/' + code
const code = await sock.groupInviteCode(jid)
console.log('group code: ' + code)Revoke Invite Code
const code = await sock.groupRevokeInvite(jid)
console.log('New group code: ' + code)Join Using Invitation Code
- Code can't have
https://chat.whatsapp.com/, only code
const response = await sock.groupAcceptInvite(code)
console.log('joined to: ' + response)Get Group Info by Invite Code
const response = await sock.groupGetInviteInfo(code)
console.log('group information: ' + response)Query Metadata (participants, name, description...)
const metadata = await sock.groupMetadata(jid)
console.log(metadata.id + ', title: ' + metadata.subject + ', description: ' + metadata.desc)Join using groupInviteMessage
const response = await sock.groupAcceptInviteV4(jid, groupInviteMessage)
console.log('joined to: ' + response)Get Request Join List
const response = await sock.groupRequestParticipantsList(jid)
console.log(response)Approve/Reject Request Join
const response = await sock.groupRequestParticipantsUpdate(
jid, // group id
['[email protected]', '[email protected]'],
'approve' // or 'reject'
)
console.log(response)Get All Participating Groups Metadata
const response = await sock.groupFetchAllParticipating()
console.log(response)Toggle Ephemeral
- Ephemeral can be:
| Time | Seconds | |-------|----------------| | Remove | 0 | | 24h | 86.400 | | 7d | 604.800 | | 90d | 7.776.000 |
await sock.groupToggleEphemeral(jid, 86400)Change Add Mode
await sock.groupMemberAddMode(jid,
'all_member_add' // or 'admin_add'
)Privacy
Block/Unblock User
await sock.updateBlockStatus(jid, 'block') // Block user
await sock.updateBlockStatus(jid, 'unblock') // Unblock userGet Privacy Settings
const privacySettings = await sock.fetchPrivacySettings(true)
console.log('privacy settings: ' + privacySettings)Get BlockList
const response = await sock.fetchBlocklist()
console.log(response)Update LastSeen Privacy
const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock.updateLastSeenPrivacy(value)Update Online Privacy
const value = 'all' // 'match_last_seen'
await sock.updateOnlinePrivacy(value)Update Profile Picture Privacy
const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock.updateProfilePicturePrivacy(value)Update Status Privacy
const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock.updateStatusPrivacy(value)Update Read Receipts Privacy
const value = 'all' // 'none'
await sock.updateReadReceiptsPrivacy(value)Update Groups Add Privacy
const value = 'all' // 'contacts' | 'contact_blacklist'
await sock.updateGroupsAddPrivacy(value)Update Default Disappearing Mode
- Like this, ephemeral can be:
| Time | Seconds | |-------|----------------| | Remove | 0 | | 24h | 86.400 | | 7d | 604.800 | | 90d | 7.776.000 |
const ephemeral = 86400
await sock.updateDefaultDisappearingMode(ephemeral)Broadcast Lists & Stories
Send Broadcast & Stories
- Messages can be sent to broadcasts & stories. You need to add the following message options in sendMessage, like this:
await sock.sendMessage(jid, {
image: {
url: url
},
caption: caption
}, {
backgroundColor: backgroundColor,
font: font,
statusJidList: statusJidList,
broadcast: true
})Message body can be a
extendedTextMessageorimageMessageorvideoMessageorvoiceMessage, see hereYou can add
backgroundColorand other options in the message options, see herebroadcast: trueenables broadcast modestatusJidList: a list of people that you can get which you need to provide, which are the people who will get this status message.You can send messages to broadcast lists the same way you send messages to groups & individual chats.
Right now, WA Web does not support creating broadcast lists, but you can still delete them.
Broadcast IDs are in the format
12345678@broadcast
Query a Broadcast List's Recipients & Name
const bList = await sock.getBroadcastListInfo('1234@broadcast')
console.log (`list name: ${bList.name}, recps: ${bList.recipients}`)Writing Custom Functionality
Baileys is written with custom functionality in mind. Instead of forking the project & re-writing the internals, you can simply write your own extensions.
Enabling Debug Level in Baileys Logs
First, enable the logging of unhandled messages from WhatsApp by setting:
const sock = makeWASocket({ logger: P({ level: 'debug' }) })This will enable you to see all sorts of messages WhatsApp sends in the console.
How Whatsapp Communicate With Us
[!TIP] If you want to learn whatsapp protocol, we recommend to study about Libsignal Protocol and Noise Protocol
- Example: Functionality to track the battery percentage of your phone. You enable logging and you'll see a message about your battery pop up in the console:
{ "level": 10, "fromMe": false, "frame": { "tag": "ib", "attrs": { "from": "@s.whatsapp.net" }, "content": [ { "tag": "edge_routing", "attrs": {}, "content": [ { "tag": "routing_info", "attrs": {}, "content": { "type": "Buffer", "data": [8,2,8,5] } } ] } ] }, "msg":"communication" }
The 'frame' is what the message received is, it has three components:
tag-- what this frame is about (eg. message will have 'message')attrs-- a string key-value pair with some metadata (contains ID of the message usually)content-- the actual data (eg. a message node will have the actual message content in it)- read more about this format here
Register a Callback for Websocket Events
[!TIP] Recommended to see
onMessageReceivedfunction insocket.tsfile to understand how websockets events are fired
// for any message with tag 'edge_routing'
sock.ws.on('CB:edge_routing', (node: BinaryNode) => { })
// for any message with tag 'edge_routing' and id attribute = abcd
sock.ws.on('CB:edge_routing,id:abcd', (node: BinaryNode) => { })
// for any message with tag 'edge_routing', id attribute = abcd & first content node routing_info
sock.ws.on('CB:edge_routing,id:abcd,routing_info', (node: BinaryNode) => { })[!NOTE] Also, this repo is now licenced under GPL 3 since it uses libsignal-node
Big Thanks To
Thank you to Stigma Software Archive and also to the other Baileys developers