Package detail

bail-lite

Lord-Samuel760MIT0.5.7

WhatsApp API for wa-api, a multi-device WhatsApp Web API client

whatsapp, js-whatsapp, whatsapp-api, whatsapp-web

readme

WhatsApp Web API

WhatsApp API

Baileys is a WebSockets-based TypeScript library for interacting with the WhatsApp Web API.
This is not the official Baileys library, but a modified and extended version developed independently to add functionalities that many developers have requested. These enhancements aim to improve flexibility, offer better developer experience, and provide tools that are missing from the original version.

Disclaimer

This project is not affiliated with, endorsed by, or officially connected to WhatsApp Inc., Meta Platforms, Inc., or any of their subsidiaries. The official WhatsApp website can be found at whatsapp.com. "WhatsApp," along with related names, marks, and logos, are registered trademarks and the intellectual property of their respective owners.

This modified version of Baileys was created with the intention of empowering developers, but it must be used responsibly. The maintainers strongly discourage any usage that goes against WhatsApp’s Terms of Service. This includes—but is not limited to—spamming, bulk or automated messaging, stalking, scraping user data, or deploying it in any way that violates privacy, consent, or platform integrity.

This project is provided as-is and should be used with extreme caution.
You are solely responsible for how you choose to use this library. Always ensure your use case is ethical, legal, and respects the rights and privacy of others.

Use at your own discretion. Respect platform rules, user boundaries, and stay within legal and moral lines.

Install

npm install bail-lite

or

npm i bail-lite

Then import your code using:

const { default: makeWASocket } = require("bail-lite")

Official Links

Index

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.

Starting socket with QR-CODE

[!TIP] You can customize browser name if you connect with QR-CODE, with Browser constant, we have some browsers config, see here

const { default: makeWASocket } = require("bail-lite")


const sock = makeWASocket({
    // can provide additional config here
    browser: Browsers.ubuntu('My App'),
    printQRInTerminal: true
})

If the connection is successful, you will see a QR code printed on your terminal screen, scan it with WhatsApp on your phone and you'll be logged in!

Starting socket with Pairing Code

[!IMPORTANT] Pairing Code isn't Mobile API, it's a method to connect Whatsapp Web without QR-CODE, you can connect only with one device, see here

The phone number can't have + or () or -, only numbers, you must provide country code

const { default: makeWASocket } = require("bail-lite")

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 = "BAILLITE" // only 8 alphanumeric (no more or less)
    const number = 'XXXXXXXXXXX'
    const code = await sock.requestPairingCode(number, pair)
    console.log(code)
}

Receive Full History

  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:
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 cachedGroupMetadata in 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 getMessage config 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 markOnlineOnConnect to false
      const sock = makeWASocket({
      markOnlineOnConnect: false
  })

Custom generateMessageID Function

  • you can modify the messageId generator function against the socket
      const sock = makeWASocket({
      generateMessageID: () => crypto.randomBytes(11).toString('hex').toUpperCase(),
      generateMessageIDV2: (userId) => {
          const hash = crypto.createHash('sha256').update(userId).digest('hex').toUpperCase();
          const randomPart = crypto.randomBytes(11).toString('hex').toUpperCase();
          const combined = hash + randomPart;
          let result = '';
          for (let i = 0; i < 22; i++) {
              const randomIndex = crypto.randomBytes(1)[0] % combined.length;
              result += combined[randomIndex];
          }
          return result;
      }
  })

    Saving & Restoring Sessions

You obviously don't want to keep scanning the QR code every time you want to connect.

So, you can load the credentials to log back in:

const makeWASocket = require("bail-lite").default;
const { useMultiFileAuthState } = require("bail-lite");

// enable authDebug to display session logs
const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys', { authDebug: true })

// 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)

You can sync cache on MultiFileAuthState

const makeWASocket = require("bail-lite").default;
const { useMultiFileAuthState, makeCacheableSignalKeyStore } = require("bail-lite");

// enable syncCache then fetch cache
const { state, saveCreds, cache: authCache } = await useMultiFileAuthState('auth_info_baileys', { syncCache: true })

const sock = makeWASocket({
  auth: {
    creds: state.creds,
    // use makeCacheableSignalKeyStore
    keys: makeCacheableSignalKeyStore(
      state.keys, 
      pino().child({ level: "silent", stream: "store" }),
      authCache
    )
  }
})

// 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:

const sock = makeWASocket()
sock.ev.on('messages.upsert', ({ messages }) => {
    console.log('got messages', messages)
})

Example to Start

[!NOTE] This example includes basic auth storage too

const makeWASocket = require("bail-lite").default;
const { DisconnectReason, useMultiFileAuthState } = require("bail-lite");
const Boom = require('@hapi/boom');

async function connectToWhatsApp () {
    const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys')
    const sock = makeWASocket({
        // can provide additional config here
        auth: state,
        printQRInTerminal: true
    })
    sock.ev.on('connection.update', (update) => {
        const { connection, lastDisconnect } = update
        if(connection === 'close') {
            const shouldReconnect = (lastDisconnect.error as Boom)?.output?.statusCode !== DisconnectReason.loggedOut
            console.log('connection closed due to ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
            // reconnect if not logged out
            if(shouldReconnect) {
                connectToWhatsApp()
            }
        } else if(connection === 'open') {
            console.log('opened connection')
        }
    })
    sock.ev.on('messages.upsert', event => {
        for (const m of event.messages) {
            console.log(JSON.stringify(m, undefined, 2))

            console.log('replying to', m.key.remoteJid)
            await sock.sendMessage(m.key.remoteJid!, { text: 'Hello Word' })
        }
    })

    // to storage creds (session info) when it updates
    sock.ev.on('creds.update', saveCreds)
}
// run in main file
connectToWhatsApp()

[!IMPORTANT] In messages.upsert it's recommended to use a loop like for (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

  • 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,
                  })
              )
          }
      }
  }
})

  • getMessage is a store implementation (in your end)

Summary of Events on First Connection

  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:

const makeWASocket = require("bail-lite").default;
const { makeInMemoryStore } = require("bail-lite");
// 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

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

Buttons Message

// send a buttons message!
sock.sendMessage(jid, {
     text: "Hello World !",
     footer: "Baileys - 2025",
     buttons: [
         {
             buttonId: `🚀`, 
             buttonText: {
                 displayText: '🗿'
             },
             type: 1 
         }
     ],
     headerType: 1,
     viewOnce: true
 },{ quoted: null })

Buttons Flow

sock.sendMessage(jid, {
  text: "Hello Wolrd !;", 
  footer: "© Baileys Pro",
  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: 'Baileys - 2025',
            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 });

Interactive Message

let msg = generateWAMessageFromContent(m.chat, {
 viewOnceMessage: {
   message: {
       "messageContextInfo": {
         "deviceListMetadata": {},
         "deviceListMetadataVersion": 2
       },
       interactiveMessage: proto.Message.InteractiveMessage.create({
         body: proto.Message.InteractiveMessage.Body.create({
           text: "Baileys Pro"
         }),
         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 })

Text Message

await sock.sendMessage(jid, { text: 'hello word' })

Quote Message (works with all types)

await sock.sendMessage(jid, { text: 'hello word' }, { quoted: message })

Mention User (works with most types)

  • @number is to mention in text, it's optional
    await sock.sendMessage(
  jid,
  {
      text: '@12345678901',
      mentions: ['12345678901@s.whatsapp.net']
  }
)

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.sendStatusMentions(
   {
      text: "Hello", // or image / video / audio ( url or buffer )
   },
   [
    "123456789123456789@g.us",
    "123456789@s.whatsapp.net",
    // Enter jid chat here
   ] 
)

Result Poll From Newsletter

await sock.sendMessage(
    jid,
    {
        pollResult: {
            name: "Text poll",
            votes: [["Options 1", 10], ["Options 2", 10]], // 10 For Fake Polling Count Results
        }
    }, { quoted : message }
)

Send Album Message

  • url or buffer ( image or video ) ```javascript 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
    } )

#### List Message
```javascript
const 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"}
    ]
    },
]

const listMessage = {
  text: "This is a list",
  footer: "nice footer, link: https://google.com",
  title: "Amazing boldfaced list title",
  buttonText: "Required, text on the button to view the list",
  sections
}

await sock.sendMessage(jid, listMessage)

Carousel Message

sock.sendMessage(jid, {
    text: 'hah',
    footer: 'ya',
    cards: [
        {
            title: 'oke',
            image: { url: 'https://example.com/image.jpeg' },
            caption: 'tes'
        },
        {
            title: 'oke',
            image: { url: 'https://example.com/image.jpeg' },
            caption: 'tes'
        }
    ],
    viewOnce: true
})

Interactive Response

await sock.sendMessage(
    jid, 
    {
        buttonReply: {
             text: 'Text',
             nativeFlow: { 
                version: 3,
             },
        },
        type: 'interactive',
        ephemeral: true,
    }
)

Request Payment

- Example non media sticker
await sock.sendMessage(
    jid,
    {
        requestPayment: {      
           currency: "IDR",
           amount: "10000000",
           from: "123456@s.whatsapp.net",
           note: "Hai Guys",
           background: { ...background of the message }
        }
    },
    { quoted : message }
)

- with media sticker buffer
await sock.sendMessage(
    jid,
    {
        requestPayment: {      
           currency: "IDR",
           amount: "10000000",
           from: "123456@s.whatsapp.net",
           sticker: Buffer,
           background: { ...background of the message }
        }
    },
    { quoted : message }
)

- with media sticker url
await sock.sendMessage(
    jid,
    {
        requestPayment: {      
           currency: "IDR",
           amount: "10000000",
           from: "123456@s.whatsapp.net",
           sticker: { url: Sticker Url },
           background: { ...background of the message }
        }
    },
    { quoted : message }
)

Event Message

await sock.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 }
)

Interactive

- Example non header media
await sock.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 sock.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 sock.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: "1234@s.whatsapp.net",
        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
  }
)

Forward Messages

  • You need to have message object, can be retrieved from store or use a message object
    const msg = getMessageFromStore() // implement this on your end
await sock.sendMessage(jid, { forward: msg }) // WA forward the message!

Location Message

await sock.sendMessage(
    jid,
    {
        location: {
            degreesLatitude: 24.121231,
            degreesLongitude: 55.1121221
        }
    }
)

Contact Message

const vcard = 'BEGIN:VCARD\n' // metadata of the contact card
            + 'VERSION:3.0\n'
            + 'FN:Jeff Singh\n' // full name
            + 'ORG:Ashoka Uni;\n' // the organization of the contact
            + 'TEL;type=CELL;type=VOICE;waid=911234567890:+91 12345 67890\n' // WhatsApp ID + phone number
            + 'END:VCARD'

await sock.sendMessage(
    id,
    {
        contacts: {
            displayName: 'Jeff',
            contacts: [{ vcard }]
        }
    }
)

Reaction Message

  • You need to pass the key of message, you can retrieve from store or use a key object
    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 
await sock.sendMessage(
    jid,
    {
        pin: {
            type: 1, // 0 to remove
            time: 86400
            key: message.key
        }
    }
)

Poll Message

await sock.sendMessage(
    jid,
    {
        poll: {
            name: 'My Poll',
            values: ['Option 1', 'Option 2', ...],
            selectableCount: 1,
            toAnnouncementGroup: false // or true
        }
    }
)

Sending Messages with Link Previews

  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:
    await sock.sendMessage(
 jid,
 {
     text: 'Hi, this was sent using https://github.com/whiskeysockets/baileys'
 }
)

Media Messages

Sending media (video, stickers, images) is easier & more efficient than ever.

[!NOTE] In media messages, you can pass { stream: Stream } or { url: Url } 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
    await sock.sendMessage(
  jid,
  {
      video: fs.readFileSync('Media/ma_gif.mp4'),
      caption: 'hello word',
      gifPlayback: true
  }
)

Video Message

await sock.sendMessage(
    id,
    {
        video: {
            url: './Media/ma_gif.mp4'
        },
        caption: 'hello word',
            ptv: false // if set to true, will send as a `video note`
    }
)

Audio Message

  • To audio message work in all devices you need to convert with some tool like ffmpeg with this flags:
          codec: libopus //ogg file
      ac: 1 //one channel
      avoid_negative_ts
      make_zero
    • Example:
      ffmpeg -i input.mp4 -avoid_negative_ts make_zero -ac 1 output.ogg

      await sock.sendMessage(
jid,
{
  audio: {
      url: './Media/audio.mp3'
  },
  mimetype: 'audio/mp4'
}
)

Image Message

await sock.sendMessage(
    id,
    {
        image: {
            url: './Media/ma_img.png'
        },
        caption: 'hello word'
    }
)

View Once Message

  • You can send all messages above as viewOnce, you only need to pass viewOnce: true in content object
await sock.sendMessage(
    id,
    {
        image: {
            url: './Media/ma_img.png'
        },
        viewOnce: true, //works with video, audio too
        caption: 'hello word'
    }
)

Modify Messages

Deleting Messages (for everyone)

const msg = await sock.sendMessage(jid, { text: 'hello word' })
await sock.sendMessage(jid, { delete: msg.key })

Note: deleting for oneself is supported via chatModify, see in this section

Editing Messages

  • You can pass all editable contents here
    await sock.sendMessage(jid, {
    text: 'updated text goes here',
    edit: response.key,
  });

Manipulating Media Messages

Thumbnail in Media Messages

  • For media messages, the thumbnail can be generated automatically for images & stickers provided you add 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.

Downloading Media Messages

If you want to save the media you received

const { createWriteStream } = require('fs');
const { downloadMediaMessage, getContentType } = require("bail-lite");

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)
    }
}

Re-upload Media Message to Whatsapp

  • WhatsApp automatically removes old media from their servers. For the device to access said media -- a re-upload is required by another device that has it. This can be accomplished using:
    await sock.updateMediaMessage(msg)

Reject Call

  • You can obtain callId and callFrom from call event
await sock.rejectCall(callId, callFrom)

Send States in Chat

Reading Messages

  • A set of message keys must be explicitly marked read now.
  • You cannot mark an entire 'chat' read as it were with Baileys Web. This means you have to keep track of unread messages.
const key: WAMessageKey
// can pass multiple keys to read multiple messages as well
await sock.readMessages([key])

The message ID is the unique identifier of the message that you are marking as read. On a WAMessage, the messageID can be accessed using messageID = message.key.id.

Update Presence

  • 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.
await sock.sendPresenceUpdate('available', jid)

[!NOTE] If a desktop client is active, WA doesn't send push notifications to the device. If you would like to receive said notifications -- mark your Baileys client offline using sock.sendPresenceUpdate('unavailable')

Modifying Chats

WA uses an encrypted form of communication to send chat/app updates. This has been implemented mostly and you can send the following updates:

[!IMPORTANT] If you mess up one of your updates, WA can log you out of all your devices and you'll have to log in again.

Archive a Chat

const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
await sock.chatModify({ archive: true, lastMessages: [lastMsgInChat] }, jid)

Mute/Unmute a Chat

  • Supported times:
Time Miliseconds
Remove null
8h 86.400.000
7d 604.800.000 
// mute for 8 hours
await sock.chatModify({ mute: 8 * 60 * 60 * 1000 }, jid)
// unmute
await sock.chatModify({ mute: null }, jid)

Mark a Chat Read/Unread

const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
// mark it unread
await sock.chatModify({ markRead: false, lastMessages: [lastMsgInChat] }, jid)

Delete a Message for Me

await sock.chatModify(
    {
        clear: {
            messages: [
                {
                    id: 'ATWYHDNNWU81732J',
                    fromMe: true,
                    timestamp: '1654823909'
                }
            ]
        }
    },
    jid
)

Delete a Chat

const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
await sock.chatModify({
        delete: true,
        lastMessages: [
            {
                key: lastMsgInChat.key,
                messageTimestamp: lastMsgInChat.messageTimestamp
            }
        ]
    },
    jid
)

Pin/Unpin a Chat

await sock.chatModify({
        pin: true // or `false` to unpin
    },
    jid
)

Star/Unstar a Message

await sock.chatModify({
        star: {
            messages: [
                {
                    id: 'messageID',
                    fromMe: true // or `false`
                }
            ],
            star: true // - true: Star Message; false: Unstar Message
        }
    },
    jid
)

Disappearing Messages

  • Ephemeral can be:
Time Seconds
Remove 0
24h 86.400
7d 604.800
90d 7.776.000
  • You need to pass in Seconds, default is 7 days
// turn on disappearing messages
await sock.sendMessage(
    jid,
    // 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 }
)

Send Message With Ai WaterMark

// Just add ai: true in text content
await sock.sendMessage(jid, {
        text: "Message to Send", ai: true },
  {
    quoted : message
  }
)

User Querys

Check If ID Exists in Whatsapp

const [result] = await sock.onWhatsApp(jid)
if (result.exists) console.log (`${jid} exists on WhatsApp, as jid: ${result.jid}`)

Query Chat History (groups too)

  • You need to have oldest message in chat
    const msg = await getOldestMessageInChat(jid)
await sock.fetchMessageHistory(
  50, //quantity (max: 50 per query)
  msg.key,
  msg.messageTimestamp
)
  • Messages will be received in messaging.history-set event

Fetch Status

const status = await sock.fetchStatus(jid)
console.log('status: ' + status)

Fetch Profile Picture (groups too)

  • To get the display picture of some person/group ```javascript // for low res picture const ppUrl = await sock.profilePictureUrl(jid) console.log(ppUrl)

// for high res picture const ppUrl = await sock.profilePictureUrl(jid, 'image')


### Fetch Bussines Profile (such as description or category)
```javascript
const profile = await sock.getBusinessProfile(jid)
console.log('business description: ' + profile.description + ', category: ' + profile.category)

Fetch Someone's Presence (if they're typing or online)

// the presence update is fetched and called here
sock.ev.on('presence.update', console.log)

// request updates for a chat
await sock.presenceSubscribe(jid)

Change Profile

Change Profile Status

await sock.updateProfileStatus('Hello World!')

Change Profile Name

await sock.updateProfileName('My name')

Change Display Picture (groups too)

  • To change your display picture or a group's

[!NOTE] Like media messages, you can pass { stream: Stream } or { url: Url } or Buffer directly, you can see more here

await sock.updateProfilePicture(jid, { url: './new-profile-picture.jpeg' })

Remove display picture (groups too)

await sock.removeProfilePicture(jid)

Groups

  • To change group properties you need to be admin

Create a Group

// title & participants
const group = await sock.groupCreate('My Fab Group', ['1234@s.whatsapp.net', '4564@s.whatsapp.net'])
console.log('created group with id: ' + group.gid)
await sock.sendMessage(group.id, { text: 'hello there' }) // say hello to everyone on the group

Add/Remove or Demote/Promote

// id & people to add to the group (will throw error if it fails)
await sock.groupParticipantsUpdate(
    jid,
    ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
    'add' // replace this parameter with 'remove' or 'demote' or 'promote'
)

Change Subject (name)

await sock.groupUpdateSubject(jid, 'New Subject!')

Change Description

await sock.groupUpdateDescription(jid, 'New Description!')

Change Settings

// only allow admins to send messages
await sock.groupSettingUpdate(jid, 'announcement')
// allow everyone to send messages
await sock.groupSettingUpdate(jid, 'not_announcement')
// allow everyone to modify the group's settings -- like display picture etc.
await sock.groupSettingUpdate(jid, 'unlocked')
// only allow admins to modify the group's settings
await sock.groupSettingUpdate(jid, 'locked')

Leave a Group

// will throw error if it fails
await sock.groupLeave(jid)

Get Invite Code

  • To create link with code use 'https://chat.whatsapp.com/' + code
    const code = await sock.groupInviteCode(jid)
console.log('group code: ' + code)

    Revoke Invite Code

    const code = await sock.groupRevokeInvite(jid)
console.log('New group code: ' + code)

    Join Using Invitation Code

  • Code can't have https://chat.whatsapp.com/, only code

    const response = await sock.groupAcceptInvite(code)
console.log('joined to: ' + response)

    Get Group Info by Invite Code

    const response = await sock.groupGetInviteInfo(code)
console.log('group information: ' + response)

    Query Metadata (participants, name, description...)

    const metadata = await sock.groupMetadata(jid)
console.log(metadata.id + ', title: ' + metadata.subject + ', description: ' + metadata.desc)

    Join using groupInviteMessage

    const response = await sock.groupAcceptInviteV4(jid, groupInviteMessage)
console.log('joined to: ' + response)

    Get Request Join List

    const response = await sock.groupRequestParticipantsList(jid)
console.log(response)

    Approve/Reject Request Join

    const response = await sock.groupRequestParticipantsUpdate(
  jid, // group id
  ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
  'approve' // or 'reject'
)
console.log(response)

    Get All Participating Groups Metadata

    const response = await sock.groupFetchAllParticipating()
console.log(response)

    Toggle Ephemeral

  • Ephemeral can be:

Time Seconds
Remove 0
24h 86.400
7d 604.800
90d 7.776.000 
await sock.groupToggleEphemeral(jid, 86400)

Change Add Mode

await sock.groupMemberAddMode(
    jid,
    'all_member_add' // or 'admin_add'
)

Newsletter

  • To perform most actions you must be the newsletter creator or admin

Subscribe to Newsletter Updates

await sock.subscribeNewsletterUpdates(jid)

Update Reaction Mode

await sock.newsletterReactionMode(jid, mode) // e.g., 'enabled', 'disabled'

Update Newsletter Description

await sock.newsletterUpdateDescription(jid, 'Your new description')

Update Newsletter Name

await sock.newsletterUpdateName(jid, 'New Name')

Update Newsletter Picture

await sock.newsletterUpdatePicture(jid, content)

Remove Newsletter Picture

await sock.newsletterRemovePicture(jid)

Follow a Newsletter

await sock.newsletterFollow(jid)

Unfollow a Newsletter

await sock.newsletterUnfollow(jid)

Mute a Newsletter

await sock.newsletterMute(jid)

Unmute a Newsletter

await sock.newsletterUnmute(jid)

Perform a Newsletter Action (Generic)

await sock.newsletterAction(jid, 'mute' | 'unmute' | 'follow' | 'unfollow')

Create a Newsletter

const newsletter = await sock.newsletterCreate('Newsletter Name', 'Newsletter Description')
console.log(newsletter)

Fetch Newsletter Metadata

// https://whatsapp.com/channel/$key
const metadata = await sock.newsletterMetadata(type, key, role) // type: 'invite' or 'direct', role: 'GUEST', etc.

Get Admin Count

const count = await sock.newsletterAdminCount(jid)

Change Newsletter Owner

/**user is Lid, not Jid */
await sock.newsletterChangeOwner(jid, userLid)

Demote Newsletter Admin

/**user is Lid, not Jid */
await sock.newsletterDemote(jid, userLid)

Delete Newsletter

await sock.newsletterDelete(jid)

React to a Message in Newsletter

// Copying the message link in the Newsletter will get
// https://whatsapp.com/channel/XXXXXXXXX/$serverId

await sock.newsletterReactMessage(jid, serverId, '❤️')
// pass null or empty to remove reaction

Fetch Messages in Newsletter

const messages = await sock.newsletterFetchMessages('direct' | 'invite', key, count, after)

Fetch Updates in Newsletter

const updates = await sock.newsletterFetchUpdates(jid, count, after, since)

Privacy

Block/Unblock User

await sock.updateBlockStatus(jid, 'block') // Block user
await sock.updateBlockStatus(jid, 'unblock') // Unblock user

Get Privacy Settings

const privacySettings = await sock.fetchPrivacySettings(true)
console.log('privacy settings: ' + privacySettings)

Get BlockList

const response = await sock.fetchBlocklist()
console.log(response)

Update LastSeen Privacy

const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock.updateLastSeenPrivacy(value)

Update Online Privacy

const value = 'all' // 'match_last_seen'
await sock.updateOnlinePrivacy(value)

Update Profile Picture Privacy

const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock.updateProfilePicturePrivacy(value)

Update Status Privacy

const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await sock.updateStatusPrivacy(value)

Update Read Receipts Privacy

const value = 'all' // 'none'
await sock.updateReadReceiptsPrivacy(value)

Update Groups Add Privacy

const value = 'all' // 'contacts' | 'contact_blacklist'
await sock.updateGroupsAddPrivacy(value)

Update Default Disappearing Mode

  • Like this, ephemeral can be:
Time Seconds
Remove 0
24h 86.400
7d 604.800
90d 7.776.000 
const ephemeral = 86400
await sock.updateDefaultDisappearingMode(ephemeral)

Broadcast Lists & Stories

Send Broadcast & Stories

  • Messages can be sent to broadcasts & stories. You need to add the following message options in sendMessage, like this:
    await sock.sendMessage(
  jid,
  {
      image: {
          url: url
      },
      caption: caption
  },
  {
      backgroundColor: backgroundColor,
      font: font,
      statusJidList: statusJidList,
      broadcast: true
  }
)
  • Message body can be a extendedTextMessage or imageMessage or videoMessage or voiceMessage, see here
  • You can add backgroundColor and other options in the message options, see here
  • broadcast: true enables broadcast mode

  • statusJidList: a list of people that you can get which you need to provide, which are the people who will get this status message.

  • You can send messages to broadcast lists the same way you send messages to groups & individual chats.

  • Right now, WA Web does not support creating broadcast lists, but you can still delete them.
  • Broadcast IDs are in the format 12345678@broadcast

    Query a Broadcast List's Recipients & Name

    const bList = await sock.getBroadcastListInfo('1234@broadcast')
console.log (`list name: ${bList.name}, recps: ${bList.recipients}`)

Writing Custom Functionality

Baileys is written with custom functionality in mind. Instead of forking the project & re-writing the internals, you can simply write your own extensions.

Enabling Debug Level in Baileys Logs

First, enable the logging of unhandled messages from WhatsApp by setting:

const sock = makeWASocket({
    logger: P({ level: 'debug' }),
})

This will enable you to see all sorts of messages WhatsApp sends in the console.

How Whatsapp Communicate With Us

[!TIP] If you want to learn whatsapp protocol, we recommend to study about Libsignal Protocol and Noise Protocol

  • Example: Functionality to track the battery percentage of your phone. You enable logging and you'll see a message about your battery pop up in the console:
      {
      "level": 10,
      "fromMe": false,
      "frame": {
          "tag": "ib",
          "attrs": {
              "from": "@s.whatsapp.net"
          },
          "content": [
              {
                  "tag": "edge_routing",
                  "attrs": {},
                  "content": [
                      {
                          "tag": "routing_info",
                          "attrs": {},
                          "content": {
                              "type": "Buffer",
                              "data": [8,2,8,5]
                          }
                      }
                  ]
              }
          ]
      },
      "msg":"communication"
  }

The 'frame' is what the message received is, it has three components:

  • tag -- what this frame is about (eg. message will have 'message')
  • attrs -- a string key-value pair with some metadata (contains ID of the message usually)
  • content -- the actual data (eg. a message node will have the actual message content in it)

Register a Callback for Websocket Events

[!TIP] Recommended to see onMessageReceived function in socket.ts file 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) => { })

[!Credits]