Baileys Pro

https://github.com/zervidas/baileys-pro
Admin
Baileys Pro is a modified and extended WebSockets-based TypeScript library for interacting with the...
Tokens:22,179
Snippets:155
Trust Score:5.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run Example (Bash Commands)

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Provides a sequence of bash commands to navigate to the Baileys project directory, install dependencies, and run an example JavaScript file. This is a common workflow for testing or using the library.

```bash
cd path/to/Baileys
npm install
node example.js
```

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

### Install Baileys Pro using npm

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Installs the stable version of the Baileys Pro library using npm. This is the recommended way to add the library to your project for reliable performance.

```bash
npm install baileys-pro
```

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

### Install Baileys Pro using Yarn (Edge Version)

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Installs the latest (edge) version of the Baileys Pro library using Yarn. This version includes the newest fixes and features but may not guarantee stability.

```bash
yarn add baileys-pro@latest
```

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

### Starting Socket with QR-Code

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Initiates a WebSocket connection using a QR code for authentication. This method allows Baileys to act as a secondary WhatsApp client.

```APIDOC
## Starting Socket with QR-Code

### Description
Initiates a WebSocket connection using a QR code for authentication. This method allows Baileys to act as a secondary WhatsApp client.
You can customize the browser name.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Request Example
```javascript
const { default: makeWASocket, Browsers } = require("baileys-pro");

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

### Response
#### Success Response (200)
QR code printed to the terminal for scanning with WhatsApp.

#### Response Example
(QR Code displayed in terminal)
```

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

### Sync Cache on MultiFileAuthState

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Demonstrates syncing cache with `useMultiFileAuthState` for more robust session management. It integrates a cacheable signal key store, which is recommended for production environments. This setup ensures that authentication keys are properly managed and updated.

```javascript
const { state, saveCreds, cache: authCache } = await useMultiFileAuthState('auth_info_baileys', { syncCache: true })

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

sock.ev.on('creds.update', saveCreds)
```

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

### Starting Socket with Pairing Code

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Initiates a WebSocket connection using a pairing code. This method is suitable for connecting WhatsApp Web without a QR code, but only allows for a single device connection.

```APIDOC
## Starting Socket with Pairing Code

### Description
Initiates a WebSocket connection using a pairing code. This method is suitable for connecting WhatsApp Web without a QR code, but only allows for a single device connection.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Request Example
```javascript
const { default: makeWASocket } = require("baileys-pro");

const sock = makeWASocket({
    // can provide additional config here
    printQRInTerminal: false //need to be false
});

// Normal Pairing
if (!sock.authState.creds.registered) {
    const number = 'XXXXXXXXXXX'; // Phone number without +, (), or -
    const code = await sock.requestPairingCode(number);
    console.log(code);
}

// Custom Pairing
if (!sock.authState.creds.registered) {
    const pair = "AB123C4D"; // 8 alphanumeric characters
    const number = 'XXXXXXXXXXX'; // Phone number without +, (), or -
    const code = await sock.requestPairingCode(number, pair);
    console.log(code);
}
```

### Response
#### Success Response (200)
Pairing code generated and displayed in the console.

#### Response Example
```
XXXXXXXXXX
```
```

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

### Start Socket with QR Code Authentication in Baileys-Pro

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Initiates a WhatsApp connection using a QR code, allowing authentication as a second device. Requires the 'baileys-pro' library. It prints the QR code to the terminal for scanning with a mobile device.

```javascript
const { default: makeWASocket } = require("baileys-pro")
const Browsers = require("baileys-pro/lib/browsers")

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

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

### Connect to WhatsApp with Basic Authentication

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Establishes a WhatsApp connection using Baileys-Pro, including basic authentication storage. It handles connection updates and listens for incoming messages, automatically replying to them. This example requires the 'baileys-pro' and '@hapi/boom' packages.

```javascript
const makeWASocket = require("baileys-pro").default;
const { DisconnectReason, useMultiFileAuthState } = require("baileys-pro");
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()
```

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

### Get Request Join List

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Retrieves the list of users requesting to join a group.

```APIDOC
## Get Request Join List

### Description
Fetches the list of users who have requested to join a group. Requires admin privileges.

### Method
GET

### Endpoint
`/groupRequestParticipantsList`

### Parameters
#### Query Parameters
- **jid** (string) - Required - The JID of the group.

### Response
#### Success Response (200)
- **requestList** (array of objects) - A list of users requesting to join.

### Response Example
```json
{
  "requestList": [
    {
      "jid": "requester1@s.whatsapp.net",
      "name": "Requester One",
      "requestedAt": 1678886400
    }
  ]
}
```
```

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

### Handle Baileys Events

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Shows how to listen for and handle events emitted by Baileys using the EventEmitter syntax. The example demonstrates logging incoming messages from the 'messages.upsert' event. Baileys events are well-typed, facilitating Intellisense support in editors like VS Code.

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

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

### Download Media Message using Baileys

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Downloads a received media message (like images or videos) and saves it to a file. It uses `baileys-pro` functions to get the content type and download the media as a stream or buffer. Requires `fs` module and Baileys library. Optional `reuploadRequest` can be passed for handling deleted media.

```javascript
const { createWriteStream } = require('fs');
const { downloadMediaMessage, getContentType } = require("baileys-pro");

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

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

### Get Group Join Request List

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Fetches a list of users who have requested to join a specific WhatsApp group. The list is then logged to the console.

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

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

### Send Text Message with Link Preview using Baileys

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Sends a text message that includes a link, allowing Baileys to generate a link preview. This functionality requires the `link-preview-js` dependency to be installed (`yarn add link-preview-js`).

```javascript
await sock.sendMessage(
    jid,
    {
        text: 'Hi, this was sent using https://github.com/whiskeysockets/baileys'
    }
)
```

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

### Get Group Info by Invite Code

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Fetches information about a WhatsApp group using its invite code. The group details are then logged to the console.

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

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

### Start Socket with Pairing Code Authentication in Baileys-Pro

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Establishes a WhatsApp connection using a pairing code, an alternative to QR code scanning for WhatsApp Web. This method supports single-device connections and requires the 'baileys-pro' library. The phone number must be in a specific format (digits only, including country code).

```javascript
const { default: makeWASocket } = require("baileys-pro")

const sock = makeWASocket({
    // can provide additional config here
    printQRInTerminal: false //need to be false
})

// Normal Pairing
if (!sock.authState.creds.registered) {
    const number = 'XXXXXXXXXXX' // Replace with the actual phone number
    const code = await sock.requestPairingCode(number)
    console.log(code)
}

// Custom Pairing
if (!sock.authState.creds.registered) {
    const pair = "AB123C4D" // only 8 alphanumeric (no more or less)
    const number = 'XXXXXXXXXXX' // Replace with the actual phone number
    const code = await sock.requestPairingCode(number, pair)
    console.log(code)
}
```

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

### Send Text Message with Baileys

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

A simple example of sending a basic text message to a specified JID. This is a fundamental messaging function in Baileys.

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

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

### Get Group Info by Invite Code

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Retrieves information about a group using its invite code.

```APIDOC
## Get Group Info by Invite Code

### Description
Fetches details about a group by providing its invitation code, without joining the group.

### Method
GET

### Endpoint
`/groupGetInviteInfo`

### Parameters
#### Query Parameters
- **code** (string) - Required - The invitation code for the group.

### Response
#### Success Response (200)
- **groupInfo** (object) - An object containing group information.

### Response Example
```json
{
  "groupInfo": {
    "id": "1234567890@g.us",
    "subject": "Example Group",
    "creationTime": 1678886400,
    "creatorJid": "12345@s.whatsapp.net"
  }
}
```
```

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

### Get Group Invite Code

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Retrieves the invite code for a group.

```APIDOC
## Get Invite Code

### Description
Generates and returns the invite code for a specified group, which can be used to create a join link.

### Method
GET

### Endpoint
`/groupInviteCode`

### Parameters
#### Query Parameters
- **jid** (string) - Required - The JID of the group.

### Response
#### Success Response (200)
- **code** (string) - The invite code for the group.

### Response Example
```json
{
  "code": "AbCdEfGhIjKlMnOpQrStUvWxY"
}
```
```

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

### Send Buttons Flow Message with Baileys

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

This example shows how to send a buttons flow message, which supports interactive elements like single select dropdowns. It includes text, footer, and buttons with various types, including a nativeFlowInfo for interactive selection.

```javascript
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 });
```

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

### Get Newsletter Admin Count

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Fetches the number of administrators for a given newsletter JID.

```javascript
const count = await sock.newsletterAdminCount(jid)

```

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

### Get WhatsApp Group Invite Code

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Retrieves the invite code for a given WhatsApp group. This code can be used to construct a joinable link.

```javascript
const code = await sock.groupInviteCode(jid)
console.log('group code: ' + code)
```

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

### Send Event Message (JavaScript)

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Sends an event message with details like cancellation status, name, description, location, link, start and end times, and guest allowance. The 'sock.sendMessage' function is used with an 'event' object containing these properties.

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

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

### Implement In-Memory Data Store

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Demonstrates setting up and using an in-memory data store for WhatsApp chats and contacts with Baileys-Pro. The store can persist data to a file and listen for updates from the WA connection. It requires the 'baileys-pro' package.

```javascript
const makeWASocket = require("baileys-pro").default;
const { makeInMemoryStore } = require("baileys-pro");
// 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))
})
```

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

### Send Interactive Product Message with Buttons (JavaScript)

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Sends an interactive message featuring a product with its image, title, description, price, and URL, along with buttons. Requires product details, business owner JID, 'sock' object, and recipient JID.

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

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

### Import Baileys Pro in JavaScript

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Demonstrates how to import the Baileys Pro library, specifically the makeWASocket function, into your JavaScript project. This is essential for initializing and interacting with the WhatsApp API.

```javascript
const { default: makeWASocket } = require("baileys-pro")
```

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

### Fetch WhatsApp Business Profile

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Retrieves business profile information, such as description and category, for a given JID. The result is logged to the console.

```javascript
const profile = await sock.getBusinessProfile(jid)
console.log('business description: ' + profile.description + ', category: ' + profile.category)
```

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

### Create Group

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Creates a new group with specified participants.

```APIDOC
## Create a Group

### Description
Creates a new WhatsApp group with a given subject and a list of initial participants.

### Method
POST

### Endpoint
`/groupCreate`

### Parameters
#### Request Body
- **subject** (string) - Required - The subject (name) of the new group.
- **participants** (array of strings) - Required - A list of JIDs for the initial participants.

### Response
#### Success Response (200)
- **gid** (string) - The group ID of the newly created group.

### Response Example
```json
{
  "gid": "1234567890@g.us"
}
```
```

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

### Decrypt Poll Votes

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Handles encrypted poll votes that are typically processed in `messages.update`. This example shows how to retrieve the original poll message and aggregate vote updates. It depends on a `getMessage` implementation and `getAggregateVotesInPollMessage` utility.

```javascript
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,
                    })
                )
            }
        }
    }
})
```

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

### Save & Restore Sessions with MultiFileAuthState

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Implements session saving and restoring using `useMultiFileAuthState`. This utility function saves authentication credentials (creds and keys) to a specified directory, allowing the application to reconnect without re-scanning the QR code. It requires the `baileys-pro` library and handles credential updates automatically.

```javascript
const makeWASocket = require("baileys-pro").default;
const { useMultiFileAuthState } = require("baileys-pro");

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

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

### Manage Group Participants

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Adds, removes, promotes, or demotes participants in a group.

```APIDOC
## Add/Remove or Demote/Promote Participants

### Description
Manages participants within a group by adding, removing, promoting, or demoting them. Requires admin privileges.

### Method
POST

### Endpoint
`/groupParticipantsUpdate`

### Parameters
#### Path Parameters
- **jid** (string) - Required - The JID of the group.

#### Request Body
- **participants** (array of strings) - Required - A list of JIDs for the participants to modify.
- **action** (string) - Required - The action to perform. Options: 'add', 'remove', 'demote', 'promote'.

### Response
#### Success Response (200)
- **updatedParticipants** (array of objects) - A list of participants and the result of the action.

### Response Example
```json
{
  "updatedParticipants": [
    {
      "jid": "abcd@s.whatsapp.net",
      "status": "SUCCESS"
    }
  ]
}
```
```

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

### Cache Group Metadata with NodeCache

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Implements caching for group metadata using NodeCache to improve performance when dealing with groups. It caches metadata upon group updates and participant changes, with a Time-To-Live (TTL) of 5 minutes. This requires the NodeCache library.

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

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

### Fetch Business Profile

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Fetches the business profile details for a given JID.

```APIDOC
## Fetch Business Profile

### Description
Retrieves business profile information such as description and category for a specified JID.

### Method
GET

### Endpoint
`/getBusinessProfile`

### Parameters
#### Query Parameters
- **jid** (string) - Required - The JID of the business.

### Response
#### Success Response (200)
- **profile** (object) - An object containing business profile details.
  - **description** (string) - The business description.
  - **category** (string) - The business category.

### Response Example
```json
{
  "profile": {
    "description": "We sell the best widgets!",
    "category": "Retail"
  }
}
```
```

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

### Fetch Presence

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Subscribes to and logs presence updates for a JID.

```APIDOC
## Fetch Presence

### Description
Allows you to subscribe to and receive real-time presence updates (e.g., typing, online) for a specific JID.

### Method
GET / POST

### Endpoint
`/presence.update` (event listener)
`/presenceSubscribe` (request subscription)

### Parameters
#### Event Listener (`presence.update`)
- **Updates** (object) - An object containing presence update information.

#### Request (presenceSubscribe)
- **jid** (string) - Required - The JID to subscribe to presence updates for.

### Response
#### Event Response (`presence.update`)
- **presence** (object) - Information about the presence update.

### Example (Subscription)
```javascript
// Request updates for a chat
await sock.presenceSubscribe(jid)

// Listen for updates
sock.ev.on('presence.update', console.log)
```
```

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

### Create Newsletter

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Creates a new newsletter with a specified name and description. Returns the created newsletter object.

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

```

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

### Send Video Message using Baileys

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Sends a video message, optionally as a video note if `ptv` is set to true. It can accept a video from a URL or a local file path. Requires the Baileys library.

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

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

### Enable Debug Logging Level in Baileys-Pro

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Demonstrates how to enable debug logging for the Baileys library. This is useful for troubleshooting and understanding the internal workings of the WhatsApp client. The specific method or configuration for enabling debug level is not provided in the snippet but is referenced as a topic.

```javascript
// Enabling Debug Level in Baileys Logs
// (Specific code not provided, refer to Baileys documentation for implementation)
```

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

### Query Group Metadata

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Fetches metadata for a group, including participants, subject, and description.

```APIDOC
## Query Metadata (participants, name, description...)

### Description
Retrieves comprehensive metadata for a specified group, including its ID, subject, description, creation time, and participant list.

### Method
GET

### Endpoint
`/groupMetadata`

### Parameters
#### Query Parameters
- **jid** (string) - Required - The JID of the group.

### Response
#### Success Response (200)
- **metadata** (object) - An object containing group metadata.
  - **id** (string) - The group ID.
  - **subject** (string) - The group subject.
  - **desc** (string) - The group description.
  - **creationTime** (number) - The group creation timestamp.
  - **creatorJid** (string) - The JID of the group creator.
  - **participants** (array of objects) - List of participants.

### Response Example
```json
{
  "metadata": {
    "id": "1234567890@g.us",
    "subject": "My Group",
    "desc": "A group for friends.",
    "creationTime": 1678886400,
    "creatorJid": "12345@s.whatsapp.net",
    "participants": [
      {
        "id": "12345@s.whatsapp.net",
        "admin": "admin"
      }
    ]
  }
}
```
```

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

### Join Group using groupInviteMessage

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Joins a group using a `groupInviteMessage` object.

```APIDOC
## Join using `groupInviteMessage`

### Description
Allows a user to join a group by processing a `groupInviteMessage` object, typically received from another user.

### Method
POST

### Endpoint
`/groupAcceptInviteV4`

### Parameters
#### Path Parameters
- **jid** (string) - Required - The JID associated with the invite message.

#### Request Body
- **groupInviteMessage** (object) - Required - The `groupInviteMessage` object containing invite details.

### Response
#### Success Response (200)
- **groupName** (string) - The name of the group joined.

### Response Example
```json
{
  "groupName": "Invited Group"
}
```
```

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

### Fetch All Participating Groups Metadata

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Retrieves metadata for all WhatsApp groups the current user is a participant in. The fetched data is logged to the console.

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

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

### Approve or Reject Group Join Request

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Processes join requests for a WhatsApp group, allowing admins to either approve or reject participants. Requires the group JID, a list of participant JIDs, and the action ('approve' or 'reject').

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

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

### Join Group Using Invitation Code

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Joins a group using its invitation code.

```APIDOC
## Join Using Invitation Code

### Description
Allows a user to join a group by providing its invitation code.

### Method
POST

### Endpoint
`/groupAcceptInvite`

### Parameters
#### Request Body
- **code** (string) - Required - The invitation code for the group (without the `https://chat.whatsapp.com/` prefix).

### Response
#### Success Response (200)
- **groupName** (string) - The name of the group joined.

### Response Example
```json
{
  "groupName": "My Awesome Group"
}
```
```

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

### Approve/Reject Request Join

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Approves or rejects users who have requested to join a group.

```APIDOC
## Approve/Reject Request Join

### Description
Processes requests from users to join a group, either approving or rejecting them. Requires admin privileges.

### Method
POST

### Endpoint
`/groupRequestParticipantsUpdate`

### Parameters
#### Path Parameters
- **jid** (string) - Required - The JID of the group.

#### Request Body
- **participants** (array of strings) - Required - A list of JIDs of the users whose requests are being processed.
- **action** (string) - Required - The action to perform. Options: 'approve', 'reject'.

### Response
#### Success Response (200)
- **results** (array of objects) - The outcome of the approval/rejection for each participant.

### Response Example
```json
{
  "results": [
    {
      "jid": "requester1@s.whatsapp.net",
      "status": "APPROVED"
    }
  ]
}
```
```

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

### Subscribe to Presence Updates

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Listens for presence updates (e.g., typing, online status) for a chat and subscribes to receive these updates. It logs all presence updates to the console.

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

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

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

### Enable Debug Logging

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Configure Baileys to log unhandled messages from WhatsApp at the debug level.

```APIDOC
## Configuration: Debug Logging

### Description
Enables the logging of unhandled messages from WhatsApp in the console by setting the logger level to 'debug'.

### Method
Configuration

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
const sock = makeWASocket({
    logger: P({ level: 'debug' })
})
```

### Response
N/A

### Notes
This setting allows visibility into all sorts of messages WhatsApp sends, which can be useful for debugging custom functionality.
```

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

### Fetch All Participating Groups Metadata

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Retrieves metadata for all groups the current user is a part of.

```APIDOC
## Get All Participating Groups Metadata

### Description
Fetches metadata for all groups that the current user is currently a member of.

### Method
GET

### Endpoint
`/groupFetchAllParticipating`

### Response
#### Success Response (200)
- **groups** (array of objects) - A list of group metadata objects.

### Response Example
```json
{
  "groups": [
    {
      "id": "1234567890@g.us",
      "subject": "My Group",
      "creationTime": 1678886400
    }
  ]
}
```
```

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

### Configure Baileys-Pro for Full Message History Sync

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Configures the Baileys-Pro socket to synchronize the complete message history upon connection. This involves setting the `syncFullHistory` option to `true` and optionally customizing the browser emulation using `Browsers.macOS('Desktop')` for potentially richer history retrieval.

```javascript
const { default: makeWASocket } = require("baileys-pro")
const Browsers = require("baileys-pro/lib/browsers")

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

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

### Create WhatsApp Group

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Creates a new WhatsApp group with a specified subject and a list of participant JIDs. It logs the new group's ID and sends an initial message to it.

```javascript
// 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
```

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

### Send GIF Message using Baileys

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Sends a GIF as a video message with the `gifPlayback` flag enabled, as WhatsApp does not natively support GIF files. It reads the GIF file from the file system. Requires the `fs` module.

```javascript
await sock.sendMessage(
    jid,
    {
        video: fs.readFileSync('Media/ma_gif.mp4'),
        caption: 'hello word',
        gifPlayback: true
    }
)
```

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

### Send List Message (JavaScript)

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Constructs and sends a list message with sections and rows. The 'sock.sendMessage' function is used to send a structured list message that includes a title, footer, button text, and sections with options. Each option can have a title, rowId, and an optional description.

```javascript
const sections = [
    {
	ttitle: "Section 1",
	rows: [
	    {title: "Option 1", rowId: "option1"},
	    {title: "Option 2", rowId: "option2", description: "This is a description"}
	]
    },
   {
	ttitle: "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)
```

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

### Send Audio Message using Baileys

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Sends an audio message. For cross-device compatibility, the audio should be converted to an OGG file using `ffmpeg` with specific flags (opus codec, 1 channel, etc.). Requires the Baileys library.

```bash
ffmpeg -i input.mp4 -avoid_negative_ts make_zero -ac 1 output.ogg
```

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

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

### Send Interactive Media Message with Buttons (JavaScript)

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Sends an interactive message that includes media (like an image) along with a caption, title, footer, and buttons. The media can be a URL or a buffer. Requires the 'sock' object and recipient JID.

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

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

### User Querys API

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Provides methods to query user information on WhatsApp, such as checking if a user ID exists and fetching chat history.

```APIDOC
## User Querys

### Check If ID Exists in Whatsapp

#### Description
Checks if a given WhatsApp ID (JID) exists on WhatsApp.

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

#### Parameters
- **jid** (string) - Required - The WhatsApp ID to check.

#### Response (Success)
- **exists** (boolean) - Indicates if the JID exists on WhatsApp.
- **jid** (string) - The JID if it exists.

### Query Chat History (groups too)

#### Description
Fetches a specified number of messages from a chat's history. You need to provide the key and timestamp of the oldest message in the chat to paginate correctly.

#### Method
```javascript
const msg = await getOldestMessageInChat(jid) // Implement this function to get the oldest message
await sock.fetchMessageHistory(
    50, // quantity (max: 50 per query)
    msg.key,
    msg.messageTimestamp
)
```

#### Parameters
- **quantity** (number) - Required - The number of messages to fetch (maximum 50).
- **key** (object) - Required - The key of the oldest message.
- **messageTimestamp** (number) - Required - The timestamp of the oldest message.

#### Note
Messages will be received in the `messaging.history-set` event.
```

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

### Register Callback for Websocket Events in Baileys-Pro

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Explains the process of registering a callback function to handle WebSocket events within the Baileys library. This allows for real-time event processing and custom logic based on incoming WebSocket data. The exact implementation details would depend on the Baileys API.

```javascript
// Register a Callback for Websocket Events
// (Specific code not provided, refer to Baileys documentation for implementation)
```

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

### Query WhatsApp Group Metadata

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Retrieves metadata for a WhatsApp group, including its ID, subject (name), and description. The fetched information is logged to the console.

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

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

### Send Reaction Message (JavaScript)

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Adds a reaction to a specific message. Requires the recipient JID, the reaction text (emoji), and the key of the message to react to. Uses the 'sock' object.

```javascript
await sock.sendMessage(
    jid,
    {
        react: {
            text: '💖', // use an empty string to remove the reaction
            key: message.key
        }
    }
)
```

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

### Reject Call API

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Allows the rejection of incoming WhatsApp calls. The `callId` and `callFrom` parameters are required, which can be obtained from the `call` event.

```APIDOC
## Reject Call

### Description
Allows the rejection of incoming WhatsApp calls. You can obtain `callId` and `callFrom` from the `call` event.

### Method
```javascript
await sock.rejectCall(callId, callFrom)
```
```

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

### Forward a Message (JavaScript)

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Forwards an existing message. Requires the message object, which can be obtained from a data store or a message object. Uses the 'sock' object and recipient JID.

```javascript
const msg = getMessageFromStore() // implement this on your end
await sock.sendMessage(jid, { forward: msg }) // WA forward the message!
```

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

### Receive Full History

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Configures the socket to synchronize the full message history upon connection. This is achieved by setting the `syncFullHistory` option to `true` and optionally customizing the browser emulation.

```APIDOC
## Receive Full History

### Description
Configures the socket to synchronize the full message history upon connection. This is achieved by setting the `syncFullHistory` option to `true` and optionally customizing the browser emulation for a more robust connection.

### Method
GET (Implicit)

### Endpoint
N/A

### Parameters
None

### Request Example
```javascript
const { default: makeWASocket, Browsers } = require("baileys-pro");

const sock = makeWASocket({
    // other options...
    browser: Browsers.macOS('Desktop'), // or Browsers.ubuntu('Desktop')
    syncFullHistory: true
});
```

### Response
#### Success Response (200)
Socket initialized with full history synchronization enabled.

#### Response Example
(No direct response, connection is established with history sync)
```

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

### Send Interactive Text Message with Buttons (JavaScript)

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Sends an interactive text message with customizable title, subtitle, footer, and buttons. Supports quick reply and CTA URL buttons. Requires the 'sock' object and recipient JID.

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

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

### Send Buttons Message with Baileys

Source: https://github.com/zervidas/baileys-pro/blob/main/README.md

Demonstrates how to send a buttons message. This message type includes a text body, footer, and a list of buttons. Each button has an ID, display text, and type. The header type is set to 1, and the message is set to view once.

```javascript
// 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 })
```
Tokens:
Raw