Package detail

baileys-mod

nstar-y9.5kMIT6.8.5

Custom Baileys WhatsApp API

baileys, baileys-mod, wabot, whatsapp

readme

Baileys Modification

📖 Table of Contents


Important Note

The original repository was initially removed by its creator and subsequently taken over by WhiskeySockets. Building upon this foundation, I have implemented several enhancements and introduced new features that were not present in the original repository. These improvements aim to elevate functionality and provide a more robust and versatile experience.

Install

Install in package.json:

"dependencies": {
    "baileys": "npm:baileys-mod"
}

or install in terminal:

npm install baileys@npm:baileys-mod

Then import the default function in your code:

// type esm
import makeWASocket from 'baileys'
// type cjs
const { default: makeWASocket } = require("baileys")

Added Features and Improvements

Feature Description
💬 Send Messages to Channels Supports sending text and media messages to channels.
🔘 Button & Interactive Messages Supports sending button messages and interactive messages on WhatsApp Messenger and WhatsApp Business.
🤖 AI Message Icon Customize message appearances with an optional AI icon, adding a modern touch.
🖼️ Full-Size Profile Pictures Allows users to upload profile pictures in their original size without cropping, ensuring better quality and visual presentation.
🔑 Custom Pairing Codes Users can now create and customize pairing codes as they wish, enhancing convenience and security when connecting devices.
🛠️ Libsignal Fixes Enjoy a cleaner development experience with refined logs, providing more informative and less cluttered output from the libsignal library.

More features and improvements will be added in the future.

Feature Examples

Here are some examples of features that have been added:

Newsletter Management

<summary style="font-weight: bold; cursor: pointer; padding: 8px; border-bottom: 1px solid #eee; margin-bottom: 5px;">Show Examples</summary>
- To get info newsletter ts const metadata = await sock.newsletterMetadata("invite", "xxxxx") // or const metadata = await sock.newsletterMetadata("jid", "abcd@newsletter") console.log(metadata) - To update the description of a newsletter ts await sock.newsletterUpdateDescription("abcd@newsletter", "New Description") - To update the name of a newsletter ts await sock.newsletterUpdateName("abcd@newsletter", "New Name")
- To update the profile picture of a newsletter ts await sock.newsletterUpdatePicture("abcd@newsletter", buffer) - To remove the profile picture of a newsletter ts await sock.newsletterRemovePicture("abcd@newsletter") - To mute notifications for a newsletter ts await sock.newsletterUnmute("abcd@newsletter") - To mute notifications for a newsletter ts await sock.newsletterMute("abcd@newsletter") - To create a newsletter ts const metadata = await sock.newsletterCreate("Newsletter Name", "Newsletter Description") console.log(metadata) - To delete a newsletter ts await sock.newsletterDelete("abcd@newsletter") - To follow a newsletter ts await sock.newsletterFollow("abcd@newsletter") - To unfollow a newsletter ts await sock.newsletterUnfollow("abcd@newsletter") - To send reaction ts // jid, id message & emoticon // way to get the ID is to copy the message url from channel // Example: [ https://whatsapp.com/channel/xxxxx/175 ] // The last number of the URL is the ID const id = "175" await sock.newsletterReactMessage("abcd@newsletter", id, "🥳")

Button and Interactive Message Management

<summary style="font-weight: bold; cursor: pointer; padding: 8px; border-bottom: 1px solid #eee; margin-bottom: 5px;">Show Examples</summary>
- To send button with text ts const buttons = [ { buttonId: 'id1', buttonText: { displayText: 'Button 1' }, type: 1 }, { buttonId: 'id2', buttonText: { displayText: 'Button 2' }, type: 1 } ] const buttonMessage = { text: "Hi it's button message", footer: 'Hello World', buttons, headerType: 1, viewOnce: true } await sock.sendMessage(id, buttonMessage, { quoted: null }) - To send button with image ts const buttons = [ { buttonId: 'id1', buttonText: { displayText: 'Button 1' }, type: 1 }, { buttonId: 'id2', buttonText: { displayText: 'Button 2' }, type: 1 } ] const buttonMessage = { image: { url: "https://example.com/abcd.jpg" }, // image: buffer or path caption: "Hi it's button message with image", footer: 'Hello World', buttons, headerType: 1, viewOnce: true } await sock.sendMessage(id, buttonMessage, { quoted: null }) - To send button with video ts const buttons = [ { buttonId: 'id1', buttonText: { displayText: 'Button 1' }, type: 1 }, { buttonId: 'id2', buttonText: { displayText: 'Button 2' }, type: 1 } ] const buttonMessage = { video: { url: "https://example.com/abcd.mp4" }, // video: buffer or path caption: "Hi it's button message with video", footer: 'Hello World', buttons, headerType: 1, viewOnce: true } await sock.sendMessage(id, buttonMessage, { quoted: null }) - To send interactive message ts const interactiveButtons = [ { name: "quick_reply", buttonParamsJson: JSON.stringify({ display_text: "Quick Reply", id: "ID" }) }, { name: "cta_url", buttonParamsJson: JSON.stringify({ display_text: "Tap Here!", url: "https://www.example.com/" }) }, { name: "cta_copy", buttonParamsJson: JSON.stringify({ display_text: "Copy Code", id: "12345", copy_code: "12345" }) } ] const interactiveMessage = { text: "Hello World!", title: "this is the title", footer: "this is the footer", interactiveButtons } await sock.sendMessage(id, interactiveMessage, { quoted: null }) - To send interactive message with image ts const interactiveButtons = [ { name: "quick_reply", buttonParamsJson: JSON.stringify({ display_text: "Quick Reply", id: "ID" }) }, { name: "cta_url", buttonParamsJson: JSON.stringify({ display_text: "Tap Here!", url: "https://www.example.com/" }) }, { name: "cta_copy", buttonParamsJson: JSON.stringify({ display_text: "Copy Code", id: "12345", copy_code: "12345" }) } ] const interactiveMessage = { image: { url: "https://example.com/abcd.jpg" }, // image: buffer or path caption: "this is the caption", title: "this is the title", footer: "this is the footer", interactiveButtons } await sock.sendMessage(id, interactiveMessage, { quoted: null }) - To send interactive message with video ts const interactiveButtons = [ { name: "quick_reply", buttonParamsJson: JSON.stringify({ display_text: "Quick Reply", id: "ID" }) }, { name: "cta_url", buttonParamsJson: JSON.stringify({ display_text: "Tap Here!", url: "https://www.example.com/" }) }, { name: "cta_copy", buttonParamsJson: JSON.stringify({ display_text: "Copy Code", id: "12345", copy_code: "12345" }) } ] const interactiveMessage = { video: { url: "https://example.com/abcd.mp4" }, // video: buffer or path caption: "this is the caption", title: "this is the title", footer: "this is the footer", interactiveButtons } await sock.sendMessage(id, interactiveMessage, { quoted: null })

AI Message Icon Customization

<summary style="font-weight: bold; cursor: pointer; padding: 8px; border-bottom: 1px solid #eee; margin-bottom: 5px;">Show Example</summary>
ts // To enable the AI icon for a message, simply add the "ai: true" parameter: await sock.sendMessage(id, { text: "Hello World", ai: true });

Custom Pairing Code Generation

<summary style="font-weight: bold; cursor: pointer; padding: 8px; border-bottom: 1px solid #eee; margin-bottom: 5px;">Show Example</summary>
ts if(usePairingCode && !sock.authState.creds.registered) { const phoneNumber = await question('Please enter your mobile phone number:\n'); // Define your custom 8-digit code (alphanumeric) const customPairingCode = "NSTRCODE"; const code = await sock.requestPairingCode(phoneNumber, customPairingCode); console.log(`Your Pairing Code: ${code?.match(/.{1,4}/g)?.join('-') || code}`); } Note: The question function is a placeholder for your method of obtaining user input.

Reporting Issues

If you encounter any issues while using this repository or any part of it, please feel free to open a new issue here.

Notes

Everything other than the modifications mentioned above remains the same as the original repository. You can check out the original repository at WhiskeySockets