WhatsApp API Modification By innovatorssoft
npm install @innovatorssoft/baileys cd path/to/Baileys `
2. ` yarn `
3. ` yarn example `
Install
Use the stable version:
`
yarn add @innovatorssoft/baileys
`
Use the edge version (no guarantee of stability, but latest fixes + features)
`
yarn add github:innovatorssoft/baileys
`
Then import your code using:
`ts
import makeWASocket from '@innovatorssoft/baileys'
`
Links
- Innovators
- Itsukichan
- Original Docs
Index
- Connecting Account
- Connect with QR-CODE
- Connect with Pairing Code
- Receive Full History
- Important Notes About Socket Config
- Caching Group Metadata (Recommended)
- Improve Retry System & Decrypt Poll Votes
- Receive Notifications in Whatsapp App
- Save Auth Info
- Handling Events
- Example to Start
- Decrypt Poll Votes
- Summary of Events on First Connection
- Implementing a Data Store
- Whatsapp IDs Explain
- Utility Functions
- Anti-Delete System
- JID Plotting & LID Support
- Sending Messages
- 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
- 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
- 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
- Gif Message
- Video Message
- Audio Message
- Image Message
- Album Message
- Ptv Video Message
- ViewOnce Message
- Modify Messages
- Delete Messages (for everyone)
- Edit Messages
- Manipulating Media Messages
- Thumbnail in Media Messages
- Downloading Media Messages
- Re-upload Media Message to Whatsapp
- Reject Call
- Send States in Chat
- Reading Messages
- Update Presence
- Modifying Chats
- Archive a Chat
- Mute/Unmute a Chat
- Mark a Chat Read/Unread
- Delete a Message for Me
- Delete a Chat
- Star/Unstar a Message
- Disappearing Messages
- Clear Messages
- User Querys
- Check If ID Exists in Whatsapp
- Query Chat History (groups too)
- Fetch Status
- Fetch Profile Picture (groups too)
- Fetch Bussines Profile (such as description or category)
- Fetch Someone's Presence (if they're typing or online)
- Change Profile
- Change Profile Status
- Change Profile Name
- Change Display Picture (groups too)
- Remove display picture (groups too)
- Groups
- 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
- Privacy
- Block/Unblock User
- Get Privacy Settings
- Get BlockList
- Update LastSeen Privacy
- Update Online Privacy
- Update Profile Picture Privacy
- Update Status Privacy
- Update Read Receipts Privacy
- Update Groups Add Privacy
- Update Default Disappearing Mode
- Broadcast Lists & Stories
- Send Broadcast & Stories
- Query a Broadcast List's Recipients & Name
- Writing Custom Functionality
- Enabling Debug Level in Baileys Logs
- How Whatsapp Communicate With Us
- Register a Callback for Websocket Events
Connecting Account
WhatsApp provides a multi-device API that allows Baileys to be authenticated as a second WhatsApp client by scanning a QR code or Pairing Code with WhatsApp on your phone.
> [!NOTE]
> Here is a simple example of event handling
> [!TIP]
> You can see all supported socket configs here (Recommended)
$3
> [!TIP]
> You can customize browser name if you connect with QR-CODE, with Browser constant, we have some browsers config, see here
`ts
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!
$3
> [!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
`ts
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)
}
`
$3
1. Set syncFullHistory as true
2. Baileys, by default, use chrome browser config
- If you'd like to emulate a desktop connection (and receive more message history), this browser setting to your Socket config:
`ts
const sock = makeWASocket({
...otherOpts,
// can use Windows, Ubuntu here too
browser: Browsers.macOS('Desktop'),
syncFullHistory: true
})
`
Important Notes About Socket Config
$3
- If you use baileys for groups, we recommend you to set cachedGroupMetadata in socket config, you need to implement a cache like this:
`ts
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)
})
`
$3
- If you want to improve sending message, retrying when error occurs and decrypt poll votes, you need to have a store and set getMessage config in socket like this:
`ts
const sock = makeWASocket({
getMessage: async (key) => await getMessageFromStore(key)
})
`
$3
- If you want to receive notifications in whatsapp app, set markOnlineOnConnect to false
`ts
const 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:
`ts
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]
> useMultiFileAuthState is a utility function to help save the auth state in a single folder, this function serves as a good guide to help write auth & key states for SQL/no-SQL databases, which I would recommend in any production grade system.
> [!NOTE]
> When a message is received/sent, due to signal sessions needing updating, the auth keys (authState.keys) will update. Whenever that happens, you must save the updated keys (authState.keys.set() is called). Not doing so will prevent your messages from reaching the recipient & cause other unexpected consequences. The useMultiFileAuthState function automatically takes care of that, but for any other serious implementation -- you will need to be very careful with the key state management.
Handling Events
- Baileys uses the EventEmitter syntax for events.
They're all nicely typed up, so you shouldn't have any issues with an Intellisense editor like VS Code.
> [!IMPORTANT]
> The events are these, it's important you see all events
You can listen to these events like this:
`ts
const sock = makeWASocket()
sock.ev.on('messages.upsert', ({ messages }) => {
console.log('got messages', messages)
})
`
$3
> [!NOTE]
> This example includes basic auth storage too
`ts
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()
`
$3
`ts
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.upsert it's recommended to use a loop like for (const message of event.messages) to handle all messages in array
$3
- By default poll votes are encrypted and handled in messages.update
`ts
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)
}
}
}
})
`
$3
1. When you connect first time, connection.update will be fired requesting you to restart sock
2. Then, history messages will be received in messaging.history-set
Implementing a Data Store
- Baileys does not come with a defacto storage for chats, contacts, or messages. However, a simple in-memory implementation has been provided. The store listens for chat updates, new messages, message updates, etc., to always have an up-to-date version of the data.
> [!IMPORTANT]
> I highly recommend building your own data store, as storing someone's entire chat history in memory is a terrible waste of RAM.
It can be used as follows:
`ts
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
- id is the WhatsApp ID, called jid too, of the person or group you're sending the message to.
- It must be in the format `[country code][phone number]@s.whatsapp.net`
- Example for people: `+19999999999@s.whatsapp.net`.
- For groups, it must be in the format ` 123456789-123345@g.us `.
- For broadcast lists, it's [timestamp of creation]@broadcast.
- For stories, the ID is status@broadcast.
Utility Functions
- getContentType, returns the content type for any message
- getDevice, returns the device from message
- makeCacheableSignalKeyStore, make auth store more fast
- downloadContentFromMessage, download content from any message
- parseJid, parse and extract info from any JID (PN or LID)
- getSenderPn, get your own phone number info from creds
$3
Baileys-Joss includes advanced JID plotting utilities to handle WhatsApp's Linked IDs (LID).
`ts
import { parseJid, plotJid, normalizePhoneToJid } from '@innovatorssoft/baileys'
// Parse JID info
const info = parseJid('1234567890@s.whatsapp.net')
console.log(info.isLid) // false
console.log(info.user) // '1234567890'
// Normalize various formats to JID
const jid = normalizePhoneToJid('62812345678') // '62812345678@s.whatsapp.net'
// Plot JID (Convert between PN and LID if mapping is available)
const plotted = plotJid('1234567890@s.whatsapp.net')
`
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.
`ts
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
`ts
const jid: string
const content: AnyMessageContent
const options: MiscMessageGenerationOptions
sock.sendMessage(jid, content, options)
`
$3
#### Text Message
`ts
await sock.sendMessage(jid, { text: 'hello word' })
`
#### Quote Message (works with all types)
`ts
await sock.sendMessage(jid, { text: 'hello word' }, { quoted: message })
`
#### Mention User (works with most types)
- @number is to mention in text, it's optional
`ts
await sock.sendMessage(
jid,
{
text: '@12345678901',
mentions: ['12345678901@s.whatsapp.net']
}
)
`
#### Forward Messages
- You need to have message object, can be retrieved from store or use a message object
`ts
const msg = getMessageFromStore() // implement this on your end
await sock.sendMessage(jid, { forward: msg, force: true or number }) // WA forward the message!
`
#### Location Message
`ts
await sock.sendMessage(
jid,
{
location: {
degreesLatitude: 24.121231,
degreesLongitude: 55.1121221
}
}
)
`
#### Live Location Message
`ts
await sock.sendMessage(
jid,
{
location: {
degreesLatitude: 24.121231,
degreesLongitude: 55.1121221
},
live: true
}
)
`
#### Contact Message
`ts
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 }]
}
}
)
`
#### Reaction Message
- You need to pass the key of message, you can retrieve from store or use a key object
`ts
await sock.sendMessage(
jid,
{
react: {
text: '💖', // use an empty string to remove the reaction
key: message.key
}
}
)
`
#### Pin Message
- You need to pass the key of message, you can retrieve from store or use a key object
- Time can be:
| Time | Seconds |
|-------|----------------|
| 24h | 86.400 |
| 7d | 604.800 |
| 30d | 2.592.000 |
`ts
await sock.sendMessage(
jid,
{
pin: {
type: 1, // 2 to remove
time: 86400,
key: Key
}
}
)
`
$3
`ts
await sock.sendMessage(
jid,
{
keep: {
key: Key,
type: 1 // or 2
}
}
)
`
#### Poll Message
`ts
await sock.sendMessage(
jid,
{
poll: {
name: 'My Poll',
values: ['Option 1', 'Option 2', ...],
selectableCount: 1,
toAnnouncementGroup: false // or true
}
}
)
`
#### Poll Result Message
`ts
await sock.sendMessage(
jid,
{
pollResult: {
name: 'Hi',
values: [
[
'Option 1',
1000
],
[
'Option 2',
2000
]
]
}
}
)
`
$3
`ts
await sock.sendMessage(
jid,
{
call: {
name: 'Hay',
type: 1 // 2 for video
}
}
)
`
$3
`ts
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
}
}
)
`
$3
`ts
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'
}
}
)
`
$3
`ts
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'
}
)
`
$3
`ts
await sock.sendMessage(
jid,
{
payment: {
note: 'Hi!',
currency: 'IDR', // optional
offset: 0, // optional
amount: '10000', // optional
expiry: 0, // optional
from: '628xxxx@s.whatsapp.net', // optional
image: { // optional
placeholderArgb: "your_background", // optional
textArgb: "your_text", // optional
subtextArgb: "your_subtext" // optional
}
}
}
)
`
#### Payment Invite Message
`ts
await sock.sendMessage(
id,
{
paymentInvite: {
type: number, // 1 || 2 || 3
expiry: 0
}
}
)
`
$3
`ts
await sock.sendMessage(
jid,
{
adminInvite: {
jid: '123xxx@newsletter',
name: 'newsletter_name',
caption: 'Please be my channel admin',
expiration: 86400,
jpegThumbnail: Buffer // optional
}
}
)
`
$3
`ts
await sock.sendMessage(
jid,
{
groupInvite: {
jid: '123xxx@g.us',
name: 'group_name',
caption: 'Please Join My Whatsapp Group',
code: 'code_invite',
expiration: 86400,
jpegThumbnail: Buffer, // optional
}
}
)
`
$3
`ts
// 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
}]
}
}
)
`
$3
`ts
await sock.sendMessage(
jid,
{
sharePhoneNumber: {
}
}
)
`
$3
`ts
await sock.sendMessage(
jid,
{
requestPhoneNumber: {
}
}
)
`
$3
`ts
// 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'
}
)
`
$3
`ts
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'
}
}]
}
)
`
$3
`ts
// 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'
}]
}]
}
)
`
$3
`ts
// 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: '628xxx@s.whatsapp.net',
thumbnail: 'https://example.com/jdbenkksjs.jpg' // or buffer
}
)
`
$3
`ts
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'
})
}
]
}
]
}
)
`
$3
`ts
// 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'
},
}]
}
)
`
$3
`ts
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
}
)
// 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.com/jdbenkksjs.jpg'
},
productId: '836xxx',
title: 'Title',
description: 'Description',
currencyCode: 'IDR',
priceAmount1000: '283xxx',
retailerId: 'Itsockchann',
url: 'https://example.com',
productImageCount: 1
},
businessOwnerJid: '628xxx@s.whatsapp.net',
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
interactiveButtons: [
{
name: 'quick_reply',
buttonParamsJson: JSON.stringify({
display_text: 'DisplayText',
id: 'ID1'
})
}
],
hasMediaAttachment: false // or true
}
)
`
$3
`ts
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: 'example@itsockchan.com',
key_type: 'EMAIL' // PHONE || EMAIL || CPF || EVP
}
}]
})
}
],
}
)
`
$3
`ts
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
})
}
],
}
)
`
$3
`ts
const jidat = [
'123451679@g.us',
'124848899@g.us',
'111384848@g.us',
'62689xxxx@s.whatsapp.net',
'62xxxxxxx@s.whatsapp.net'
]
// 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://example.com/ruriooe.mp4' }, or video buffer
caption: 'Hello Everyone :3' // optional
},
jids // Limit to 5 mentions per status
)
// Audio
await sock.sendStatusMentions(
{
audio: { url: 'https://example.com/ruriooe.mp3' }, or audio buffer
backgroundColor: '#000000', // optional
mimetype: 'audio/mp4',
ppt: true
},
jids // Limit to 5 mentions per status
)
`
$3
`ts
await sock.sendMessage(
jid,
{
text: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
shop: {
surface: 1, // 2 | 3 | 4
id: 'https://example.com'
},
viewOnce: true
}
)
// Image
await sock.sendMessage(
jid,
{
image: {
url: 'https://example.com/jdbenkksjs.jpg'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
shop: {
surface: 1, // 2 | 3 | 4
id: 'https://example.com'
},
hasMediaAttachment: false, // or true
viewOnce: true
}
)
// Video
await sock.sendMessage(
jid,
{
video: {
url: 'https://example.com/jdbenkksjs.jpg'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
shop: {
surface: 1, // 2 | 3 | 4
id: 'https://example.com'
},
hasMediaAttachment: false, // or true
viewOnce: true
}
)
// 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',
shop: {
surface: 1, // 2 | 3 | 4
id: 'https://example.com'
},
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://example.com'
},
hasMediaAttachment: false, // or true
viewOnce: true
}
)
// 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: '628xxx@s.whatsapp.net',
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
shop: {
surface: 1, // 2 | 3 | 4
id: 'https://example.com'
},
hasMediaAttachment: false, // or true
viewOnce: true
}
)
`
$3
`ts
await sock.sendMessage(
jid,
{
text: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
collection: {
bizJid: 'jid',
id: 'https://example.com',
version: 1
},
viewOnce: true
}
)
// Image
await sock.sendMessage(
jid,
{
image: {
url: 'https://example.com/jdbenkksjs.jpg'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
collection: {
bizJid: 'jid',
id: 'https://example.com',
version: 1
},
hasMediaAttachment: false, // or true
viewOnce: true
}
)
// Video
await sock.sendMessage(
jid,
{
video: {
url: 'https://example.com/jdbenkksjs.jpg'
},
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
collection: {
bizJid: 'jid',
id: 'https://example.com',
version: 1
},
hasMediaAttachment: false, // or true
viewOnce: true
}
)
// 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',
collection: {
bizJid: 'jid',
id: 'https://example.com',
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://example.com',
version: 1
},
hasMediaAttachment: false, // or true
viewOnce: true
}
)
// 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: '628xxx@s.whatsapp.net',
caption: 'Body',
title: 'Title',
subtitle: 'Subtitle',
footer: 'Footer',
collection: {
bizJid: 'jid',
id: 'https://example.com',
version: 1
},
hasMediaAttachment: false, // or true
viewOnce: true
}
)
`
$3
`ts
await sock.sendMessage(
jid,
{
text: 'Hi'
}, {
ai: true // Add ai usage and change it to true
}
)
// If using relay
await sock.relayMessage(
jid,
{
extendedTextMessage: {
text: 'Hi'
}
}, {
AI: true // Use capital letters
}
)
`
$3
1. By default, wa does not have link generation when sent from the web
2. Baileys has a function to generate the content for these link previews
3. To enable this function's usage, add link-preview-js as a dependency to your project with yarn add link-preview-js
4. Send a link:
`ts
await sock.sendMessage(
jid,
{
text: 'Hi, this was sent using https://github.com/whiskeysockets/baileys'
}
)
`
$3
Sending media (video, stickers, images) is easier & more efficient than ever.
> [!NOTE]
> In media messages, you can pass { stream: Stream } or { url: Url } or Buffer directly, you can see more here
- When specifying a media url, Baileys never loads the entire buffer into memory it even encrypts the media as a readable stream.
> [!TIP]
> It's recommended to use Stream or Url to save memory
#### Gif Message
- Whatsapp doesn't support .gif files, that's why we send gifs as common .mp4 video with gifPlayback flag
`ts
await sock.sendMessage(
jid,
{
video: fs.readFileSync('Media/ma_gif.mp4'),
caption: 'hello word',
gifPlayback: true
}
)
`
#### Video Message
`ts
await sock.sendMessage(
id,
{
video: {
url: './Media/ma_gif.mp4'
},
caption: 'hello word',
}
)
`
#### Video Ptv Message
`ts
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 ffmpeg with this flags:
`bash
codec: libopus //ogg file
ac: 1 //one channel
avoid_negative_ts
make_zero
`
- Example:
`bash
ffmpeg -i input.mp4 -avoid_negative_ts make_zero -ac 1 output.ogg
`
`ts
await sock.sendMessage(
jid,
{
audio: {
url: './Media/audio.mp3'
},
mimetype: 'audio/mp4'
}
)
`
#### Image Message
`ts
await sock.sendMessage(
id,
{
image: {
url: './Media/ma_img.png'
},
caption: 'hello word'
}
)
`
$3
`ts
await sock.sendMessage(
id,
{
album: {
image: {
url: 'https://example.com/itsockchan.jpg'
},
caption: 'Hay'
}, {
image: Buffer,
caption: 'Hay'
}, {
video: {
url: 'https://example.com/itsockchan.mp4'
},
caption: 'Hay'
}, {
video: Buffer,
caption: 'Hay'
}
}
)
`
#### View Once Message
- You can send all messages above as viewOnce, you only need to pass viewOnce: true in content object
`ts
await sock.sendMessage(
id,
{
image: {
url: './Media/ma_img.png'
},
viewOnce: true, //works with video, audio too
caption: 'hello word'
}
)
`
Modify Messages
$3
`ts
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
$3
- You can pass all editable contents here
`ts
await sock.sendMessage(jid, {
text: 'updated text goes here',
edit: response.key,
})
`
Manipulating Media Messages
$3
- For media messages, the thumbnail can be generated automatically for images & stickers provided you add jimp or sharp as a dependency in your project using yarn add jimp or yarn add sharp.
- Thumbnails for videos can also be generated automatically, though, you need to have ffmpeg installed on your system.
$3
If you want to save the media you received
`ts
import { createWriteStream } from 'fs'
import { downloadMediaMessage, getContentType } from '@innovatorssoft/baileys'
sock.ev.on('messages.upsert', async ({ [m] }) => {
if (!m.message) return // if there is no text or media message
const messageType = getContentType(m) // get what type of message it is (text, image, video...)
// if the message is an image
if (messageType === 'imageMessage') {
// download the message
const stream = await downloadMediaMessage(
m,
'stream', // can be 'buffer' too
{ },
{
logger,
// pass this so that baileys can request a reupload of media
// that has been deleted
reuploadRequest: sock.updateMediaMessage
}
)
// save to file
const writeStream = createWriteStream('./my-download.jpeg')
stream.pipe(writeStream)
}
}
`
$3
- 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:
`ts
await sock.updateMediaMessage(msg)
`
Reject Call
- You can obtain callId and callFrom from call event
`ts
await sock.rejectCall(callId, callFrom)
`
Send States in Chat
$3
- 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.
`ts
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`.
$3
- ` presence ` can be one of these
- The presence expires after about 10 seconds.
- This lets the person/group with jid know whether you're online, offline, typing etc.
`ts
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')`