supunmd-bail
v2.1.4TypeScript
WhatsApp Web API Library
whatsappbaileyswhatsapp-webwhatsapp-chatwhatsapp-groupwhatsapp-botautomationwhatsapp-apibaileys-modsupun-md
0/weekUpdated 2 weeks agoMITUnpacked: 9.8 MB
Published by Supun Fernando
Baileys Modification - Supun Fernando
📖 Table of Contents
- Important Note
- Install
- Added Features and Improvements
- Feature Examples
- Newsletter Management
- Button and Interactive Message Management
- Send Album Message
- AI Message Icon Customization
- Custom Pairing Code Generation
- Reporting Issues
- Notes
---
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:
``json`
"dependencies": {
"@whiskeysockets/baileys": "npm:supunmd-bail"
}
or install in terminal:
npm install @whiskeysockets/baileys@npm:supunmd-bail
Then import the default function in your code:
`ts `
// type esm
import makeWASocket from '@whiskeysockets/baileys'
`js`
// type cjs
const { default: makeWASocket } = require("@whiskeysockets/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. |
| 🖼️ Send Album Messages | Supports sending multiple images as an album (grouped media message), enabling richer and more organized media sharing. |
| 👥 Group with LID Support | Full support for group using @lid, ensuring compatibility with the latest WhatsApp group addressing format. |
| 🤖 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:
$3
- To get info newsletterShow Examples
`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 newsletterts`
await sock.newsletterUpdateDescription("abcd@newsletter", "New Description")
- To update the name of a newsletterts`
await sock.newsletterUpdateName("abcd@newsletter", "New Name") `
- To update the profile picture of a newsletterts`
await sock.newsletterUpdatePicture("abcd@newsletter", buffer)
- To remove the profile picture of a newsletterts`
await sock.newsletterRemovePicture("abcd@newsletter")
- To mute notifications for a newsletterts`
await sock.newsletterUnmute("abcd@newsletter")
- To mute notifications for a newsletterts`
await sock.newsletterMute("abcd@newsletter")
- To create a newsletterts`
const metadata = await sock.newsletterCreate("Newsletter Name")
console.log(metadata)
- To delete a newsletterts`
await sock.newsletterDelete("abcd@newsletter")
- To follow a newsletterts`
await sock.newsletterFollow("abcd@newsletter")
- To unfollow a newsletterts`
await sock.newsletterUnfollow("abcd@newsletter")
- To send reactionts`
// 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, "🥳")
$3
- To send button with text const buttonMessage = { await sock.sendMessage(id, buttonMessage, { quoted: null }) const buttonMessage = { await sock.sendMessage(id, buttonMessage, { quoted: null }) ` const buttonMessage = { await sock.sendMessage(id, buttonMessage, { quoted: null }) - To send interactive message const interactiveMessage = { await sock.sendMessage(id, interactiveMessage, { quoted: null }) const interactiveMessage = { await sock.sendMessage(id, interactiveMessage, { quoted: null }) const interactiveMessage = { await sock.sendMessage(id, interactiveMessage, { quoted: null }) const interactiveMessage = { await sock.sendMessage(id, interactiveMessage, { quoted: null });Show Examples
`ts
const buttons = [
{ buttonId: 'id1', buttonText: { displayText: 'Button 1' }, type: 1 },
{ buttonId: 'id2', buttonText: { displayText: 'Button 2' }, type: 1 }
]
text: "Hi it's button message",
footer: 'Hello World',
buttons,
headerType: 1
}
`
- To send button with imagets
const buttons = [
{ buttonId: 'id1', buttonText: { displayText: 'Button 1' }, type: 1 },
{ buttonId: 'id2', buttonText: { displayText: 'Button 2' }, type: 1 }
]
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
}
- To send button with videots
const buttons = [
{ buttonId: 'id1', buttonText: { displayText: 'Button 1' }, type: 1 },
{ buttonId: 'id2', buttonText: { displayText: 'Button 2' }, type: 1 }
]
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
}
`
`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"
})
}
]
text: "Hello World!",
title: "this is the title",
footer: "this is the footer",
interactiveButtons
}
`
- To send interactive message with imagets
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"
})
}
]
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
}
`
- To send interactive message with videots
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"
})
}
]
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
}
`
- To send list interactivets
const interactiveButtons = [
{
name: "single_select",
buttonParamsJson: JSON.stringify({
title: "message",
sections: [
{
title: "title",
highlight_label: "label",
rows: [
{
header: "HEADER",
title: "TITLE",
description: "DESCRIPTION",
id: "YOUR ID"
},
{
header: "HEADER",
title: "TITLE",
description: "DESCRIPTION",
id: "YOUR ID"
}
]
}
]
})
}
];
text: "Hello World!",
title: "this is the title",
footer: "this is the footer",
interactiveButtons
};
`
$3
` await sock.sendMessage(id, { album: media, caption: "testing send album" }, { quoted: null })Show Example
ts
// Media can be a URL, buffer, or path.
const media = [
{
image: { url: "https://example.com/image.jpg" }
},
{
image: await getBuffer("https://example.com/image.jpg")
},
{
video: { url: "https://example.com/video.mp4" }
}
]
`
$3
`Show Example
ts`
// To enable the AI icon for a message, simply add the "ai: true" parameter:
await sock.sendMessage(id, { text: "Hello World", ai: true });
$3
`Show Example
tsYour Pairing Code: ${code?match(/.{1,4}/g)?.join('-') || code}
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 = "ABCD1234";
const code = await sock.requestPairingCode(phoneNumber, customPairingCode);
console.log();`
}
Note: The
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
Package Sidebar