@innovatorssoft/baileys
v7.4.3
Published
WhatsApp API Modification By innovatorssoft
Maintainers
perpetuate97Readme
Baileys - Typescript/Javascript WhatsApp Web API
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 the example script 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 @innovatorssoft/baileysUse the edge version (no guarantee of stability, but latest fixes + features)
yarn add github:innovatorssoft/baileysThen import your code using:
import makeWASocket from '@innovatorssoft/baileys'Links
Index
- Non-Media Messages
- Text Message
- Message Templates
- Quote Message
- Mention User
- Forward Messages
- Location Message
- Live Location Message
- Contact Message
- vCard / Contact Cards
- Reaction Message
- Pin Message
- Keep Message
- Poll Message
- Poll Result Message
- Call Message
- Event Message
- Order Message
- Product Message
- Payment Message
- Decrypt Event Response
- Payment Invite Message
- Admin Invite Message
- Group Invite Message
- Sticker Pack Message
- Share Phone Number Message
- Request Phone Number Message
- Buttons Reply Message
- Buttons Message
- Interactive Messages
- Buttons List Message
- Buttons Product List Message
- Buttons Cards Message
- Buttons Template Message
- Buttons Interactive Message
- Buttons Interactive Message PIX
- Buttons Interactive Message PAY
- Status Mentions Message
- Shop Message
- Collection Message
- AI Icon Feature
- 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
import makeWASocket from '@innovatorssoft/baileys'
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
import makeWASocket from '@innovatorssoft/baileys'
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:
import makeWASocket, { useMultiFileAuthState } from '@innovatorssoft/baileys'
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
import makeWASocket, { DisconnectReason, useMultiFileAuthState } from '@innovatorssoft/baileys'
import { Boom } from '@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
import makeWASocket, { useSingleFileAuthState, useMongoFileAuthState } from '@innovatorssoft/baileys'
// 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
import { MongoClient } from "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("@itsockchann").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
import pino from "pino"
import { makeInMemoryStore, getAggregateVotesInPollMessage } from '@innovatorssoft/baileys'
const logger = pino({ timestamp: () => `,"time":"${new Date().toJSON()}"` }).child({ class: "@Itsockchann" })
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: "Itsocki Kawaiii"
}
}
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
Auto-Reply System
Keyword/pattern-based automatic response handler with built-in typing simulation — shows a "typing..." indicator before sending each reply to feel more human.
import { createAutoReply } from '@innovatorssoft/baileys'Setup with Typing Simulation
const autoReply = createAutoReply(
// Wire sendMessage
(jid, content, opts) => sock.sendMessage(jid, content, opts),
// Wire sendPresence — REQUIRED for simulateTyping
(jid, presence) => sock.sendPresenceUpdate(presence, jid),
{
simulateTyping: true, // show "typing..." before each reply
typingDuration: 1500, // show it for 1.5 seconds (default: 1000)
globalCooldown: 2000, // wait 2 s before replying to the same JID again
onReply: (rule, msg, resp) => console.log(`Auto-replied with rule: ${rule.id}`),
onError: (err, rule, msg) => console.error(`Rule ${rule.id} failed:`, err.message)
}
)
// Wire to your message event
sock.ev.on('messages.upsert', async ({ messages }) => {
for (const msg of messages) {
if (!msg.key.fromMe) {
await autoReply.processMessage(msg)
}
}
})Adding Rules
// Keyword match (substring, case-insensitive)
autoReply.addRule({
keywords: ['hi', 'hello', 'hey', 'halo'],
response: { text: 'Hello! How can I help you? 👋' },
quoted: true // reply quoting the original message
})
// Regex pattern with dynamic/async response
autoReply.addRule({
pattern: /^!weather (.+)$/i,
response: async (msg, match) => ({
text: `Weather for *${match[1]}*: ☀️ 28°C, Humidity: 70%`
})
})
// Exact text match, groups only, with per-JID cooldown
autoReply.addRule({
exactMatch: '!help',
groupsOnly: true,
cooldown: 30_000, // cooldown 30 s per JID
response: { text: 'Available commands:\n• !help\n• !info\n• !ping' }
})
// Private chats only, higher priority (checked before lower-priority rules)
autoReply.addRule({
keywords: ['buy', 'price', 'order'],
privateOnly: true,
priority: 10,
response: { text: 'Please visit our store: https://example.com' }
})
// Allowed JIDs only
autoReply.addRule({
keywords: ['secret'],
allowedJids: ['[email protected]'],
response: { text: '🔐 Secret message!' }
})Managing Rules
// Get a rule by ID
const rule = autoReply.getRule(rule.id)
// Enable / disable a rule
autoReply.setRuleActive(rule.id, false) // pause
autoReply.setRuleActive(rule.id, true) // resume
// Remove a specific rule
autoReply.removeRule(rule.id)
// List all rules
const rules = autoReply.getRules()
// Wipe all rules
autoReply.clearRules()AutoReplyOptions Reference
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| simulateTyping | boolean | false | Show "typing…" before replying |
| typingDuration | number | 1000 | Duration of typing indicator in ms |
| globalCooldown | number | 1000 | Min time between replies to same JID |
| multiMatch | boolean | false | Reply for every matching rule (not just the first) |
| onReply | function | — | Called after each successful reply |
| onError | function | — | Called when a rule throws |
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:
import makeWASocket, { makeInMemoryStore } from '@innovatorssoft/baileys'
// 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 messageparseJid, parse and extract info from any JID (PN or LID)getSenderPn, get your own phone number info from creds
JID Plotting & LID Support
InnovatorsSoft Baileys has advanced JID plotting utilities to handle WhatsApp's Linked IDs (LID).
import { parseJid, plotJid, normalizePhoneToJid } from '@innovatorssoft/baileys'
// Parse JID info
const info = parseJid('[email protected]')
console.log(info.isLid) // false
console.log(info.user) // '1234567890'
// Normalize various formats to JID
const jid = normalizePhoneToJid('62812345678') // '[email protected]'
// Plot JID (Convert between PN and LID if mapping is available)
const plotted = plotJid('[email protected]')Message Scheduler
Schedule WhatsApp messages to be automatically sent at a specific future time (or after a delay). The scheduler is exported directly from the package — no external dependencies required.
import { createMessageScheduler } from '@innovatorssoft/baileys'Setup
const scheduler = createMessageScheduler(
// Wire the scheduler to your socket's sendMessage function
(jid, content) => sock.sendMessage(jid, content),
{
// Called when each message is successfully sent
onSent: (scheduled, message) => {
console.log(`✅ Sent to ${scheduled.jid} (id: ${scheduled.id})`)
},
// Called when a message fails to send
onFailed: (scheduled, error) => {
console.error(`❌ Failed for ${scheduled.jid}: ${error.message}`)
},
maxQueue: 1000, // max pending messages (default: 1000)
checkInterval: 1000 // polling interval in ms (default: 1000)
}
)Schedule at a Specific Time
// Schedule a birthday message
const entry = scheduler.schedule(
'[email protected]',
{ text: 'Happy Birthday! 🎂' },
new Date('2026-12-25T09:00:00')
)
console.log('Scheduled with ID:', entry.id)
// Schedule any message type
scheduler.schedule(
groupJid,
{
image: { url: './promo.jpg' },
caption: 'Weekend sale starts now! 🛍️'
},
new Date('2026-12-20T08:00:00')
)Schedule with a Delay
// Send in 30 minutes
scheduler.scheduleDelay(jid, { text: 'Reminder! ⏰' }, 30 * 60 * 1000)
// Send in 2 hours
scheduler.scheduleDelay(jid, { text: 'Follow-up check-in' }, 2 * 60 * 60 * 1000)
// Send in 1 day
scheduler.scheduleDelay(jid, { text: 'Daily update' }, 24 * 60 * 60 * 1000)Manage Scheduled Messages
// Cancel a specific message
const wasCancelled = scheduler.cancel(entry.id)
console.log(wasCancelled) // true if found & pending
// Cancel all pending messages for a JID
const count = scheduler.cancelForJid(jid)
console.log(`Cancelled ${count} messages`)
// List all pending messages
const pending = scheduler.getPending()
console.log(`${pending.length} messages still pending`)
// Get a specific entry by ID
const entry2 = scheduler.get(entry.id)
// Stop the internal timer (queue is preserved, just paused)
scheduler.stop()
// Restart after stop
scheduler.start()
// Wipe the entire queue and stop the timer
const cleared = scheduler.clearAll()
console.log(`Cleared ${cleared} entries`)ScheduledMessage Object
Every schedule() / scheduleDelay() call returns a ScheduledMessage:
| Field | Type | Description |
|-------|------|-------------|
| id | string | Unique entry ID (sched_<timestamp>_<random>) |
| jid | string | Recipient JID |
| content | AnyMessageContent | Message content |
| scheduledTime | Date | When it will be sent |
| createdAt | Date | When it was scheduled |
| status | 'pending' \| 'sent' \| 'failed' \| 'cancelled' | Current status |
| error? | string | Set when status === 'failed' |
| messageId? | string | WhatsApp message ID after successful send |
[!NOTE] The scheduler is in-memory only. Scheduled messages are lost if the process restarts. For persistence across restarts, serialize
getPending()to a database and restore on startup by callingschedule()for each entry.
Anti-Delete System
The Anti-Delete system allows you to store messages and recover them if they are revoked (deleted for everyone) by the sender.
import { MessageStore, createMessageStoreHandler, createAntiDeleteHandler } from '@innovatorssoft/baileys'
// Initialize the store
const store = new MessageStore({
maxMessagesPerChat: 1000,
ttl: 24 * 60 * 60 * 1000 // Keep messages for 24 hours
})
// 1. Listen for new messages to store them
sock.ev.on('messages.upsert', createMessageStoreHandler(store))
// 2. Listen for message updates (revokes/deletions)
const antiDeleteHandler = createAntiDeleteHandler(store)
sock.ev.on('messages.update', (updates) => {
const deletedMessages = antiDeleteHandler(updates)
for (const info of deletedMessages) {
console.log(`Message from ${info.key.remoteJid} was deleted!`)
console.log('Original Content:', info.originalMessage.message)
// You can now re-send the message or alert the user
// await sock.copyNForward(info.key.remoteJid, info.originalMessage)
}
})Sending Messages
Send all types of messages with a single function
- Here you can see all message contents supported, like text message
- Here you can see all options supported, like quote message
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' })Message Templates
Generate consistently formatted messages using native template string interpolation with curly brackets (e.g., {{variable:defaultValue}}).
import {
createTemplateManager,
renderTemplate,
PRESET_TEMPLATES
} from '@innovatorssoft/baileys'
// Create a manager and load the presets (includePresets = true)
const templates = createTemplateManager(true)
// Or, quick render without loading the manager
const quick = renderTemplate(
'Hi {{name}}, your order #{{orderId}} is {{status:processing}}',
{ name: 'Alice', orderId: '123' } // 'processing' acts a default value
)Rendering Preset Templates
The manager comes out of the box with beautifully designed, ready-to-use templates for common scenarios like Orders, Invoices, Greetings, and Support Tickets.
// Renders the built-in 'invoice' template using the provided data
const invoiceText = templates.render('invoice', {
invoiceNumber: 'INV-111',
customerName: 'John Doe',
invoiceDate: '2024-01-15',
dueDate: '2024-01-30',
items: '1x Web Design\n1x Hosting',
subtotal: '10,000',
tax: '1,000',
total: '11,000',
// We omit paymentMethod and bankAccount to let them fall back to template default
})
await sock.sendMessage(jid, { text: invoiceText })Custom Templates
You can create entirely custom templates, and define strict parameter variables.
// Registering a Custom Template
templates.create({
name: 'Welcome Message',
content: `Hello {{name}}! 👋
Welcome to {{company}}!
Here are our services:
{{services}}
Contact: {{phone:0812-3456-7890}}`,
category: 'greeting'
})
// Using it elsewhere in your app
const welcome = templates.render('welcome_message', {
name: 'Budi',
company: 'PT Example',
services: '- Support\n- Inquiries'
})You can iterate through your templates using functions like templates.getAll() and templates.getByCategory('greeting'), or backup and restore them using .export() and .import(json).
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
+ 'TELtype=CELLtype=VOICEwaid=911234567890:+91 12345 67890\n' // WhatsApp ID + phone number
+ 'END:VCARD'
await sock.sendMessage(
id,
{
contacts: {
displayName: 'Itsockchann',
contacts: [{ vcard }]
}
}
)vCard / Contact Cards
Easily generate and send vCard (VCF) contact data.
import {
quickContact,
createContactCard,
createContactCards,
generateVCard
} from '@innovatorssoft/baileys'Sending a Single Contact
// 1. Create a contact object quickly
const contact = quickContact('John Doe', '+1234567890', {
organization: 'Acme Corp',
email: '[email protected]'
})
// 2. Send it!
await sock.sendMessage(jid, createContactCard(contact))Sending Multiple Contacts
const c1 = quickContact('Alice', '+111111')
const c2 = quickContact('Bob', '+222222')
await sock.sendMessage(jid, createContactCards([c1, c2]))Advanced Contact Generation
If you need full control over the vCard fields (addresses, multiple phones, birthday), you can construct a full VCardContact object:
const fullContact = {
fullName: 'Jane Smith',
organization: 'Tech Inc',
title: 'Senior Developer',
phones: [
{ number: '+123', type: 'CELL' },
{ number: '+456', type: 'WORK', label: 'Office' }
],
emails: [
{ email: '[email protected]', type: 'WORK' }
],
addresses: [
{ street: '123 Main St', city: 'NY', country: 'USA' }
],
birthday: '1990-01-01',
note: 'Met at the conference'
}
await sock.sendMessage(jid, createContactCard(fullContact))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',
values: [
[
'Option 1',
1000
],
[
'Option 2',
2000
]
]
}
}
)Call Message
await sock.sendMessage(
jid,
{
call: {
name: 'Hay',
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'
},
call: 'audio', // or 'video'
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: 'newsletter_name',
caption: 'Please be my channel admin',
expiration: 86400,
jpegThumbnail: Buffer // optional
}
}
)Group Invite Message
await sock.sendMessage(
jid,
{
groupInvite: {
jid: '[email protected]',
name: 'group_name',
caption: 'Please Join My Whatsapp Group',
code: 'code_invite',
expiration: 86400,
jpegThumbnail: Buffer, // optional
}
}
)Sticker Pack Message
// I don't know why the sticker doesn't appear
await sock.sendMessage(
jid,
{
stickerPack: {
name: 'Hiii',
publisher: 'By Itsockchann',
description: 'Hello',
cover: Buffer, // Image buffer
stickers: [{
sticker: { url: 'https://example.com/1234kjd.webp' },
emojis: ['❤'], // optional
accessibilityLabel: '', // optional
isLottie: Boolean, // optional
isAnimated: Boolean // optional
},
{
sticker: Buffer,
emojis: ['❤'], // optional
accessibilityLabel: '', // optional
isLottie: Boolean, // optional
isAnimated: Boolean // 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: 'Hello World!',
buttons: [{
buttonId: 'Id1',
buttonText: {
displayText: 'Button 1'
}
},
{
buttonId: 'Id2',
buttonText: {
displayText: 'Button 2'
}
},
{
buttonId: 'Id3',
buttonText: {
displayText: 'Button 3'
}
}]
}
)Interactive Messages
Send native formatting wrappers—like buttons, lists, URL CTAs, and Copy CTAs—without directly formatting the complex payload manually.
import {
generateInteractiveButtonMessage,
generateInteractiveListMessage,
generateCombinedButtons,
generateCopyCodeButton,
generateUrlButtonMessage,
generateQuickReplyButtons
} from '@innovatorssoft/baileys'
// Quick Reply Buttons
const quickButtons = generateQuickReplyButtons(
'Please select an option below:',
[
{ id: 'btn-1', displayText: '✅ Accept' },
{ id: 'btn-2', displayText: '❌ Reject' },
{ id: 'btn-3', displayText: '📞 Contact Support' }
],
{ footer: 'Powered by Baileys' }
)
await sock.sendMessage(jid, quickButtons)
// URL Button
const urlButton = generateUrlButtonMessage(
'Visit our website for more info',
[{ displayText: '🌐 Open Website', url: 'https://example.com' }],
{ title: 'Product Info', footer: 'Click to open' }
)
await sock.sendMessage(jid, urlButton)
// Copy Code Button (for OTPs, Promos, etc.)
const copyButton = generateCopyCodeButton(
'Your OTP Code is:',
'123456',
'📋 Copy Code'
)
await sock.sendMessage(jid, copyButton)
// Combined Buttons (Mix URL, Reply, Copy, Call)
const combinedButtons = generateCombinedButtons(
'Choose an action:',
[
{ type: 'reply', displayText: '🛒 Order Now', id: 'order' },
{ type: 'url', displayText: '🌐 Website', url: 'https://example.com' },
{ type: 'call', displayText: '📞 Phone', phoneNumber: '+6281234567890' },
{ type: 'copy', displayText: '📋 Copy Promo', copyCode: 'PROMO2024' }
],
{ title: 'Main Menu', footer: 'Baileys' }
)
await sock.sendMessage(jid, combinedButtons)
// List Message
const listMessage = generateInteractiveListMessage({
title: '📋 Product Menu',
buttonText: 'View Menu',
description: 'Please select a product',
footer: 'Powered by Baileys',
sections: [
{
title: 'Food',
rows: [
{ rowId: 'nasi-goreng', title: 'Fried Rice', description: '$2.50' },
{ rowId: 'mie-goreng', title: 'Fried Noodles', description: '$2.00' }
]
},
{
title: 'Beverages',
rows: [
{ rowId: 'es-teh', title: 'Ice Tea', description: '$0.50' },
{ rowId: 'kopi', title: 'Coffee', description: '$1.00' }
]
}
]
})
await sock.sendMessage(jid, listMessage)Buttons List Message
// Just working in a private chat
await sock.sendMessage(
jid,
{
text: 'This is a list!',
footer: 'Hello World!',
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: 'Hello World!',
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.com/jdbenkksjs.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.com/jdbenkksjs.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.com/jdbenkksjs.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
// This no longer works
await sock.sendMessage(
jid,
{
text: 'This is a template message!',
footer: 'Hello World!',
templateButtons: [{
index: 1,
urlButton: {
displayText: 'Follow Me',
url: 'https://whatsapp.com/channel/0029Vag9VSI2ZjCocqa2lB1y'
},
},
{
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: 'Hello World!',
interactiveButtons: [
{
name: 'quick_reply',
buttonParamsJson: JSON.stringify({
display_text: 'Click Me!',
id: 'your_id'
})
},
{
name: 'cta_url',
buttonParamsJson: JSON.stringify({
display_text: 'Follow Me',
url: 'https://whatsapp.com/channel/0029Vag9VSI2ZjCocqa2lB1y',
merchant_url: 'https://whatsapp.com/channel/0029Vag9VSI2ZjCocqa2lB1y'
})
},
{
name: 'cta_copy',
buttonParamsJson: JSON.stringify({
display_text: 'Click Me!',
copy_code: 'https://whatsapp.com/channel/0029Vag9VSI2ZjCocqa2lB1y'
})
},
{
name: 'cta_call',
buttonParamsJson: JSON.stringify({
display_text: 'Call Me!',
phone_number: '628xxx'
})
},
{
name: 'cta_catalog',
buttonParamsJson: JSON.stringify({
business_phone_number: '628xxx'
})
},
{
name: 'cta_reminder',
buttonParamsJson: JSON.stringify({
display_text: '...'
})
},
{
name: 'cta_cancel_reminder',
buttonParamsJson: JSON.stringify({
display_text: '...'
})
},
{
name: 'address_message',
buttonParamsJson: JSON.stringify({
display_text: '...'
})
},
{
name: 'send_location',
buttonParamsJson: JSON.stringify({
display_text: '...'
})
},
{
name: 'open_webview',
buttonParamsJson: JSON.stringify({
title: 'Follow Me!',
link: {
in_app_webview: true, // or false
url: 'https://whatsapp.com/channel/0029Vag9VSI2ZjCocqa2lB1y'
}
})
},
{
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({
business_phone_number: '628xxx',
catalog_product_id: '12345'
})
},
{
name: 'galaxy_message',
buttonParamsJson: JSON.stringify({
mode: 'published',
flow_message_version: '3',
flow_token: '1:1307913409923914:293680f87029f5a13d1ec5e35e718af3',
flow_id: '1307913409923914',
flow_cta: 'Itsockchann kawaii >\\<',
flow_action: 'navigate',
flow_action_payload: {
screen: 'QUESTION_ONE',
params: {
user_id: '123456789',
referral: 'campaign_xyz'
}
},
flow_metadata: {
flow_json_version: '201',
data_api_protocol: 'v2',
flow_name: 'Lead Qualification [en]',
data_api_version: 'v2',
categories: ['Lead Generation', 'Sales']
}
})
},
{
name: 'single_select',
buttonParamsJson: JSON.stringify({
title: 'Click Me!',
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'
}
]
}
]
})
}
]
}
)
// If you want to use an image
await sock.sendMessage(
jid,
{
image: {
url: 'https://example.com/jdbenkksjs.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.com/jdbenkksjs.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.com/jdbenkksjs.jpg'
},
mimetype: 'image/jpeg',
jpegThumbnail: await sock.resize('https://example.com/jdbenkksjs.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,
viewOnce: 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
viewOnce: true
}
)
// if you want to use an product
await sock.sendMessage(
jid,
{
product: {
productImage: {
url: 'https://example.com/jdbenkksjs.jpg'
},
productId: '836xxx',
title: 'Title',
description: 'Description',
currencyCode: 'IDR',
priceAmount1000: '283xxx',
retailerId: 'Itsockchann',
url: 'https://example.com',
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
viewOnce: true
}
)Buttons Interactive Message PIX
await sock.sendMessage(
jid,
{
text: '', // This string is required. Even it's empty.
interactiveButtons: [
{
name: 'payment_info',
buttonParamsJson: JSON.stringify({
payment_settings: [{
type: "pix_static_code",
pix_static_code: {
merchant_name: 'itsockchann kawaii >\\\\\\<',
key: '[email protected]',
key_type: 'EMAIL' // PHONE || EMAIL || CPF || EVP
}
}]
})
}
],
}
)Buttons Interactive Message PAY
await sock.sendMessage(
jid,
{
text: '', // This string is required. Even it's empty.
interactiveButtons: [
{
name: 'review_and_pay',
buttonParamsJson: JSON.stringify({
currency: 'IDR',
payment_configuration: '',
payment_type: '',
total_amount: {
value: '999999999',
offset: '100'
},
reference_id: '45XXXXX',
type: 'physical-goods',
payment_method: 'confirm',
payment_status: 'captured',
payment_timestamp: Math.floor(Date.now() / 1000),
order: {
status: 'completed',
description: '',
subtotal: {
value: '0',
offset: '100'
},
order_type: 'PAYMENT_REQUEST',
items: [{
retailer_id: 'your_retailer_id',
name: 'Itsockchann Kawaii >\\\<',
amount: {
value: '999999999',
offset: '100'
},
quantity: '1',
}]
},
additional_note: 'Itsockchann Kawaii >\\\<',
native_payment_methods: [],
share_payment_status: false
})
}
],
}
)Status Mentions Message
const jidat = [
'[email protected]',
'[email protected]',
'[email protected]',
'[email protected]',
'[email protected]'
]
// Text
await sock.sendStatusMentions(
{
text: 'Hello Everyone :3',
font: 2, // optional
textColor: 'FF0000', // optional
backgroundColor: '#000000' // optional
},
jids // Limit to 5 mentions per status
)
// Image
await sock.sendStatusMentions(
{
Image: { url: 'https://example.com/ruriooe.jpg' }, or image buffer
caption: 'Hello Everyone :3' // optional
},
jids // Limit to 5 mentions per status
)
// Video
await sock.sendStatusMentions(
{
video: { url: 'https: