Wileys

https://www.npmjs.com/package/wileys
Admin
Wileys is a modern WhatsApp Web API library built with TypeScript that enables multi-device WhatsApp...
Tokens:68,506
Snippets:570
Trust Score:9.6
Update:7 months ago
Show doc for...
Tokens:
Raw
### Example Start - Full Connection Flow

Source: https://www.npmjs.com/package/wileys?activeTab=dependents

A comprehensive example demonstrating how to connect to WhatsApp, handle connection updates, and process incoming messages.

```APIDOC
## Example Start - Full Connection Flow

### Description
A comprehensive example demonstrating how to connect to WhatsApp, handle connection updates, and process incoming messages.

### Method
N/A (Application Logic)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
const makeWASocket = require("wileys").default
const { DisconnectReason, useMultiFileAuthState } = require("wileys")
const { Boom } = require('@hapi/boom')

async function connectToWhatsApp() {
    const { state, saveCreds } = await useMultiFileAuthState('auth_info_wileys')
    const sock = makeWASocket({
        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('Koneksi tertutup karena ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
            if(shouldReconnect) {
                connectToWhatsApp()
            }
        } else if(connection === 'open') {
            console.log('Koneksi terbuka')
        }
    })

    sock.ev.on('messages.upsert', async ({ messages }) => {
        for (const m of messages) {
            console.log(JSON.stringify(m, undefined, 2))
            console.log('Balas ke', m.key.remoteJid)
            await sock.sendMessage(m.key.remoteJid!, { text: 'Halo Dunia' })
        }
    })

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

connectToWhatsApp()
```

### Response
N/A

### Connection Event Summary
1. On first connection, `connection.update` is triggered, requesting a sock restart.
2. History messages are then received in `messaging.history-set`.
```

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

### Example Connection and Message Handling

Source: https://www.npmjs.com/package/wileys?activeTab=code

A comprehensive example demonstrating how to connect to WhatsApp, handle connection updates, and process incoming messages.

```APIDOC
## Example Connection and Message Handling

### Description
A comprehensive example demonstrating how to connect to WhatsApp, handle connection updates, and process incoming messages. This includes saving authentication credentials and responding to messages.

### Method
N/A (Example Script)

### Endpoint
N/A (Example Script)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
const makeWASocket = require("wileys").default
const { DisconnectReason, useMultiFileAuthState } = require("wileys")
const { Boom } = require('@hapi/boom')

async function connectToWhatsApp() {
    const { state, saveCreds } = await useMultiFileAuthState('auth_info_wileys')
    const sock = makeWASocket({
        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('Koneksi tertutup karena ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
            if(shouldReconnect) {
                connectToWhatsApp()
            }
        } else if(connection === 'open') {
            console.log('Koneksi terbuka')
        }
    })

    sock.ev.on('messages.upsert', async ({ messages }) => {
        for (const m of messages) {
            console.log(JSON.stringify(m, undefined, 2))
            console.log('Balas ke', m.key.remoteJid)
            await sock.sendMessage(m.key.remoteJid!, { text: 'Halo Dunia' })
        }
    })

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

connectToWhatsApp()
```

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

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

### Full Connection and Message Handling Example

Source: https://www.npmjs.com/package/wileys?activeTab=readme

A comprehensive example demonstrating connection, authentication, and message handling, including automatic reconnection.

```APIDOC
## Full Connection and Message Handling Example

### Description
This example provides a complete setup for connecting to WhatsApp, handling authentication using `useMultiFileAuthState`, managing connection updates (including automatic reconnection), and processing incoming messages.

### Method
N/A (Script execution)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
const makeWASocket = require("wileys").default
const { DisconnectReason, useMultiFileAuthState } = require("wileys")
const { Boom } = require('@hapi/boom')

async function connectToWhatsApp() {
    const { state, saveCreds } = await useMultiFileAuthState('auth_info_wileys')
    const sock = makeWASocket({
        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('Koneksi tertutup karena ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
            if(shouldReconnect) {
                connectToWhatsApp()
            }
        } else if(connection === 'open') {
            console.log('Koneksi terbuka')
        }
    })

    sock.ev.on('messages.upsert', async ({ messages }) => {
        for (const m of messages) {
            console.log(JSON.stringify(m, undefined, 2))
            console.log('Balas ke', m.key.remoteJid)
            await sock.sendMessage(m.key.remoteJid!, { text: 'Halo Dunia' })
        }
    })

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

connectToWhatsApp()
```

### Response
N/A (This is a script example)

### Response Example
N/A
```

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

### Example Connection and Message Handling

Source: https://www.npmjs.com/package/wileys?activeTab=versions

A comprehensive example demonstrating how to connect to WhatsApp, handle connection updates, process incoming messages, and manage authentication credentials. This snippet includes logic for reconnecting on close and sending a 'Halo Dunia' reply.

```javascript
const makeWASocket = require("wileys").default
const { DisconnectReason, useMultiFileAuthState } = require("wileys")
const { Boom } = require('@hapi/boom')

async function connectToWhatsApp() {
    const { state, saveCreds } = await useMultiFileAuthState('auth_info_wileys')
    const sock = makeWASocket({
        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('Koneksi tertutup karena ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
            if(shouldReconnect) {
                connectToWhatsApp()
            }
        } else if(connection === 'open') {
            console.log('Koneksi terbuka')
        }
    })

    sock.ev.on('messages.upsert', async ({ messages }) => {
        for (const m of messages) {
            console.log(JSON.stringify(m, undefined, 2))
            console.log('Balas ke', m.key.remoteJid)
            await sock.sendMessage(m.key.remoteJid!, { text: 'Halo Dunia' })
        }
    })

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

connectToWhatsApp()
```

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

### Basic Wileys WhatsApp Connection Example

Source: https://www.npmjs.com/package/wileys?activeTab=versions

A fundamental example demonstrating how to connect to WhatsApp using Wileys. It includes setting up authentication, handling connection updates, receiving messages, and saving credentials.

```javascript
const { default: makeWASocket, DisconnectReason, useMultiFileAuthState } = require('wileys')
const { Boom } = require('@hapi/boom')

async function connectToWhatsApp() {
    const { state, saveCreds } = await useMultiFileAuthState('auth_info_wileys')
    
    const sock = makeWASocket({
        auth: state,
        printQRInTerminal: true,
        browser: ['Wileys', 'Desktop', '3.0']
    })

    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('Koneksi tertutup karena ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
            if(shouldReconnect) {
                connectToWhatsApp()
            }
        } else if(connection === 'open') {
            console.log('✅ Berhasil terhubung ke WhatsApp!')
        }
    })

    sock.ev.on('messages.upsert', async ({ messages }) => {
        for (const m of messages) {
            if (!m.message) continue
            
            console.log('📱 Pesan baru:', JSON.stringify(m, undefined, 2))
            
            // Balas otomatis
            await sock.sendMessage(m.key.remoteJid!, { 
                text: 'Halo! Saya bot WhatsApp menggunakan Wileys 🤖' 
            })
        }
    })

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

connectToWhatsApp()
```

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

### Install Wileys npm Package

Source: https://www.npmjs.com/package/wileys?activeTab=dependents

Installs the stable version of the Wileys package using npm. This is the recommended installation method for most users.

```bash
npm i wileys
```

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

### Install Wileys npm Package

Source: https://www.npmjs.com/package/wileys?activeTab=readme

Installs the stable version of the Wileys package using npm or yarn. This is the recommended installation method for most users.

```bash
npm i wileys
```

```bash
yarn add wileys
```

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

### Basic Message Handling

Source: https://www.npmjs.com/package/wileys?activeTab=readme

A simple example of how to receive and log incoming messages.

```APIDOC
## Basic Message Handling

### Description
This example demonstrates how to set up a listener for incoming messages using the `messages.upsert` event and log them to the console.

### Method
N/A (Event listener setup)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
const sock = makeWASocket()
sock.ev.on('messages.upsert', ({ messages }) => {
    console.log('Dapat pesan:', messages)
})
```

### Response
N/A

### Response Example
N/A
```

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

### Link Preview

Source: https://www.npmjs.com/package/wileys?activeTab=dependencies

Send a message with a link preview. Requires 'link-preview-js' to be installed.

```APIDOC
## POST /sendMessage (Link Preview)

### Description
Sends a message containing a URL, which will automatically generate a link preview.

### Method
POST

### Endpoint
`/sendMessage`

### Parameters
#### Request Body
- **jid** (string) - Required - The recipient's JID.
- **content** (object) - Required - Message content with a `text` field containing a URL.
  - **text** (string) - Required - The message text including a URL.

### Request Example
```json
{
  "jid": "<recipient_jid>",
  "content": {
    "text": "Check this out: https://npmjs.com/wileys"
  }
}
```

### Response
(See Send Message API for response details)
```

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

### Install Wileys npm Package

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Instructions for installing the Wileys npm package. Supports both stable and latest versions. Uses npm and yarn package managers.

```bash
npm i wileys
```

```bash
npm i wileys@latest
```

```bash
yarn add wileys@latest
```

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

### Download Media Message

Source: https://www.npmjs.com/package/wileys?activeTab=dependencies

Provides an example of how to download media messages received in a chat.

```APIDOC
## POST /messages/media/download

### Description
Downloads media content from a received message.

### Method
POST

### Endpoint
`/messages/media/download`

### Parameters
#### Path Parameters
None

#### Query Parameters
- **message** (object) - Required - The message object containing the media.
- **saveTo** (string) - Required - Specifies where to save the media. Can be 'stream' or 'buffer'.
- **options** (object) - Optional - Additional options for downloading.
  - **logger** (object) - Optional - A logger instance.
  - **reuploadRequest** (function) - Optional - A function to handle re-upload requests.

### Request Example
```json
{
  "message": { ... }, // The full message object
  "saveTo": "stream"
}
```

### Response
#### Success Response (200)
- **mediaStream** (ReadableStream) - If `saveTo` is 'stream', returns a readable stream of the media.
- **mediaBuffer** (Buffer) - If `saveTo` is 'buffer', returns a buffer containing the media data.
```

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

### Implement Data Store

Source: https://www.npmjs.com/package/wileys?activeTab=dependents

Wileys provides a simple in-memory store implementation. This example shows how to initialize, read from, write to, and bind the store to the Wileys socket.

```APIDOC
## Implement Data Store

### Description
Wileys provides a simple in-memory store implementation. This example shows how to initialize, read from, write to, and bind the store to the Wileys socket.

### Method
N/A (Configuration & Event Handling)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
const makeWASocket = require("wileys").default
const { makeInMemoryStore } = require("wileys")

const store = makeInMemoryStore({ })

store.readFromFile('./wileys_store.json')

setInterval(() => {
    store.writeToFile('./wileys_store.json')
}, 10_000)

const sock = makeWASocket({ })
store.bind(sock.ev)

sock.ev.on('chats.upsert', () => {
    console.log('dapat obrolan', store.chats.all())
})

sock.ev.on('contacts.upsert', () => {
    console.log('dapat kontak', Object.values(store.contacts))
})
```

### Response
N/A

### Recommendation
It is highly recommended to build your own data store, as storing the entire chat history in memory is very RAM-intensive. The store also provides utility functions like `loadMessages` for faster data retrieval.
```

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

### Handle Incoming Messages

Source: https://www.npmjs.com/package/wileys?activeTab=dependents

Log incoming messages to the console. This is a basic example of listening to the `messages.upsert` event.

```APIDOC
## Handle Incoming Messages

### Description
Log incoming messages to the console. This is a basic example of listening to the `messages.upsert` event.

### Method
N/A (Event Listener)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
const sock = makeWASocket()
sock.ev.on('messages.upsert', ({ messages }) => {
    console.log('Dapat pesan:', messages)
})
```

### Response
N/A
```

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

### Connect with Pairing Code using Wileys

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Provides examples for connecting to WhatsApp using a pairing code with Wileys. It covers both normal pairing and custom pairing code generation, requiring a phone number.

```javascript
const { default: makeWASocket } = require("wileys")

const sock = makeWASocket({
    printQRInTerminal: false
})

// Pairing Normal
if (!sock.authState.creds.registered) {
    const number = '6285134816783'
    const code = await sock.requestPairingCode(number)
    console.log('🔑 Kode Pairing:', code)
}

// Pairing Kustom
if (!sock.authState.creds.registered) {
    const pair = "YP240125" // 8 karakter
    const number = '6285134816783'
    const code = await sock.requestPairingCode(number, pair)
    console.log('🔑 Kode Pairing Kustom:', code)
}
```

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

### Log WhatsApp Communication Frame

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Example of a logged WhatsApp communication frame, showing message details like level, sender, and frame content.

```json
{
    "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"
}
```

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

### Connect with QR Code using Wileys

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Illustrates how to initiate a WhatsApp connection using a QR code with the Wileys package. It shows how to configure the browser settings for the connection.

```javascript
const { default: makeWASocket, Browsers } = require("wileys")

const sock = makeWASocket({
    browser: Browsers.ubuntu('My App'),
    printQRInTerminal: true
})
```

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

### Install Latest Wileys Version (Edge)

Source: https://www.npmjs.com/package/wileys?activeTab=dependents

Installs the latest 'edge' version of the Wileys package using either npm or yarn. This version includes the newest features but may be less stable.

```bash
npm i wileys@latest
```

```bash
yarn add wileys@latest
```

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

### Implement Data Store

Source: https://www.npmjs.com/package/wileys?activeTab=readme

Set up an in-memory data store for chats, contacts, and messages, with persistence to a file.

```APIDOC
## Implement Data Store

### Description
This section describes how to implement a data store for managing chats, contacts, and messages. Wileys provides `makeInMemoryStore` for an in-memory solution with file-based persistence. It's recommended to build your own robust data store for production environments.

### Method
N/A (Configuration and setup)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
const makeWASocket = require("wileys").default
const { makeInMemoryStore } = require("wileys")

const store = makeInMemoryStore({ })

store.readFromFile('./wileys_store.json')

setInterval(() => {
    store.writeToFile('./wileys_store.json')
}, 10_000)

const sock = makeWASocket({ })
store.bind(sock.ev)

sock.ev.on('chats.upsert', () => {
    console.log('dapat obrolan', store.chats.all())
})

sock.ev.on('contacts.upsert', () => {
    console.log('dapat kontak', Object.values(store.contacts))
})
```

### Response
N/A (This is a setup example)

### Response Example
N/A

### Recommendation
Building your own data store is highly recommended for production use, as storing the entire chat history in memory can be RAM-intensive.
```

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

### Link Preview

Source: https://www.npmjs.com/package/wileys?activeTab=code

Send a message with a link preview.

```APIDOC
## POST /sendMessage (Link Preview)

### Description
Sends a message containing a URL. WhatsApp automatically generates a link preview for most URLs. Ensure `link-preview-js` is installed for enhanced preview generation if needed.

### Method
POST

### Endpoint
`/sendMessage`

### Parameters
#### Request Body
- **jid** (string) - Required - The recipient's WhatsApp ID.
- **content** (object) - Required - Message content, must contain a `text` field with a URL.
  - **text** (string) - Required - The text content including the URL.

### Request Example
```json
{
  "jid": "<recipient_jid>",
  "content": {
    "text": "Check out this link: https://npmjs.com/wileys"
  }
}
```

### Response
#### Success Response (200)
- **sentMessage** (object) - Details of the sent message.

#### Response Example
```json
{
  "sentMessage": {
    "key": {
      "remoteJid": "<recipient_jid>",
      "fromMe": true,
      "id": "<message_id>"
    },
    "message": {
      "extendedTextMessage": {
        "text": "Check out this link: https://npmjs.com/wileys",
        "previewType": "webpage"
      }
    }
  }
}
```
```

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

### Create Group

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Creates a new group with a specified name and adds initial participants. Returns the group ID and sends a welcome message.

```javascript
const group = await sock.groupCreate('Grup Saya', ['1234@s.whatsapp.net', '4564@s.whatsapp.net'])
console.log('grup dibuat dengan id: ' + group.gid)
await sock.sendMessage(group.id, { text: 'halo semuanya' })
```

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

### Get Broadcast List Info

Source: https://www.npmjs.com/package/wileys?activeTab=code

Retrieves information about a specific broadcast list, including its name and recipients.

```APIDOC
## GET /api/broadcast/info/{jid}

### Description
Retrieves information about a broadcast list.

### Method
GET

### Endpoint
/api/broadcast/info/{jid}

### Parameters
#### Path Parameters
- **jid** (string) - Required - The JID of the broadcast list (e.g., '1234@broadcast').

### Response
#### Success Response (200)
- **name** (string) - The name of the broadcast list.
- **recipients** (array) - A list of recipient JIDs.

#### Response Example
```json
{
  "name": "My Broadcast List",
  "recipients": [
    "user1@s.whatsapp.net",
    "user2@s.whatsapp.net"
  ]
}
```
```

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

### Send Message - Link Preview

Source: https://www.npmjs.com/package/wileys?activeTab=readme

Sending a message with a link. Wileys can generate link previews. Ensure `link-preview-js` is installed.

```APIDOC
### Kirim dengan Pratinjau Tautan

1. Secara default, WA tidak punya generasi tautan dari web.
2. Wileys punya fungsi untuk pratinjau tautan.
3. Tambahkan `link-preview-js` dengan `npm i link-preview-js`.
4. Kirim tautan:

```javascript
await sock.sendMessage(
    jid,
    {
        text: 'Halo, ini dikirim menggunakan https://npmjs.com/wileys'
    }
)
```
```

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

### Chat History API

Source: https://www.npmjs.com/package/wileys?activeTab=dependents

Retrieve the oldest messages in a chat. This requires implementing a function to get the oldest message key and timestamp.

```APIDOC
## Query Riwayat Obrolan (grup juga)

### Description
Butuh pesan tertua di obrolan.

### Method
GET (Implicit)

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
const msg = await getOldestMessageInChat(jid) // implementasikan sendiri
await sock.fetchMessageHistory(
    50, // jumlah (max: 50 per query)
    msg.key,
    msg.messageTimestamp
)
```

### Response
#### Success Response (200)
Messages from the chat history.

#### Response Example
(Response structure depends on `fetchMessageHistory` implementation)
```

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

### Fetch Business Profile

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Retrieves the business profile information, including description and category, for a given JID. Uses the `sock.getBusinessProfile` method.

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

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

### Get Group Info from Invite

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Retrieves information about a group using its invite code without joining. Uses the `sock.groupGetInviteInfo` method.

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

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

### Get Group Invite Code

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Retrieves the invite code for a group, which can be used to generate a join link. Uses the `sock.groupInviteCode` method.

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

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

### Fetch Blocklist

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Retrieves a list of all users that have been blocked. Uses the `sock.fetchBlocklist` method.

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

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

### Caching Group Metadata

Source: https://www.npmjs.com/package/wileys?activeTab=dependents

Implement caching for group metadata to optimize performance. This example uses NodeCache to store and retrieve group metadata.

```APIDOC
## Caching Group Metadata

### Description
Implement caching for group metadata to optimize performance. This example uses NodeCache to store and retrieve group metadata.

### Method
N/A (Configuration)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
const { default: makeWASocket } = require("wileys")
const NodeCache = require('node-cache')

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

### Response
N/A
```

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

### Caching Group Metadata

Source: https://www.npmjs.com/package/wileys?activeTab=readme

Implement group metadata caching for improved performance. This example uses NodeCache to store and retrieve group metadata.

```APIDOC
## Caching Group Metadata

### Description
Implement caching for group metadata to optimize performance. This approach uses an in-memory cache (NodeCache) to store metadata, reducing the need to fetch it repeatedly.

### Method
N/A (Configuration within the library)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
const { default: makeWASocket } = require("wileys")
const NodeCache = require('node-cache')

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

### Response
N/A (This is a configuration example)

### Response Example
N/A
```

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

### Media Message Thumbnail Generation

Source: https://www.npmjs.com/package/wileys

Information on how to generate thumbnails for media messages. Requires `jimp` or `sharp` for images/stickers and `ffmpeg` for videos.

```APIDOC
## POST /messages/media/thumbnail

### Description
Generates a thumbnail for a media message. This process is automatic if `jimp` or `sharp` are installed for images and stickers. For videos, `ffmpeg` must be installed.

### Method
POST

### Endpoint
/messages/media/thumbnail

### Parameters
#### Request Body
- **message** (object) - Required - The media message object.
- **type** (string) - Required - The type of media message (e.g., 'imageMessage', 'stickerMessage', 'videoMessage').

### Request Example
```json
{
  "message": { ... }, // The media message object
  "type": "imageMessage"
}
```

### Response
#### Success Response (200)
- **thumbnail** (string) - The generated thumbnail data or URL.

#### Response Example
```json
{
  "thumbnail": "base64EncodedThumbnailData..."
}
```
```

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

### Fetch List of Join Requests

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Retrieves a list of pending join requests for a group. Requires the group JID and uses `sock.groupRequestParticipantsList`.

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

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

### User Query

Source: https://www.npmjs.com/package/wileys?activeTab=readme

API to check if a user exists on WhatsApp.

```APIDOC
## GET /whatsapp/check

### Description
Checks if a given JID exists on WhatsApp.

### Method
GET

### Endpoint
`/whatsapp/check`

### Parameters
#### Path Parameters
None

#### Query Parameters
- **jid** (string) - Required - The JID to check.

### Request Example
```
GET /whatsapp/check?jid=user_jid
```

### Response
#### Success Response (200)
- **result** (array) - An array containing the check result.
  - **exists** (boolean) - Indicates if the JID exists on WhatsApp.
  - **jid** (string) - The JID if it exists.

#### Response Example
```json
[
  {
    "exists": true,
    "jid": "user_jid"
  }
]
```
```

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

### Fetch All Participating Groups Metadata

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Retrieves metadata for all groups the user is currently participating in. Uses the `sock.groupFetchAllParticipating` method.

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

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

### Call Handling

Source: https://www.npmjs.com/package/wileys?activeTab=readme

APIs for handling incoming calls.

```APIDOC
## POST /calls/reject

### Description
Rejects an incoming call.

### Method
POST

### Endpoint
`/calls/reject`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **callId** (string) - Required - The ID of the call to reject.
- **callFrom** (string) - Required - The JID of the caller.

### Request Example
```json
{
  "callId": "call_id_123",
  "callFrom": "caller_jid"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the call rejection.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### WebSocket Event Callbacks

Source: https://www.npmjs.com/package/wileys?activeTab=dependencies

Demonstrates how to register callbacks for specific WebSocket events, allowing for custom handling of incoming data.

```APIDOC
## Register Callback for WebSocket Events

### Description
Allows you to register custom callback functions for specific WebSocket events, enabling real-time data handling and custom logic.

### Method
`sock.ws.on(event, callback)`

### Endpoint
`sock.ws.on(event, callback)`

### Parameters
#### Path Parameters
- **event** (string) - Required - The WebSocket event to listen for. Can include specific tags and IDs (e.g., 'CB:edge_routing', 'CB:edge_routing,id:abcd', 'CB:edge_routing,id:abcd,routing_info').
- **callback** (function) - Required - The function to execute when the event is triggered. It receives a `node` (BinaryNode) as an argument.

### Request Example
```javascript
// For the 'edge_routing' tag
sock.ws.on('CB:edge_routing', (node) => { /* handle event */ })

// With the id 'abcd'
sock.ws.on('CB:edge_routing,id:abcd', (node) => { /* handle event */ })

// With the node routing_info
sock.ws.on('CB:edge_routing,id:abcd,routing_info', (node) => { /* handle event */ })
```

### Response
#### Success Response (200)
No specific response body mentioned, implies success if no error is thrown.
```

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

### Save Auth Info

Source: https://www.npmjs.com/package/wileys?activeTab=readme

Avoid repeated QR code scanning by saving authentication credentials.

```APIDOC
## Save Auth Info

### Description
Persist authentication credentials to avoid the need for frequent QR code scanning. This uses `useMultiFileAuthState` to store the authentication state, typically in files.

### Method
N/A (Configuration within the library)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
const makeWASocket = require("wileys").default
const { useMultiFileAuthState } = require("wileys")

async function connect() {
    const { state, saveCreds } = await useMultiFileAuthState('auth_info_wileys')
    const sock = makeWASocket({ auth: state })
    sock.ev.on('creds.update', saveCreds)
}

connect()
```

### Response
N/A (This is a configuration example)

### Response Example
N/A

### Important Note
`useMultiFileAuthState` stores auth state in a folder. For production, it is recommended to use a SQL/No-SQL database and manage key updates carefully.
```

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

### Implement In-Memory Data Store

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Set up an in-memory data store for chats, contacts, and messages using `makeInMemoryStore`. This store listens to various Wileys events to keep data synchronized. It includes functionality to read from and write to a JSON file for persistence, with periodic saving.

```javascript
const makeWASocket = require("wileys").default
const { makeInMemoryStore } = require("wileys")

const store = makeInMemoryStore({ })

store.readFromFile('./wileys_store.json')

setInterval(() => {
    store.writeToFile('./wileys_store.json')
}, 10_000)

const sock = makeWASocket({ })
store.bind(sock.ev)

sock.ev.on('chats.upsert', () => {
    console.log('dapat obrolan', store.chats.all())
})

sock.ev.on('contacts.upsert', () => {
    console.log('dapat kontak', Object.values(store.contacts))
})
```

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

### Accept Group Invite

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Joins a group using its invite code. The code should not include the base URL. Uses the `sock.groupAcceptInvite` method.

```javascript
const response = await sock.groupAcceptInvite(code)
console.log('bergabung ke: ' + response)
```

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

### Media Message Thumbnail Generation

Source: https://www.npmjs.com/package/wileys?activeTab=dependencies

Explains how to generate thumbnails for image and sticker messages, and the requirements for video thumbnails.

```APIDOC
## Media Message Manipulation

### Thumbnail Generation
Automatic thumbnails are generated for images and stickers if `jimp` or `sharp` are installed (`npm i jimp` or `npm i sharp`). For videos, `ffmpeg` must be installed.
```

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

### Send Message - View Once

Source: https://www.npmjs.com/package/wileys?activeTab=readme

Sending media messages (image, video, audio) that can only be viewed once by setting `viewOnce: true`.

```APIDOC
#### Pesan View Once

Tambahkan `viewOnce: true` untuk semua pesan di atas.

```javascript
await sock.sendMessage(
    id, 
    {
        image: {
            url: './Media/ma_img.png'
        },
        viewOnce: true, // bekerja dengan video, audio juga
        caption: 'halo dunia'
    }
)
```
```

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

### Enable Full Message History Sync with Wileys

Source: https://www.npmjs.com/package/wileys?activeTab=versions

Shows how to configure Wileys to sync the full message history upon connection. This involves setting the `syncFullHistory` option to `true` and optionally configuring the browser for a desktop-like connection.

```javascript
const { default: makeWASocket, Browsers } = require("wileys")

const sock = makeWASocket({
    browser: Browsers.macOS('Desktop'),
    syncFullHistory: true
})
```

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

### Re-upload Media Message

Source: https://www.npmjs.com/package/wileys

Explains how to re-upload a media message to WhatsApp servers, useful when old media is deleted.

```APIDOC
## POST /messages/media/reupload

### Description
Re-uploads a media message to WhatsApp servers. This is useful because WhatsApp may delete old media from their servers.

### Method
POST

### Endpoint
/messages/media/reupload

### Parameters
#### Request Body
- **message** (object) - Required - The message object to re-upload.

### Request Example
```javascript
await sock.updateMediaMessage(msg)
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the re-upload was successful.

#### Response Example
```json
{
  "success": true
}
```
```

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

### Download Media Message

Source: https://www.npmjs.com/package/wileys

Provides instructions on how to download media messages received. Supports streaming or buffer download.

```APIDOC
## GET /messages/media/download

### Description
Downloads media from a received message. You can choose to download as a stream or a buffer.

### Method
GET

### Endpoint
/messages/media/download

### Parameters
#### Query Parameters
- **message** (object) - Required - The message object containing the media.
- **saveTo** (string) - Required - Specifies the download format, either 'stream' or 'buffer'.
- **options** (object) - Optional - Additional options for downloading.
  - **logger** (object) - Optional - A logger instance.
  - **reuploadRequest** (function) - Optional - A function to handle re-upload requests.

### Request Example
```javascript
// Example using stream
const stream = await downloadMediaMessage(m, 'stream', {}, { logger, reuploadRequest: sock.updateMediaMessage })
const writeStream = require('fs').createWriteStream('./my-download.jpeg')
stream.pipe(writeStream)

// Example using buffer
const buffer = await downloadMediaMessage(m, 'buffer')
```

### Response
#### Success Response (200)
- **data** (Stream | Buffer) - The downloaded media content.

#### Response Example
```javascript
// For stream, the response is a readable stream.
// For buffer, the response is a Buffer object.
```
```

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

### Send Message - Text

Source: https://www.npmjs.com/package/wileys?activeTab=readme

How to send a simple text message.

```APIDOC
### Pesan Teks

```javascript
await sock.sendMessage(jid, { text: 'halo dunia' })
```
```

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

### Video Message

Source: https://www.npmjs.com/package/wileys?activeTab=dependencies

Send a video message.

```APIDOC
## POST /sendMessage (Video Message)

### Description
Sends a video message.

### Method
POST

### Endpoint
`/sendMessage`

### Parameters
#### Request Body
- **jid** (string) - Required - The recipient's JID.
- **content** (object) - Required - Message content with a `video` field.
  - **video** (Buffer | Stream | string | object) - Required - The video data. Can be a Buffer, Stream, file path, or an object with a `url` property.
  - **caption** (string) - Optional - A caption for the video.
  - **ptv** (boolean) - Optional - Set to `true` for a video note.

### Request Example
```json
{
  "jid": "<recipient_jid>",
  "content": {
    "video": {
      "url": "./Media/ma_gif.mp4"
    },
    "caption": "halo dunia",
    "ptv": false
  }
}
```

### Response
(See Send Message API for response details)
```
Tokens:
Raw