Baileys

To inspect unhandled messages from WhatsApp and see raw communication in the console, enable the debug log level when initializing the socket using makeWASocket. This is useful for discovering new message types or protocol details.

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

By default, WhatsApp Web does not generate link previews. To enable link preview generation in Baileys, you must add link-preview-js as a dependency to your project:

yarn add link-preview-js

To authenticate as a second WhatsApp client, you can scan a QR code. Use the printQRInTerminal: true option in your socket configuration to display the QR code in your terminal. You can also customize the browser identity using the Browsers constant (e.g., Browsers.ubuntu('My App')).

import makeWASocket from '@whiskeysockets/baileys'

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

To sync and receive full message history, set syncFullHistory: true in your socket configuration. For better results (emulating a desktop connection), use a desktop browser configuration like Browsers.macOS('Desktop') or Browsers.ubuntu('Desktop').

const sock = makeWASocket({
    ...otherOpts,
    // can use Windows, Ubuntu here too
    browser: Browsers.macOS('Desktop'),
    syncFullHistory: true
})

To avoid re-scanning QR codes, you must persist your authentication state. The useMultiFileAuthState utility function is provided to save credentials to a local folder.

Crucial: You must listen to the creds.update event and call the provided saveCreds function whenever it fires. Failure to save updated keys (authState.keys) will prevent messages from reaching recipients.

import makeWASocket, { useMultiFileAuthState } from '@whiskeysockets/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)

You can install the stable version of Baileys using yarn or npm. If you require the latest features and fixes and do not mind potential instability, you can install the edge version directly from GitHub.

To use the library in your code, import the default export makeWASocket.

# Install stable version
yarn add @whiskeysockets/baileys

# Install edge version
yarn add github:WhiskeySockets/Baileys

import makeWASocket from '@whiskeysockets/baileys'

To use Proto Extract, follow these steps:

1. Install dependencies using yarn or npm install.
2. Run the script using yarn start.
3. The script will attempt to update ../WAProto/WAProto.proto.

If you want to connect without scanning a QR code, you can use a Pairing Code. Note that this method connects you as a single device (similar to WhatsApp Web).

Requirements:

1. Set printQRInTerminal: false in the socket config.
2. Provide the phone number as a string containing only numbers (include the country code, but do not include +, (), or -).
3. Call sock.requestPairingCode(number) to retrieve the code.

import makeWASocket from '@whiskeysockets/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)
    console.log(code)
}

When working with groups, it is highly recommended to implement a cache for group metadata to improve performance. You can provide an async function to the cachedGroupMetadata option in the socket config. You should update this cache by listening to groups.update and group-participants.update events.

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

To see a full implementation of common use cases, you can run the provided example.ts script. Follow these steps in your terminal:

1. Navigate to the Baileys repository directory.
2. Install dependencies using yarn.
3. Execute the example script using yarn example.

cd path/to/Baileys
yarn
yarn example