Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mimamch/wa-multi-session
Multiple Session Whatsapp Socket Javascript Library
https://github.com/mimamch/wa-multi-session
baileys chat js-library js-package messaging npmjs wa-gateway whatapp whatsapp whatsapp-api whatsapp-chat whatsapp-js whatsapp-web
Last synced: about 1 month ago
JSON representation
Multiple Session Whatsapp Socket Javascript Library
- Host: GitHub
- URL: https://github.com/mimamch/wa-multi-session
- Owner: mimamch
- License: mit
- Created: 2023-03-07T08:53:49.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-26T02:59:44.000Z (9 months ago)
- Last Synced: 2024-04-27T05:22:26.177Z (7 months ago)
- Topics: baileys, chat, js-library, js-package, messaging, npmjs, wa-gateway, whatapp, whatsapp, whatsapp-api, whatsapp-chat, whatsapp-js, whatsapp-web
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/wa-multi-session
- Size: 101 KB
- Stars: 92
- Watchers: 7
- Forks: 30
- Open Issues: 15
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Whatsapp Multi Session - Connecting More Whatsapp Session in 1 App
Connecting Your app with Whatsapp Messaging
Lightweight library for whatsapp. Not require Selenium or any other browser.
Stand above [Baileys](https://github.com/WhiskeySockets/Baileys) Library.
## Installation
Install package using npm
```
npm install wa-multi-session@latest
```
Then import your code
Using JS Module
```ts
import * as whatsapp from "wa-multi-session";
```
or using CommonJS
```ts
const whatsapp = require("wa-multi-session");
```
## Session Usage/Examples
Start New Session
```ts
// create session with ID : mysessionid
const session = await whatsapp.startSession("mysessionid");
// Then, scan QR on terminal
```
Get All Session ID
```ts
const sessions = whatsapp.getAllSession();
// returning all session ID that has been created
```
Get Session Data By ID
```ts
const session = whatsapp.getSession("mysessionid");
// returning session data
```
Load Session From Storage / Load Saved Session
```ts
whatsapp.loadSessionsFromStorage();
// Start saved session without scan again
```
## Messaging Usage/Examples
Send Text Message
```ts
await whatsapp.sendTextMessage({
sessionId: "mysessionid", // session ID
to: "6281234567890", // always add country code (ex: 62)
text: "Hi There, This is Message from Server!", // message you want to send
});
```
Send Image
```ts
const image = fs.readFileSync("./myimage.png"); // return Buffer
const send = await whatsapp.sendImage({
sessionId: "session1",
to: "6281234567890",
text: "My Image Caption",
media: image, // can from URL too
});
```
Send Video
```ts
const video = fs.readFileSync("./myvideo.mp4"); // return Buffer
const send = await whatsapp.sendVideo({
sessionId: "session1",
to: "6281234567890",
text: "My Video Caption",
media: video, // can from URL too
});
```
Send Document File
```ts
const filename = "mydocument.docx";
const document = fs.readFileSync(filename); // return Buffer
const send = await whatsapp.sendDocument({
sessionId: "session1",
to: "6281234567890",
filename: filename,
media: document,
text: "Hei, Check this Document",
});
```
Send Voice Note
```ts
const filename = "myaudio.mp3";
const audio = fs.readFileSync(filename); // return Buffer
const send = await whatsapp.sendVoiceNote({
sessionId: "session1",
to: "6281234567890",
media: audio,
});
```
Read a Message
```ts
await whatsapp.readMessage({
sessionId: "session1",
key: msg.key,
});
```
Send Typing Effect
```ts
await whatsapp.sendTyping({
sessionId: "session1",
to: "6281234567890",
duration: 3000,
});
```
## Listener Usage/Examples
Add Listener/Callback When Receive a Message
```ts
whatsapp.onMessageReceived((msg) => {
console.log(`New Message Received On Session: ${msg.sessionId} >>>`, msg);
});
```
Add Listener/Callback When QR Printed
```ts
whatsapp.onQRUpdated(({ sessionId, qr }) => {
console.log(qr);
});
```
Add Listener/Callback When Session Connected
```ts
whatsapp.onConnected((sessionId) => {
console.log("session connected :" + sessionId);
});
```
## Handling Incoming Message Examples
```ts
whatsapp.onMessageReceived(async (msg) => {
if (msg.key.fromMe || msg.key.remoteJid.includes("status")) return;
await whatsapp.readMessage({
sessionId: msg.sessionId,
key: msg.key,
});
await whatsapp.sendTyping({
sessionId: msg.sessionId,
to: msg.key.remoteJid,
duration: 3000,
});
await whatsapp.sendTextMessage({
sessionId: msg.sessionId,
to: msg.key.remoteJid,
text: "Hello!",
answering: msg, // for quoting message
});
});
```
## Save Media Message (Image, Video, Document)
```ts
wa.onMessageReceived(async (msg) => {
if (msg.message?.imageMessage) {
// save image
msg.saveImage("./myimage.jpg");
}
if (msg.message?.videoMessage) {
// save video
msg.saveVideo("./myvideo.mp4");
}
if (msg.message?.documentMessage) {
// save document
msg.saveDocument("./mydocument"); // without extension
}
});
```
## Optional Configuration Usage/Examples
Set custom credentials directory
```ts
// default dir is "wa_credentials"
whatsapp.setCredentialsDir("my_custom_dir");
// or : credentials/mycreds
```
## Change Log
### v3.3 September 2023 (LATEST)
What's New:
- Send Voice Note
- Send Sticker
- onMessageUpdate (message ack status)
### v3.2.1 July 2023
- Add error class named: WhatsappError
### v3.1.2 July 2023
- Add send document message
### v3.0.0 June 2023
- Fix Logout Issue
- Switching into [@whiskeysockets/baileys](https://github.com/WhiskeySockets/Baileys)
## Authors
- [@mimamch](https://www.github.com/mimamch)
## Feedback or Support
If you have any feedback or support, please reach out to me at [email protected]