Baileys

https://github.com/whiskeysockets/baileys.wiki-site
Admin
A website serving documentation and guides for the Baileys project, a tool for building WhatsApp...
Tokens:5,684
Snippets:92
Trust Score:7.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Project Dependencies

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/README.md

Installs project dependencies using Yarn.

```bash
$ yarn
```

--------------------------------

### Start Local Development Server

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/README.md

Starts a local development server for live previewing changes.

```bash
$ yarn start
```

--------------------------------

### Install Baileys using npm or yarn

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/intro.md

Add the Baileys library to your project. Ensure you have Node.js version 17 or higher installed.

```bash
npm install baileys
```

--------------------------------

### Build Static Website Content

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/README.md

Generates static content for the website into the build directory.

```bash
$ yarn build
```

--------------------------------

### Deploy Website Using SSH

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/README.md

Deploys the website using SSH, typically for GitHub pages.

```bash
$ USE_SSH=true yarn deploy
```

--------------------------------

### Desktop Browser Emulation for Full History

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/configuration.md

To emulate a desktop client and receive full chat history events, configure the browser to a desktop OS and set syncFullHistory to true. This is crucial for obtaining comprehensive chat data.

```typescript
browser: Browsers.macOS("Desktop") // can be Windows/Ubuntu instead of macOS
```

--------------------------------

### Basic Socket Configuration

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/configuration.md

This snippet shows the essential configuration for initializing a Baileys socket, including the logger and authentication state. The logger can be configured using pino, and the auth state should be implemented based on your chosen storage solution.

```typescript
import makeWASocket from 'baileys'
import P from 'pino'
const sock = makeWASocket({
  auth: any, // auth state of your choosing,
  logger: P() // you can configure this as much as you want, even including streaming the logs to a ReadableStream for upload or saving to a file
})
```

--------------------------------

### Deploy Website Without SSH

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/README.md

Deploys the website without SSH, requiring a GitHub username.

```bash
$ GIT_USER=<Your GitHub username> yarn deploy
```

--------------------------------

### Persist Authentication Credentials

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/connecting.md

Use the `useMultiFileAuthState` function to manage authentication credentials and encryption keys. This function will be called as soon as credentials are updated.

```typescript
// DO NOT USE IN PROD!!!!
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);
```

--------------------------------

### Handle Connection Updates and QR Codes

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/connecting.md

Listen for the 'connection.update' event to receive connection states and QR codes. The QR code can be printed to the terminal or sent to a frontend for display.

```typescript
import QRCode from 'qrcode'

sock.ev.on('connection.update', async (update) => {
  const {connection, lastDisconnect, qr } = update
  // on a qr event, the connection and lastDisconnect fields will be empty

  // In prod, send this string to your frontend then generate the QR there
  if (qr) {
    // as an example, this prints the qr code to the terminal
    console.log(await QRCode.toString(qr, {type:'terminal'}))
  }
})
```

--------------------------------

### Fetch Blocklist

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/privacy.md

Retrieves the list of WhatsApp users currently being blocked.

```javascript
const response = await sock.fetchBlocklist()
```

--------------------------------

### Request Pairing Code

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/connecting.md

Request a pairing code by calling `sock.requestPairingCode(phoneNumber)` after the connecting/QR event. The phone number must be in E.164 format without a plus sign.

```typescript
sock.ev.on('connection.update', async (update) => {
  const {connection, lastDisconnect, qr } = update
  if (connection == "connecting" || !!qr) { // your choice
    const code = await sock.requestPairingCode(phoneNumber)
    // send the pairing code somewhere
  }
})
```

--------------------------------

### Blocklist Management

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/privacy.md

Manage your blocklist by fetching the current list of blocked users and updating block status.

```APIDOC
## Blocklist Management

### fetchBlocklist

Fetches the list of users currently being blocked.

### Method

```
GET
```

### Endpoint

```
/blocklist
```

### fetchBlocklist

Fetches the list of users currently being blocked.

### Method

```
GET
```

### Endpoint

```
/fetchBlocklist
```

### updateBlockStatus

Blocks or unblocks a WhatsApp user.

### Method

```
POST
```

### Endpoint

```
/updateBlockStatus
```

### Parameters

#### Path Parameters

- **jid** (string) - Required - The JID of the user to block or unblock.
- **status** (string) - Required - The status to set, either 'block' or 'unblock'.

### Request Example

```json
{
  "jid": "628123456789@s.whatsapp.net",
  "status": "block"
}
```
```

--------------------------------

### Accessing LID/PN Mapping Store

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/migration/to-v7.0.0.md

This snippet shows how to access the internal store for LID and Phone Number mappings. It provides methods to store mappings, retrieve LIDs for PNs, and retrieve PNs for LIDs.

```typescript
const store = sock.signalRepository.lidMapping
// available methods:
// storeLIDPNMapping, storeLIDPNMappings, getLIDForPN, getLIDsForPNs, getPNForLID
```

--------------------------------

### Fetch Privacy Settings

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/privacy.md

Retrieves all current privacy settings for the user. A boolean argument can force a refresh from the cache.

```javascript
// boolean option represents a force get (without hitting the cache)
const privacySettings = await sock.fetchPrivacySettings(true);
```

--------------------------------

### Send Chat-Level Presence Update

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/presence-receipts.md

Use this to send presence updates specific to a chat, such as 'composing', 'recording', or 'paused'. Requires a chat JID.

```javascript
await sock.sendPresenceUpdate('composing', jid)
```

--------------------------------

### Privacy Settings Management

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/privacy.md

Fetch and update various privacy settings for your WhatsApp account.

```APIDOC
## Privacy Settings Management

### fetchPrivacySettings

Retrieves all current privacy settings for the user. A boolean option can be passed to force a refresh from the server without using the cache.

### Method

```
GET
```

### Endpoint

```
/fetchPrivacySettings
```

### Parameters

#### Query Parameters

- **forceGet** (boolean) - Optional - If true, bypasses the cache and fetches fresh data from the server.

### updateLastSeenPrivacy

Updates the privacy setting for 'Last Seen'.

### Method

```
POST
```

### Endpoint

```
/updateLastSeenPrivacy
```

### Parameters

#### Request Body

- **option** (string) - Required - The privacy option. Accepts 'all', 'contacts', 'contacts_blacklist', or 'none'.

### updateProfilePicturePrivacy

Updates the privacy setting for 'Profile Picture'.

### Method

```
POST
```

### Endpoint

```
/updateProfilePicturePrivacy
```

### Parameters

#### Request Body

- **option** (string) - Required - The privacy option. Accepts 'all', 'contacts', 'contacts_blacklist', or 'none'.

### updateStatusPrivacy

Updates the privacy setting for 'Status'.

### Method

```
POST
```

### Endpoint

```
/updateStatusPrivacy
```

### Parameters

#### Request Body

- **option** (string) - Required - The privacy option. Accepts 'all', 'contacts', 'contacts_blacklist', or 'none'.

### updateGroupsAddPrivacy

Updates the privacy setting for 'Groups'.

### Method

```
POST
```

### Endpoint

```
/updateGroupsAddPrivacy
```

### Parameters

#### Request Body

- **option** (string) - Required - The privacy option. Accepts 'all', 'contacts', 'contacts_blacklist', or 'none'.

### updateOnlinePrivacy

Updates the privacy setting for 'Online status'.

### Method

```
POST
```

### Endpoint

```
/updateOnlinePrivacy
```

### Parameters

#### Request Body

- **option** (string) - Required - The privacy option. Accepts 'all' or 'match_last_seen'.

### updateReadReceiptsPrivacy

Updates the privacy setting for 'Read Receipts'.

### Method

```
POST
```

### Endpoint

```
/updateReadReceiptsPrivacy
```

### Parameters

#### Request Body

- **option** (string) - Required - The privacy option. Accepts 'all' or 'none'.

```

--------------------------------

### Handle Messaging History Set Event

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/history-sync.md

Listen for the 'messaging-history.set' event to receive historical chats, contacts, and messages after connecting. Store this data and ensure messages are available for the getMessage function.

```typescript
sock.ev.on('messaging-history.set', ({
	chats: newChats,
	contacts: newContacts,
	messages: newMessages,
	syncType
}) => {
  // handle the chats, contacts and messages
})
```

--------------------------------

### Mark Messages as Read

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/presence-receipts.md

Mark a set of messages as read by passing their keys to the `sock.readMessages` function. Requires message keys including remoteJid, id, and fromMe.

```typescript
let key: WAMessageKey = { remoteJid, id, fromMe }
await sock.readMessages([key])
```

--------------------------------

### Import Baileys ESM from CommonJS

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/migration/to-v7.0.0.md

When migrating to Baileys v7.0.0, if your project remains in CommonJS, you can import Baileys using a dynamic `await import()` call. This allows you to use ESM modules within a CJS environment.

```typescript
// cjs_module.js

// Use require normally
const fs = require('fs');

async function loadESMModule() {
  try {
    const { default: makeWASocket } = await import('baileys'); // Dynamic import of an ESM module
    const socket = makeWASocket(...)
  } catch (error) {
    console.error('Error loading ESM module:', error);
  }
}

loadESMModule();

```

--------------------------------

### Handle New Messages with messages.upsert

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/receiving-updates.md

Use the 'messages.upsert' event to receive new messages in real-time or during offline sync. Ensure you iterate through the entire messages array, as it can contain multiple entries.

```typescript
sock.ev.on('messages.upsert', ({type, messages}) => {
  if (type == "notify") { // new messages
    for (const message of messages) {
      // messages is an array, do not just handle the first message, you will miss messages
    }
  } else { // old already seen / handled messages
    // handle them however you want to
  }
})
```

--------------------------------

### Send Socket-Level Presence Update

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/presence-receipts.md

Use this to send general presence updates like 'unavailable' or 'available'. Mark yourself as unavailable periodically to ensure notifications are received on mobile.

```javascript
await sock.sendPresenceUpdate('unavailable')
```

--------------------------------

### Update Online Privacy

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/privacy.md

Updates the online status privacy setting. Options are 'all' or 'match_last_seen'.

```javascript
// sock.update<insert here>Privacy(<insert option here>)
await sock.updateOnlinePrivacy('match_last_seen')
```

--------------------------------

### Handle Forced Disconnect After QR Scan

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/connecting.md

After scanning a QR code, WhatsApp will forcibly disconnect you. Handle this in the 'connection.update' event by checking for 'DisconnectReason.restartRequired' and creating a new socket.

```typescript
import {DisconnectReason} from 'baileys'
sock.ev.on('connection.update', (update) => {
  const {connection, lastDisconnect} = update
  if (connection === 'close' && (lastDisconnect?.error as Boom)?.output?.statusCode === DisconnectReason.restartRequired) {
    // create a new socket, this socket is now useless
  }
})
```

--------------------------------

### Update Block Status

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/privacy.md

Blocks or unblocks a WhatsApp user. Use 'block' to block and 'unblock' to unblock.

```javascript
await sock.updateBlockStatus(jid, 'block') // Block user
```

--------------------------------

### Update Last Seen Privacy

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/privacy.md

Updates the last seen privacy setting. Accepts 'all', 'contacts', 'contacts_blacklist', or 'none'.

```javascript
await sock.updateLastSeenPrivacy('contacts')
```

--------------------------------

### Update Groups Add Privacy

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/privacy.md

Updates the privacy setting for who can add the user to groups. Accepts 'all', 'contacts', 'contacts_blacklist', or 'none'.

```javascript
await sock.updateGroupsAddPrivacy('contacts')
```

--------------------------------

### Update Status Privacy

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/privacy.md

Updates the status privacy setting. Accepts 'all', 'contacts', 'contacts_blacklist', or 'none'.

```javascript
await sock.updateStatusPrivacy('none')
```

--------------------------------

### Caching Group Metadata

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/configuration.md

To prevent rate limiting and potential bans when sending messages to groups, provide a cachedGroupMetadata function. This function should retrieve group participant lists from a cache, such as NodeCache, to avoid repeated API calls.

```typescript
const groupCache = new NodeCache({ /* ... */ })

const sock = makeWASocket({
    cachedGroupMetadata: async (jid) => groupCache.get(jid)
})
```

--------------------------------

### Update Profile Picture Privacy

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/privacy.md

Updates the profile picture privacy setting. Accepts 'all', 'contacts', 'contacts_blacklist', or 'none'.

```javascript
await sock.updateProfilePicturePrivacy('contacts_blacklist')
```

--------------------------------

### Update Read Receipts Privacy

Source: https://github.com/whiskeysockets/baileys.wiki-site/blob/main/docs/socket/privacy.md

Updates the read receipts privacy setting. Accepts 'all' or 'none'.

```javascript
await sock.updateReadReceiptsPrivacy('all')
```
Tokens:
Raw