astrabail
v1.1.6
Published
Professional Whatsapp Web API Library
Maintainers
danimaru-zeReadme
✨ Tentang AstraBail
AstraBail adalah library WhatsApp Web API profesional yang dioptimalkan dari basis Baileys. Dikelola oleh Danimaru-ze, library ini dirancang untuk performa tinggi, stabilitas maksimal, dan kemudahan integrasi ke berbagai proyek bot WhatsApp modern. Kini ditenagai penuh oleh astra-libsignal untuk proses enkripsi tingkat tinggi.
🚀 Fitur Unggulan
| Fitur | Keterangan |
|-------|-----------|
| 🔀 Multi-Device | Dukungan penuh sistem multi-device WhatsApp terbaru |
| 🔐 End-to-End Encryption | Enkripsi pesan standar industri |
| ⚡ Turbo Handshake | Inisialisasi koneksi yang sangat cepat |
| 🧠 Memory Optimized | Penggunaan RAM yang ringan dan efisien |
| 📦 Semua Jenis Pesan | Teks, Media, Button, Poll, Sticker, dan lainnya |
| 🆔 LID & JID Mapping | Pemetaan @lid dan @jid lengkap |
📦 Instalasi
npm install astrabail
# atau
yarn add astrabail⚡ Mulai Cepat
Instalasi & Koneksi Dasar
const { default: makeWASocket, useMultiFileAuthState } = require("astrabail")
async function startBot() {
const { state, saveCreds } = await useMultiFileAuthState('./session')
const sock = makeWASocket({
auth: state,
printQRInTerminal: true
})
sock.ev.on('creds.update', saveCreds)
sock.ev.on('connection.update', ({ connection }) => {
if (connection === 'open') console.log('✅ AstraBail: Bot Connected!')
})
}
startBot()Kirim Sticker Pack
await sock.sendMessage('[email protected]', {
stickerPack: {
name: 'AstraBail Sticker',
publisher: 'AstraBail',
description: 'Sticker pack custom dari AstraBail',
cover: { url: './assets/cover.png' },
stickers: [
{ sticker: { url: './assets/sticker-1.webp' }, emojis: ['😀'] },
{ sticker: { url: './assets/sticker-2.webp' }, emojis: ['🔥'] },
{ sticker: { url: './assets/sticker-3.png' }, emojis: ['🚀'] }
]
}
})Format object stickerPack
name: nama pack stickerpublisher: nama author/publisherdescription: deskripsi packcover: cover/tray icon, bisa file path, buffer, stream, atau URLstickers: array isi sticker, minimal 1 maksimal 60sticker: media tiap sticker, bisa WebP/PNG/JPG. Jika bukan WebP akan dicoba dikonversi otomatisemojis: emoji untuk sticker terkaitaccessibilityLabel: label opsionalpackId: opsional, jika tidak diisi akan dibuat otomatis
Catatan
- Sangat disarankan install
sharpagar konversi gambar ke WebP lebih stabil. - Jika
sharptidak ada, library akan mencoba memakaijimp. - Ukuran tiap sticker maksimal 1 MB.
- Jumlah sticker maksimal 60 per pack.
Documentation
- 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
🔗 Menghubungkan Akun
WhatsApp provides a multi-device API that allows AstraBail to be authenticated as a second WhatsApp client by scanning a QR code or Pairing Code with WhatsApp on your phone.
🔹 Memulai Socket dengan Kode QR
[!TIP] You can customize browser name if you connect with QR-CODE, with
Browserconstant, we have some browsers config, see here
const { default: makeWASocket } = require("astrabail")
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!
🔹 Memulai Socket dengan Kode Pairing
[!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 { default: makeWASocket } = require("astrabail")
const sock = makeWASocket({
// can provide additional config here
printQRInTerminal: false //need to be false
})
- Normal Pairing
if (!sock.authState.creds.registered) {
const number = 'XXXXXXXXXXX'
const code = await sock.requestPairingCode(number)
console.log(code)
}
- Costum Pairing
if (!sock.authState.creds.registered) {
const pair = "12345678" // only 8 digit numbers or letters (no more or less)
const number = 'XXXXXXXXXXX'
const code = await sock.requestPairingCode(number, pair)
console.log(code)
}🔹 Menerima Riwayat Penuh
- Set
syncFullHistoryastrue - AstraBail, 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
})⚙️ Catatan Penting tentang Konfigurasi Socket
🧠 Caching Metadata Grup (Direkomendasikan)
If you use AstraBail 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) })
🔁 Perbaiki Sistem Retry & Dekripsi Polling
- 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) })
🔔 Menerima Notifikasi di Aplikasi WhatsApp
- If you want to receive notifications in whatsapp app, set
markOnlineOnConnecttofalseconst sock = makeWASocket({ markOnlineOnConnect: false })
📦 Menyimpan & Mengembalikan Sesi
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 = require("astrabail").default;
const { useMultiFileAuthState } = require("astrabail");
const { state, saveCreds } = await useMultiFileAuthState('auth_info_AstraBail')
// 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.
📡 Penanganan Event
- AstraBail 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)
})🛠️ Contoh Awal
[!NOTE] This example includes basic auth storage too
const makeWASocket = require("astrabail").default;
const { DisconnectReason, useMultiFileAuthState } = require("astrabail");
const Boom = require('@hapi/boom');
async function connectToWhatsApp () {
const { state, saveCreds } = await useMultiFileAuthState('auth_info_AstraBail')
const sock = makeWASocket({
// can provide additional config here
auth: state,
printQRInTerminal: true
})
sock.ev.on('connection.update', (update) => {
const { connection, lastDisconnect } = update
if(connection === 'close') {
const shouldReconnect = (lastDisconnect.error as Boom)?.output?.statusCode !== DisconnectReason.loggedOut
console.log('connection closed due to ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
// reconnect if not logged out
if(shouldReconnect) {
connectToWhatsApp()
}
} else if(connection === 'open') {
console.log('opened connection')
}
})
sock.ev.on('messages.upsert', event => {
for (const m of event.messages) {
console.log(JSON.stringify(m, undefined, 2))
console.log('replying to', m.key.remoteJid)
await sock.sendMessage(m.key.remoteJid!, { text: 'Hello Word' })
}
})
// to storage creds (session info) when it updates
sock.ev.on('creds.update', saveCreds)
}
// run in main file
connectToWhatsApp()[!IMPORTANT] In
messages.upsertit's recommended to use a loop likefor (const message of event.messages)to handle all messages in array
🔐 Dekripsi Pilihan Polling
- By default poll votes are encrypted and handled in
messages.update - That's a simple example
sock.ev.on('messages.update', event => {
for(const { key, update } of event) {
if(update.pollUpdates) {
const pollCreation = await getMessage(key)
if(pollCreation) {
console.log(
'got poll update, aggregation: ',
getAggregateVotesInPollMessage({
message: pollCreation,
pollUpdates: update.pollUpdates,
})
)
}
}
}
})getMessageis a store implementation (in your end)
🔎 Ringkasan Event pada Koneksi Pertama
- When you connect first time,
connection.updatewill be fired requesting you to restart sock - Then, history messages will be received in
messaging.history-set
💾 Mengimplementasikan Data Store
- AstraBail 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 = require("astrabail").default;
const { makeInMemoryStore } = require("astrabail");
// 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('./AstraBail_store.json')
// saves the state to a file every 10s
setInterval(() => {
store.writeToFile('./AstraBail_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.
🆔 Penjelasan ID WhatsApp
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]. - For broadcast lists, it's
[timestamp of creation]@broadcast. - For stories, the ID is
status@broadcast.
- It must be in the format
🧰 Fungsi Utilitas
getContentType, returns the content type for any messagegetDevice, returns the device from messagemakeCacheableSignalKeyStore, make auth store more fastdownloadContentFromMessage, download content from any message
💫 Status Mention Grup (upswgc)
Digunakan untuk mengirim status WhatsApp (story) Grup baik berupa teks maupun media ke status@broadcast.
[!NOTE]
Fungsi ini sudah otomatis mendeteksi tipe konten (teks, gambar, video, audio).
Jika teks dan media digabung, hanya satu yang akan dikirim tergantung prioritas konten.
Kirim teks ke status WhatsApp
await conn.upswgc(m.chat, { text: "Halo dari upswgc versi final!" })Kirim gambar ke status WhatsApp
await conn.upswgc(m.chat, {
image: { url: "https://m.media-amazon.com/images/S/pv-target-images/f75db71efd62ea2eff81bd7cc01c44a9344b4ac18615ab71a80f58459ddf8791.jpg" },
caption : "apasi"
});
Kirim video ke status WhatsApp
await conn.upswgc(m.chat, {
video: { url: "https://m.media-amazon.com/images/S/pv-target-images/f75db71efd62ea2eff81bd7cc01c44a9344b4ac18615ab71a80f58459ddf8791.jpg" },
caption : "apasi"
});Kirim audio (voice note) ke status WhatsApp
await conn.upswgc(m.chat, {
audio: { url: "https://raw.githubusercontent.com/Danimaru-ze/AstraBail/main/assets/sample.opus" },
caption : "apasi"
});[!TIP]
Jika kamu ingin mengirim ke story + broadcast sekaligus, gunakan fungsi sendMessage()
dengan broadcast: true seperti dijelaskan pada bagian sebelumnya.
💬 Mengirim Pesan
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)
✉️ Pesan Non-Media
🔘 Pesan Tombol (Buttons)
// send a buttons message!
sock.sendMessage(jid, {
text: "Hello World !",
footer: "AstraBail - 2026",
buttons: [
{
buttonId: `🚀`,
buttonText: {
displayText: '🗿'
},
type: 1
}
],
headerType: 1,
viewOnce: true
},{ quoted: null })🔁 Alur Tombol
sock.sendMessage(jid, {
text: "Hello Wolrd !;",
footer: "© Danimaru-ze Dev",
buttons: [
{
buttonId: '.tes',
buttonText: {
displayText: 'TESTING BOT'
},
type: 1,
},
{
buttonId: ' ',
buttonText: {
displayText: 'PRIVATE SCRIPT'
},
type: 1,
},
{
buttonId: 'action',
buttonText: {
displayText: 'ini pesan interactiveMeta'
},
type: 4,
nativeFlowInfo: {
name: 'single_select',
paramsJson: JSON.stringify({
title: 'message',
sections: [
{
title: 'AstraBail - 2026',
highlight_label: '😜',
rows: [
{
header: 'HEADER',
title: 'TITLE',
description: 'DESCRIPTION',
id: 'YOUR ID',
},
{
header: 'HEADER',
title: 'TITLE',
description: 'DESCRIPTION',
id: 'YOUR ID',
},
],
},
],
}),
},
},
],
headerType: 1,
viewOnce: true
}, { quoted: m });🧩 Pesan Interaktif
let msg = generateWAMessageFromContent(m.chat, {
viewOnceMessage: {
message: {
"messageContextInfo": {
"deviceListMetadata": {},
"deviceListMetadataVersion": 2
},
interactiveMessage: proto.Message.InteractiveMessage.create({
body: proto.Message.InteractiveMessage.Body.create({
text: "Danimaru-ze"
}),
footer: proto.Message.InteractiveMessage.Footer.create({
text: "Bot"
}),
header: proto.Message.InteractiveMessage.Header.create({
title: "Igna",
subtitle: "test",
hasMediaAttachment: false
}),
nativeFlowMessage: proto.Message.InteractiveMessage.NativeFlowMessage.create({
buttons: [
{
"name": "single_select",
"buttonParamsJson": "{\"title\":\"title\",\"sections\":[{\".menu\":\".play dj webito\",\"highlight_label\":\"label\",\"rows\":[{\"header\":\"header\",\"title\":\"title\",\"description\":\"description\",\"id\":\"id\"},{\"header\":\"header\",\"title\":\"title\",\"description\":\"description\",\"id\":\"id\"}]}]}"
},
{
"name": "cta_reply",
"buttonParamsJson": "{\"display_text\":\"quick_reply\",\"id\":\"message\"}"
},
{
"name": "cta_url",
"buttonParamsJson": "{\"display_text\":\"url\",\"url\":\"https://www.google.com\",\"merchant_url\":\"https://www.google.com\"}"
},
{
"name": "cta_call",
"buttonParamsJson": "{\"display_text\":\"call\",\"id\":\"message\"}"
},
{
"name": "cta_copy",
"buttonParamsJson": "{\"display_text\":\"copy\",\"id\":\"123456789\",\"copy_code\":\"message\"}"
},
{
"name": "cta_reminder",
"buttonParamsJson": "{\"display_text\":\"Recordatorio\",\"id\":\"message\"}"
},
{
"name": "cta_cancel_reminder",
"buttonParamsJson": "{\"display_text\":\"cta_cancel_reminder\",\"id\":\"message\"}"
},
{
"name": "address_message",
"buttonParamsJson": "{\"display_text\":\"address_message\",\"id\":\"message\"}"
},
{
"name": "send_location",
"buttonParamsJson": ""
}
],
})
})
}
}
}, {})
return sock.relayMessage(msg.key.remoteJid, msg.message, { messageId: msg.key.id })📝 Pesan Teks
await sock.sendMessage(jid, { text: 'hello word' })❝ Pesan Quote (bekerja untuk semua tipe)
await sock.sendMessage(jid, { text: 'hello word' }, { quoted: message })🏷️ Mention Pengguna (bekerja di kebanyakan tipe)
- @number is to mention in text, it's optional
await sock.sendMessage(
jid,
{
text: '@12345678901',
mentions: ['[email protected]']
}
)📣 Mention Status
- [ jid ] If the Jid Group and Jid Private Chat are included in the JID list, try to make the JID group first starting from the Jid Private Chat or Jid Private Chat in the middle between the group Jid
await sock.StatusMentions(
{
text: "Hello", // or image / video / audio ( url or buffer )
},
[
"[email protected]",
"[email protected]",
// Enter jid chat here
]
) 📊 Hasil Poll dari Newsletter
await client.sendMessage(
jid,
{
pollResult: {
name: "Text poll",
votes: [["Options 1", 10], ["Options 2", 10]], // 10 For Fake Polling Count Results
}
}, { quoted : message }
)🖼️ Mengirim Pesan Album
- url or buffer ( image or video )
await sock.sendAlbumMessage(
jid,
[
{
image: { url: "https://example.jpg" }, // or buffer
caption: "Hello World",
},
{
video: { url: "https://example.mp4" }, // or buffer
caption: "Hello World",
},
],
{
quoted : message,
delay : 2000 // number in seconds
}
)
🔔 Respon Interaktif
await client.sendMessage(
jid,
{
buttonReply: {
text: 'Text',
nativeFlow: {
version: 3,
},
},
type: 'interactive',
ephemeral: true,
}
)
💳 Permintaan Pembayaran
- Example non media sticker
await client.sendMessage(
jid,
{
requestPayment: {
currency: "IDR",
amount: "10000000",
from: "[email protected]",
note: "Hai Guys",
background: { ...background of the message }
}
},
{ quoted : message }
)
- with media sticker buffer
await client.sendMessage(
jid,
{
requestPayment: {
currency: "IDR",
amount: "10000000",
from: "[email protected]",
sticker: Buffer,
background: { ...background of the message }
}
},
{ quoted : message }
)
- with media sticker url
await client.sendMessage(
jid,
{
requestPayment: {
currency: "IDR",
amount: "10000000",
from: "[email protected]",
sticker: { url: Sticker Url },
background: { ...background of the message }
}
},
{ quoted : message }
)📆 Pesan Event
await client.sendMessage(
jid,
{
event: {
isCanceled: false, // or true for cancel event
name: "Name Event",
description: "Description Event",
location: {
degressLatitude: -0,
degressLongitude: - 0
},
link: Call Link,
startTime: m.messageTimestamp.low,
endTime: m.messageTimestamp.low + 86400, // 86400 is day in seconds
extraGuestsAllowed: true // or false
}
},
{ quoted : message }
)🔗 Interaktif
- Example non header media
await client.sendMessage(
jid,
{
text: "Description Of Messages", //Additional information
title: "Title Of Messages",
subtitle: "Subtitle Message",
footer: "Footer Messages",
interactiveButtons: [
{
name: "quick_reply",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
id: "ID"
})
},
{
name: "cta_url",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
url: "https://www.example.com"
})
}
]
},
{
quoted : message
}
)
- Example with media
await client.sendMessage(
jid,
{
image: { url : "https://example.jpg" }, // Can buffer
caption: "Description Of Messages", //Additional information
title: "Title Of Messages",
subtitle: "Subtile Message",
footer: "Footer Messages",
media: true,
interactiveButtons: [
{
name: "quick_reply",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
id: "ID"
})
},
{
name: "cta_url",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
url: "https://www.example.com"
})
}
]
},
{
quoted : message
}
)
- Example with header product
await client.sendMessage(
jid,
{
product: {
productImage: { url: "https://example.jpg }, //or buffer
productImageCount: 1,
title: "Title Product",
description: "Description Product",
priceAmount1000: 20000 * 1000,
currencyCode: "IDR",
retailerId: "Retail",
url: "https://example.com",
},
businessOwnerJid: "[email protected]",
caption: "Description Of Messages", //Additional information
title: "Title Of Messages",
footer: "Footer Messages",
media: true,
interactiveButtons: [
{
name: "quick_reply",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
id: "ID"
})
},
{
name: "cta_url",
buttonParamsJson: JSON.stringify({
display_text: "Display Button",
url: "https://www.example.com"
})
}
]
},
{
quoted : message
}
)📤 Meneruskan Pesan
const msg = getMessageFromStore() // implement this on your end
await sock.sendMessage(jid, { forward: msg }) // WA forward the message!📍 Pesan Lokasi
await sock.sendMessage(
jid,
{
location: {
degreesLatitude: 24.121231,
degreesLongitude: 55.1121221
}
}
)👤 Pesan Kontak
const vcard = 'BEGIN:VCARD\n' // metadata of the contact card
+ 'VERSION:3.0\n'
+ 'FN:Jeff Singh\n' // full name
+ 'ORG:Ashoka Uni;\n' // the organization of the contact
+ 'TEL;type=CELL;type=VOICE;waid=911234567890:+91 12345 67890\n' // WhatsApp ID + phone number
+ 'END:VCARD'
await sock.sendMessage(
id,
{
contacts: {
displayName: 'Jeff',
contacts: [{ vcard }]
}
}
)❤️ Pesan Reaksi
await sock.sendMessage(
jid,
{
react: {
text: '💖', // use an empty string to remove the reaction
key: message.key
}
}
)📌 Pesan Pin
| Time | Seconds | |-------|----------------| | 24h | 86.400 | | 7d | 604.800 | | 30d | 2.592.000 |
await sock.sendMessage(
jid,
{
pin: {
type: 1, // 0 to remove
time: 86400
key: message.key
}
}
)🗳️ Pesan Poll
await sock.sendMessage(
jid,
{
poll: {
name: 'My Poll',
values: ['Option 1', 'Option 2', ...],
selectableCount: 1,
toAnnouncementGroup: false // or true
}
}
)💬 Mengirim Pesan with Link Previews
- By default, wa does not have link generation when sent from the web
- AstraBail 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/AstraBail'
}
)🎞️ Pesan Media
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, AstraBail 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
🎬 Pesan GIF
- 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
}
)📹 Pesan Video
await sock.sendMessage(
id,
{
video: {
url: './Media/ma_gif.mp4'
},
caption: 'hello word',
ptv: false // if set to true, will send as a `video note`
}
)🔊 Pesan Audio
- 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'
}
)🖼️ Pesan Gambar
await sock.sendMessage(
id,
{
image: {
url: './Media/ma_img.png'
},
caption: 'hello word'
}
)👁️ View Once (Sekali Lihat)
- 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'
}
)✏️ Memodifikasi Pesan
🗑️ Menghapus Pesan (untuk semua)
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
🖊️ Mengedit Pesan
- You can pass all editable contents here
await sock.sendMessage(jid, {
text: 'updated text goes here',
edit: response.key,
});🛠️ Manipulasi Pesan Media
🖼️ Thumbnail pada Pesan Media
- 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.
⬇️ Mengunduh Pesan Media
If you want to save the media you received
const { createWriteStream } = require('fs');
const { downloadMediaMessage, getContentType } = require("astrabail");
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 AstraBail 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)
}
}🔁 Mengunggah Ulang Pesan Media ke 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)🚫 Menolak Panggilan
- You can obtain
callIdandcallFromfromcallevent
await sock.rejectCall(callId, callFrom)📡 Status Pengiriman di Chat
📖 Membaca Pesan
- A set of message keys must be explicitly marked read now.
- You cannot mark an entire 'chat' read as it were with AstraBail 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.
🟢 Memperbarui 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 AstraBail client offline using
sock.sendPresenceUpdate('unavailable')
🗂️ Memodifikasi Chat
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.
🗃️ Arsipkan Chat
const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
await sock.chatModify({ archive: true, lastMessages: [lastMsgInChat] }, jid)🔕 Mute/Unmute 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)✅ Tandai Chat Baca/Belum Baca
const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
// mark it unread
await sock.chatModify({ markRead: false, lastMessages: [lastMsgInChat] }, jid)🧹 Hapus Pesan untuk Saya
await sock.chatModify(
{
clear: {
messages: [
{
id: 'ATWYHDNNWU81732J',
fromMe: true,
timestamp: '1654823909'
}
]
}
},
jid
)
❌ Hapus 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 Chat
await sock.chatModify({
pin: true // or `false` to unpin
},
jid
)⭐ Star/Unstar Pesan
await sock.chatModify({
star: {
messages: [
{
id: 'messageID',
fromMe: true // or `false`
}
],
star: true // - true: Star Message; false: Unstar Message
}
},
jid
)🕒 Pesan yang Menghilang (Disappearing)
- 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,
// this is 1 week in seconds -- how long you want messages to appear for
{ disappearingMessagesInChat: WA_DEFAULT_EPHEMERAL }
)
// 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 }
)🔎 Query Pengguna
🔍 Cek Jika ID Ada di WhatsApp
const [result] = await sock.onWhatsApp(jid)
if (result.exists) console.log (`${jid} exists on WhatsApp, as jid: ${result.jid}`)📜 Query Riwayat Chat (termasuk grup)
- 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
📣 Ambil Status
const status = await sock.fetchStatus(jid)
console.log('status: ' + status)🖼️ Ambil Foto Profil (termasuk grup)
- To get the display picture of some person/group
// for low res picture
const ppUrl = await sock.profilePictureUrl(jid)
console.log(ppUrl)
// for high res picture
const ppUrl = await sock.profilePictureUrl(jid, 'image')🏷️ Ambil Profil Bisnis (deskripsi/kategori)
const profile = await sock.getBusinessProfile(jid)
console.log('business description: ' + profile.description + ', category: ' + profile.category)👀 Ambil Presence Seseorang (sedang mengetik/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)🧑💼 Mengubah Profil
🧑💼 Mengubah Profil Status
await sock.updateProfileStatus('Hello World!')🧑💼 Mengubah Profil Name
await sock.updateProfileName('My name')🖼️ Ubah Foto Profil (termasuk grup)
- 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' })🗑️ Hapus Foto Profil (termasuk grup)
await sock.removeProfilePicture(jid)👥 Grup
- To change group properties you need to be admin
➕ Buat Grup
// 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 group➕/➖ Tambah/Hapus atau Turunkan/Naikkan Status
// 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'
)✏️ Ubah Subjek (Nama)
await sock.groupUpdateSubject(jid, 'New Subject!')📝 Ubah Deskripsi
await sock.groupUpdateDescription(jid, 'New Description!')⚙️ Ubah Pengaturan
// 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')🚪 Keluar Grup
// will throw error if it fails
await sock.groupLeave(jid)🔐 Dapatkan Kode Undangan
- To create link with code use
'https://chat.whatsapp.com/' + code
const code = await sock.groupInviteCode(jid)
console.log('group code: ' + code)🔄 Cabut Kode Undangan
const code = await sock.groupRevokeInvite(jid)
console.log('New group code: ' + code)➿ Bergabung Menggunakan Kode Undangan
- Code can't have
https://chat.whatsapp.com/, only code
const response = await sock.groupAcceptInvite(code)
console.log('joined to: ' + response)ℹ️ Dapatkan Info Grup lewat Kode Undangan
const response = await sock.groupGetInviteInfo(code)
console.log('group information: ' + response)🔎 Query Metadata (peserta, nama, deskripsi...)
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)📥 Dapatkan Daftar Permintaan Bergabung
const response = await sock.groupRequestParticipantsList(jid)
console.log(response)✅/❌ Setuju/Tolak Permintaan Bergabung
const response = await sock.groupRequestParticipantsUpdate(
jid, // group id
['[email protected]', '[email protected]'],
'approve' // or 'reject'
)
console.log(response)📚 Dapatkan Semua Metadata Grup yang Diikuti
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)🔐 Ubah Mode Penambahan
await sock.groupMemberAddMode(
jid,
'all_member_add' // or 'admin_add'
)🔒 Privasi
⛔/✅ Blokir/Buka Blokir Pengguna
await sock.updateBlockStatus(jid, 'block') // Block user
await sock.updateBlockStatus(jid, 'unblock') // Unblock user⚙️ Dapatkan Pengaturan Privasi
const privacySettings = await sock.fetchPrivacySettings(true)
console.log('privacy settings: ' + privacySettings)📛 Dapatkan Daftar Blokir
const response = await sock.fetchBlocklist()
console.log(response)👀 Update Privasi LastSeen
const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock.updateLastSeenPrivacy(value)🟢 Update Privasi Online
const value = 'all' // 'match_last_seen'
await sock.updateOnlinePrivacy(value)🖼️ Update Privasi Foto Profil
const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock.updateProfilePicturePrivacy(value)📣 Update Privasi Status
const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock.updateStatusPrivacy(value)✅ Update Privasi Read Receipts
const value = 'all' // 'none'
await sock.updateReadReceiptsPrivacy(value)👥 Update Privasi Tambah Grup
const value = 'all' // 'contacts' | 'contact_blacklist'
await sock.updateGroupsAddPrivacy(value)🕒 Update Mode Default Disappearing
- 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 & Story
📤 Kirim Broadcast & Story
- 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 Penerima & Nama Broadcast List
const bList = await sock.getBroadcastListInfo('1234@broadcast')
console.log (`list name: ${bList.name}, recps: ${bList.recipients}`)✍️ Menulis Fungsionalitas Kustom
AstraBail is written with custom functionality in mind. Instead of forking the project & re-writing the internals, you can simply write your own extensions.
🐛 Mengaktifkan Level Debug di Log AstraBail
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.
🔬 Bagaimana WhatsApp Berkomunikasi dengan Kita
[!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
🔁 Mendaftarkan Callback untuk Event Websocket
[!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
⚠️ Catatan
Proyek ini tidak berafiliasi dengan WhatsApp Inc.
Gunakan secara bertanggung jawab dan hindari aktivitas ilegal atau penyalahgunaan.
Lisensi
📘 Documentation powered by AstraBail
🧑💻 Modified and Presented by AstraBail
Sticker Pack Message
Gunakan field stickerPack pada sendMessage untuk mengirim satu paket sticker sekaligus.
Catatan penting: stickerPack sekarang bisa menerima campuran sticker statis dan video/animated (webp/png/jpg/jpeg/gif/webm/mp4) lalu mengonversinya ke WebP otomatis saat proses kirim, selama ffmpeg tersedia di server. Format tgs/Lottie tetap butuh preview/konverter tambahan di luar runtime ini.
await sock.sendMessage(jid, {
stickerPack: {
name: 'Nama Pack',
publisher: 'Nama Publisher',
description: 'Deskripsi singkat',
cover: { url: './cover.png' },
stickers: [
{ sticker: { url: './1.webp' }, emojis: ['🙂'] },
{ sticker: { url: './2.png' }, emojis: ['🎉'] }
]
}
})cover dan setiap item sticker menerima format media yang sama seperti pengiriman media biasa: path lokal, URL, Buffer, atau stream.
🛡️ Panduan Stabilitas & Pencegahan Bot Freeze
Bagian ini menjelaskan penyebab umum bot hang/freeze dan cara mencegahnya secara profesional.
⚠️ PERINGATAN PENTING: Bot Bisa Hang/Freeze Saat Ada User Join/Leave Grup
[!CAUTION] Ini adalah kesalahan paling umum yang dilakukan developer bot WhatsApp. Jika kamu mengirim pesan langsung (
await sendMessage(...)) di dalam eventgroup-participants.updatetanpa delay, botmu akan hang (macet) dan tidak bisa memproses command apapun selama beberapa menit.
❓ Mengapa Bisa Terjadi?
Ketika ada user baru join ke grup, WhatsApp membutuhkan waktu untuk:
- Menyinkronkan Sender Key — Kunci enkripsi baru harus dinegosiasikan antara bot dan member baru
- Memperbarui Session Signal — Library perlu update session internal untuk anggota baru
- Fetch data server — WhatsApp server membutuhkan sedikit waktu untuk menyebarkan informasi member baru
Jika kamu langsung memanggil sendMessage pada saat yang sama dengan proses di atas, bot akan "menunggu" respons server yang belum siap — menyebabkan seluruh event loop Node.js tersumbat (blocked).
📊 Ilustrasi Masalah
[User Join Grup]
↓
[group-participants.update fired]
↓
[Bot langsung await sendMessage()] ← ❌ MASALAH ADA DI SINI
↓
[Baileys menunggu Sender Key dari server...]
↓
[Event loop TERSUMBAT 30-60 detik]
↓
[Semua command lain DIABAIKAN selama menunggu]✅ Solusi yang Benar
Selalu gunakan setTimeout dengan delay minimal 3-5 detik sebelum mengirim pesan welcome/leave di dalam event group-participants.update:
// ❌ CARA SALAH — Bot akan hang!
sock.ev.on('group-participants.update', async ({ id, participants, action }) => {
if (action === 'add') {
await sock.sendMessage(id, { text: 'Selamat datang!' }) // ← JANGAN LAKUKAN INI
}
})
// ✅ CARA BENAR — Bot tetap responsif!
sock.ev.on('group-participants.update', async ({ id, participants, action }) => {
// Selesaikan event handler ini secepat mungkin (non-blocking)
// Kirim pesan welcome di background setelah 5 detik
setTimeout(async () => {
try {
if (action === 'add') {
for (const participant of participants) {
await sock.sendMessage(id, {
text: `Sel