minichiello / venom

Venom is a high-performance system developed with JavaScript to create a bot for WhatsApp

🕷Venom Bot🕸

Venom is a high-performance system developed with JavaScript to create a bot for WhatsApp, support for creating any interaction, such as customer service, media sending, sentence recognition based on artificial intelligence and all types of design architecture for WhatsApp.

🕷🕷 Functions Venom🕷🕷

Automatic QR Refresh	✔
Send text, image, video, audio and docs	✔
Get contacts, chats, groups, group members, Block List	✔
Send contacts	✔
Send stickers	✔
Send stickers GIF	✔
Multiple Sessions	✔
Forward Messages	✔
Receive message	✔
📍 Send location!!	✔
🕸🕸 and much more	✔

Installation

> npm i --save venom-bot

Getting started

// Supports ES6
// import { create, Whatsapp } from 'venom-bot';
const venom = require('venom-bot');

venom
  .create()
  .then((client) => start(client))
  .catch((erro) => {
    console.log(erro);
  });

function start(client) {
  client.onMessage((message) => {
    if (message.body === 'Hi' && message.isGroupMsg === false) {
      client
        .sendText(message.from, 'Welcome Venom 🕷')
        .then((result) => {
          console.log('Result: ', result); //return object success
        })
        .catch((erro) => {
          console.error('Error when sending: ', erro); //return object error
        });
    }
  });
}

After executing create() function, venom will create an instance of whatsapp web. If you are not logged in, it will print a QR code in the terminal. Scan it with your phone and you are ready to go!

Venom will remember the session so there is no need to authenticate everytime.

Multiples sessions can be created at the same time by pasing a session name to create() function:

// Init sales whatsapp bot
venom.create('sales').then((salesClient) => {...});

// Init support whatsapp bot
venom.create('support').then((supportClient) => {...});

Optional create parameters

Venom create() method third parameter can have the following optional parameters:

const venom = require('venom-bot');

venom
  .create(
    'sessionName',
    (base64Qrimg, asciiQR) => {
      console.log('Terminal qrcode: ', asciiQR);
      console.log('base64 image string qrcode: ', base64Qrimg);
    },
    (statusSession) => {
      console.log('Status Session: ', statusSession); //return isLogged || notLogged || browserClose || qrReadSuccess || qrReadFail || autocloseCalled
    },
    {
      folderNameToken: 'tokens', //folder name when saving tokens
      mkdirFolderToken: '', //folder directory tokens, just inside the venom folder, example:  { mkdirFolderToken: '/node_modules', } //will save the tokens folder in the node_modules directory
      headless: true, // Headless chrome
      devtools: false, // Open devtools by default
      useChrome: true, // If false will use Chromium instance
      debug: false, // Opens a debug session
      logQR: true, // Logs QR automatically in terminal
      browserArgs: [''], // Parameters to be added into the chrome browser instance
      disableSpins: true, // Will disable Spinnies animation, useful for containers (docker) for a better log
      disableWelcome: true, // Will disable the welcoming message which appears in the beginning
      updates: true, // Logs info updates automatically in terminal
      autoClose: 60000, // Automatically closes the venom-bot only when scanning the QR code (default 60 seconds, if you want to turn it off, assign 0 or false)
    }
  )
  .then((client) => {
    start(client);
  })
  .catch((erro) => {
    console.log(erro);
  });

Callback Status Session

Gets the return if the session is isLogged or notLogged or browserClose or qrReadSuccess or qrReadFail or autocloseCalled

isLogged: When the user is already logged in to the browser.

notLogged: When the user is not connected to the browser, it is necessary to scan the QR code through the cell phone in the option WharsApp Web.

browserClose: If the browser is closed this parameter and returned.

qrReadSuccess: if the user is not logged in, the QR code is passed on the terminal a callback is returned. After the correct reading by cell phone this parameter is returned.

qrReadFail: If the browser stops when the QR code scan is in progress, this parameter is returned.

autocloseCalled: The browser was closed using the autoClose command.

const venom = require('venom-bot');
venom
  .create(
    'sessionName',
    undefined,
    (statusSession) => {
      console.log('Status Session: ', statusSession);
      //return isLogged || notLogged || browserClose || qrReadSuccess || qrReadFail || autocloseCalled
    },
    undefined
  )
  .then((client) => {
    start(client);
  })
  .catch((erro) => {
    console.log(erro);
  });

Exporting QR Code

By default QR code will appear on the terminal. If you need to pass the QR somewhere else heres how:

const fs = require('fs');
const venom = require('venom-bot');

venom
  .create(
    'sessionName',
    (base64Qr, asciiQR) => {
      console.log(asciiQR); // Opcional to log the QR in the terminal
      var matches = base64Qr.match(/^data:([A-Za-z-+\/]+);base64,(.+)$/),
        response = {};

      if (matches.length !== 3) {
        return new Error('Invalid input string');
      }
      response.type = matches[1];
      response.data = new Buffer.from(matches[2], 'base64');

      var imageBuffer = response;
      require('fs').writeFile(
        'out.png',
        imageBuffer['data'],
        'binary',
        function (err) {
          if (err != null) {
            console.log(err);
          }
        }
      );
    },
    undefined,
    { logQR: false }
  )
  .then((client) => {
    start(client);
  })
  .catch((erro) => {
    console.log(erro);
  });

Downloading Files

Puppeteer takes care of the file downloading. The decryption is being done as fast as possible (outruns native methods). Supports big files!

import fs = require('fs');
import mime = require('mime-types');

client.onMessage( async (message) => {
  if (message.isMedia === true || message.isMMS === true) {
    const buffer = await client.decryptFile(message);
    // At this point you can do whatever you want with the buffer
    // Most likely you want to write it into a file
    const fileName = `some-file-name.${mime.extension(message.mimetype)}`;
    await fs.writeFile(fileName, buffer, (err) => {
      ...
    });
  }
});

Basic Functions (usage)

Not every available function is listed, for further look, every function available can be found in here and here

Chatting

Here, chatId could be <phoneNumber>@c.us or <phoneNumber>-<groupId>@g.us

// Send contact
await client
  .sendContactVcard('[e-mail]', '[e-mail]', 'Name of contact')
  .then((result) => {
    console.log('Result: ', result); //return object success
  })
  .catch((erro) => {
    console.error('Error when sending: ', erro); //return object error
  });

// Send a list of contact cards
await client
  .sendContactVcardList('[e-mail]', [
    '[e-mail]',
    '[e-mail]',
  ])
  .then((result) => {
    console.log('Result: ', result); //return object success
  })
  .catch((erro) => {
    console.error('Error when sending: ', erro); //return object error
  });

// Send basic text
await client
  .sendText('[e-mail]', '👋 Hello from venom!')
  .then((result) => {
    console.log('Result: ', result); //return object success
  })
  .catch((erro) => {
    console.error('Error when sending: ', erro); //return object error
  });

// Send location
await client
  .sendLocation('[e-mail]', '-13.6561589', '-69.7309264', 'Brasil')
  .then((result) => {
    console.log('Result: ', result); //return object success
  })
  .catch((erro) => {
    console.error('Error when sending: ', erro); //return object error
  });

//Automatically sends a link with the auto generated link preview. You can also add a custom message to be added.
await client
  .sendLinkPreview(
    '[e-mail]',
    'https://www.youtube.com/watch?v=V1bFr2SWP1I',
    'Kamakawiwo ole'
  )
  .then((result) => {
    console.log('Result: ', result); //return object success
  })
  .catch((erro) => {
    console.error('Error when sending: ', erro); //return object error
  });

// Send image (you can also upload an image using a valid HTTP protocol)
await client
  .sendImage(
    '[e-mail]',
    'path/to/img.jpg',
    'image-name',
    'Caption text'
  )
  .then((result) => {
    console.log('Result: ', result); //return object success
  })
  .catch((erro) => {
    console.error('Error when sending: ', erro); //return object error
  });

// Send file (venom will take care of mime types, just need the path)
//you can also upload an image using a valid HTTP protocol
await client
  .sendFile(
    '[e-mail]',
    'path/to/file.pdf',
    'file_name',
    'See my file in pdf'
  )
  .then((result) => {
    console.log('Result: ', result); //return object success
  })
  .catch((erro) => {
    console.error('Error when sending: ', erro); //return object error
  });

//Sends file
// base64 parameter should have mime type already defined
await client
  .sendFileFromBase64(
    '[e-mail]',
    base64PDF,
    'file_name.pdf',
    'See my file in pdf'
  )
  .then((result) => {
    console.log('Result: ', result); //return object success
  })
  .catch((erro) => {
    console.error('Error when sending: ', erro); //return object error
  });

//Generates sticker from the provided animated gif image and sends it (Send image as animated sticker)
//image path imageBase64 A valid gif image is required. You can also send via http/https (http://www.website.com/img.gif)
await client
  .sendImageAsStickerGif('[e-mail]', './image.gif')
  .then((result) => {
    console.log('Result: ', result); //return object success
  })
  .catch((erro) => {
    console.error('Error when sending: ', erro); //return object error
  });

//Generates sticker from given image and sends it (Send Image As Sticker)
// image path imageBase64 A valid png, jpg and webp image is required. You can also send via http/https (http://www.website.com/img.jpg)
await client
  .sendImageAsSticker('[e-mail]', './image.jpg')
  .then((result) => {
    console.log('Result: ', result); //return object success
  })
  .catch((erro) => {
    console.error('Error when sending: ', erro); //return object error
  });

// Send @tagged message
await client.sendMentioned(
  '[e-mail]',
  'Hello @5218113130740 and @5218243160777!',
  ['5218113130740', '5218243160777']
);

// Reply to a message
await client.reply(
  '[e-mail]',
  'This is a reply!',
  message.id.toString()
);

// Reply to a message with mention
await client.reply(
  '[e-mail]',
  'Hello @5218113130740 and @5218243160777! This is a reply with mention!',
  message.id.toString(),
  ['5218113130740', '5218243160777']
);

// Send gif
await client.sendVideoAsGif(
  '[e-mail]',
  'path/to/video.mp4',
  'video.gif',
  'Gif image file'
);

// Forwards messages
await client.forwardMessages(
  '[e-mail]',
  [message.id.toString()],
  true
);

// Send seen ✔️✔️
await client.sendSeen('[e-mail]');

// Start typing...
await client.startTyping('[e-mail]');

// Stop typing
await client.stopTyping('[e-mail]');

// Set chat state (0: Typing, 1: Recording, 2: Paused)
await client.setChatState('[e-mail]', 0 | 1 | 2);

Retrieving Data

// Calls your list of blocked contacts (returns an array)
const getBlockList = await client.getBlockList();

// Retrieve contacts
const contacts = await client.getAllContacts();

// Retrieve messages in chat
const Messages = await client.getAllMessagesInChat('[e-mail]');

// Retrieve more chat message
const moreMessages = await client.loadEarlierMessages('[e-mail]');

// Retrieve all messages in chat
const allMessages = await client.loadAndGetAllMessagesInChat(
  '[e-mail]'
);

// Retrieve contact status
const status = await client.getStatus('[e-mail]');

// Retrieve user profile
const user = await client.getNumberProfile('[e-mail]');

// Retrieve all unread message
const messages = await client.getAllUnreadMessages();

// Retrieve all chats
const chats = await client.getAllChats();

// Retrieve all groups
const chats = await client.getAllGroups();

// Retrieve profile fic (as url)
const url = await client.getProfilePicFromServer('[e-mail]');

// Retrieve chat/conversation
const chat = await client.getChat('[e-mail]');

// Check if the number exists
const chat = await client.checkNumberStatus('[e-mail]');

Group Functions

// groupId or chatId: leaveGroup [e-mail]

// Leave group
await client.leaveGroup('[e-mail]');

// Get group members
await client.getGroupMembers('[e-mail]');

// Get group members ids
await client.getGroupMembersIds('[e-mail]');

// Generate group invite url link
await client.getGroupInviteLink('[e-mail]');

// Create group (title, participants to add)
await client.createGroup('Group name', [
  '[e-mail]',
  '[e-mail]',
]);

// Remove participant
await client.removeParticipant('[e-mail]', '[e-mail]');

// Add participant
await client.addParticipant('[e-mail]', '[e-mail]');

// Promote participant (Give admin privileges)
await client.promoteParticipant('[e-mail]', '[e-mail]');

// Demote particiapnt (Revoke admin privileges)
await client.demoteParticipant('[e-mail]', '[e-mail]');

// Get group admins
await client.getGroupAdmins('[e-mail]');

// Return the group status, jid, description from it's invite link
await client.getGroupInfoFromInviteLink(InviteCode);

// Join a group using the group invite code
await client.joinGroup(InviteCode);

Profile Functions

// Set client status
await client.setProfileStatus('On vacations! ✈️');

// Set client profile name
await client.setProfileName('Venom bot');

// Set client profile photo
await client.setProfilePic('path/to/image.jpg');

Device Functions

//Delete the Service Worker
await client.killServiceWorker();

//Load the service again
await client.restartService();

// Get device info
await client.getHostDevice();

// Get connection state
await client.getConnectionState();

// Get battery level
await client.getBatteryLevel();

// Is connected
await client.isConnected();

// Get whatsapp web version
await client.getWAVersion();

Events

// Listen to messages
client.onMessage(message => {
  ...
})

// Listen to state changes
client.onStateChange(state => {
  ...
});

// Listen to ack's
client.onAck(ack => {
  ...
});

// Listen to live location
// chatId: '[e-mail]'
client.onLiveLocation("[e-mail]", (liveLocation) => {
  ...
});

// chatId looks like this: '[e-mail]'
// Event interface is in here: https://github.com/s2click/venom/blob/master/src/api/model/participant-event.ts
client.onParticipantsChanged("[e-mail]", (event) => {
  ...
});

// Listen when client has been added to a group
client.onAddedToGroup(chatEvent => {
  ...
});

Other

// Pin chat and Unpin chat messages with true or false
// Pin chat, non-existent (optional)
await client
  .pinChat(chatId, true, false)
  .then((result) => {
    console.log('Result: ', result); //return object success
  })
  .catch((erro) => {
    console.error('Error when sending: ', erro); //return object error
  });

//Change the theme
//string types "dark" or "light"
await client.setTheme('dark');

//Receive the current theme
//returns string light or dark
await client.getTheme();

// Delete chat
await client.deleteChat('[e-mail]');

// Clear chat messages
await client.clearChat('[e-mail]');

// Archive and unarchive chat messages with true or false
await client.archiveChat(chatId, true);

// Delete message (last parameter: delete only locally)
await client.deleteMessage('[e-mail]', message.id.toString(), false);

// Mark chat as not seen (returns true if it works)
await client.markUnseenMessage('[e-mail]');

//blocks a user (returns true if it works)
await client.blockContact('[e-mail]');

//unlocks contacts (returns true if it works)
await client.unblockContact('[e-mail]');

// Retrieve a number profile / check if contact is a valid whatsapp number
const profile = await client.getNumberProfile('[e-mail]');

Misc

There are some tricks for a better usage of venom.

Keep session alive:

// In case of being logged out of whatsapp web
// Force it to keep the current session
// State change
// Detect a logout
client.onStateChange((state) => {
  console.log('State changed: ', state);
  const conflits = [
    venom.SocketState.CONFLICT,
    venom.SocketState.UNPAIRED,
    venom.SocketState.UNLAUNCHED,
  ];
  if (conflits.includes(state)) {
    client.useHere();
    // Detect a logout
    if (state === 'UNPAIRED') console.log('Client logout!');
  }
});

Multiple sessions

If you need to run multiple sessions at once just pass a session name to create() method, not use hyphen for name of sessions.

async () => {
  const marketingClient = await venom.create('marketing');
  const salesClient = await venom.create('sales');
  const supportClient = await venom.create('support');
};

Closing (saving) sessions

Close the session properly to ensure the session is saved for the next time you log in (So it wont ask for QR scan again). So instead of CTRL+C,

// Catch ctrl+C
process.on('SIGINT', function() {
  client.close();
});

// Try-catch close
try {
   ...
} catch (error) {
   client.close();
}

Auto closing unsynced sessions

The auto close is enabled by default and the timeout is setted to 60 sec. Receives the time in milliseconds to countdown until paired.

Use "autoClose: 0 | false" to disable auto closing.

Debugging

Development

Building venom is really simple altough it contians 3 main projects inside

1. Wapi project

> npm run build:wapi

2. Middleeware

> npm run build:middleware
> npm run build:jsQR

3. Venom

> npm run build:venom

To build the entire project just run

> npm run build

Maintainers

Maintainers are needed, I cannot keep with all the updates by myself. If you are interested please open a Pull Request.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.