Venom WhatsApp Automation Framework

Use venom.create() to start a WhatsApp session. By default, it uses multidevice: true. If you need to use a non-multidevice version, set multidevice: false in the options.

Venom creates an instance of WhatsApp Web. If you are not logged in, a QR code will be printed in the terminal for you to scan with your phone. Sessions are remembered, so you won't need to authenticate every time.

You can run multiple sessions simultaneously by providing unique session names.

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

venom
  .create({
    session: 'session-name', // name of session
    multidevice: false // for version not multidevice use false (default: true)
  })
  .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); // returns success object
        })
        .catch((erro) => {
          console.error('Error when sending: ', erro);
        });
    }
  });
}

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

venom
  .create({
    session: 'session-name', //name of session
    multidevice: false // for version not multidevice use false.(default: true)
  })
  .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
        });
    }
  });
}

By default, the QR code is displayed in the terminal. To capture the QR code and save it as an image file (e.g., out.png), use the venom.create callback function. You can parse the base64Qr string to extract the image data and write it to the file system using fs.writeFile.

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

venom
  .create(
    'sessionName',
    (base64Qr, asciiQR, attempts, urlCode) => {
      console.log(asciiQR); // Optional 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);
  });

The create() function accepts an options object to control the browser, session, logging, and connection settings.

Key Configuration Groups:

• Browser: headless, devtools, browserWS, browserPathExecutable, puppeteerOptions, browserArgs, addBrowserArgs.
• Session: folderNameToken, mkdirFolderToken, createPathFileToken.
• Logging: debug, logQR, updatesLog, disableSpins, disableWelcome.
• Connection: autoClose, addProxy, userProxy, userPass.

You can also provide a browserInstance callback to access the Puppeteer browser and page objects directly.

create({
  session: 'production',

  catchQR: (base64Qr, asciiQR, attempts, urlCode) => {
    console.log(`Scan attempt ${attempts}`);
  },

  statusFind: (status, session) => {
    console.log(`[${session}] Status: ${status}`);
  },

  options: {
    // Browser
    headless: 'new',
    devtools: false,
    browserWS: '',
    browserPathExecutable: '',
    puppeteerOptions: {},
    browserArgs: [''],
    addBrowserArgs: [''],

    // Session
    folderNameToken: 'tokens',
    mkdirFolderToken: '',
    createPathFileToken: false,

    // Logging
    debug: false,
    logQR: true,
    updatesLog: true,
    disableSpins: false,
    disableWelcome: false,

    // Connection
    autoClose: 60000,
    addProxy: [''],
    userProxy: '',
    userPass: ''
  },

  browserInstance: (browser, waPage) => {
    console.log('Browser PID:', browser.process().pid);
  }
});

The venom.create() method accepts several optional parameters to customize the session behavior.

Note for Linux users: You must pass the --user-agent argument within browserArgs if running on a Linux server.

Common Configuration Options

Callback Signatures

venom.create supports the following callback arguments:

1. catchQR: (base64Qrimg, asciiQR, attempts, urlCode) => void
2. statusFind: (statusSession, session) => void
3. BrowserSessionToken: An object containing WABrowserId, WASecretBundle, WAToken1, and WAToken2 to manually restore a session.
4. BrowserInstance: (browser, waPage) => void (provides access to the Puppeteer browser and page).

venom
  .create(
    'sessionName',
    (base64Qrimg, asciiQR, attempts, urlCode) => {
      console.log('Number of attempts to read the qrcode: ', attempts);
      console.log('Terminal qrcode: ', asciiQR);
      console.log('base64 image string qrcode: ', base64Qrimg);
      console.log('urlCode (data-ref): ', urlCode);
    },
    (statusSession, session) => {
      console.log('Status Session: ', statusSession);
      console.log('Session name: ', session);
    },
    {
      multidevice: false,
      folderNameToken: 'tokens',
      headless: true,
      logQR: true,
      autoClose: 60000,
    },
    {
      WABrowserId: '"UnXjH....."',
      WASecretBundle: '{"key":"+i/nRgW...."}',
      WAToken1: '"0i8...."',
      WAToken2: '"1@lPpzwC...."'
    },
    (browser, waPage) => {
      console.log('Browser PID:', browser.process().pid);
      waPage.screenshot({ path: 'screenshot.png' });
    }
  )
  .then((client) => {
    start(client);
  });

To save the QR code as an image file instead of just displaying it in the terminal, use the catchQR callback (the second argument to create) to process the base64Qr string and save it using fs.

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

venom
  .create(
    'sessionName',
    (base64Qr, asciiQR) => {
      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;
      fs.writeFile(
        'out.png',
        imageBuffer['data'],
        'binary',
        function (err) {
          if (err != null) {
            console.log(err);
          }
        }
      );
    },
    undefined,
    { logQR: false }
  )
  .then((client) => start(client));