Skip to main content

Contact Bot

Powered by Wechaty JavaScript

Wechaty Contact bot helps to list all contacts by WeChat ID & name.

In this tutorial, you will get step-by-step instructions for building the Wechaty Contact bot from scratch.

Try out the bot​

Edit wechaty-contact-bot

You can try out the Wechaty Contact bot using this interactive CodeSandbox.

Just scan the generated QR code with WeChat app, and you are ready to play with the bot!

Requirements​

  1. Node.js v16+
  2. Wechaty v0.40+

Getting started​

You should have Node.js installed on your system. If you do not have Node.js installed (or have a version below 12), then you need to install the latest version of Node.js by following the links below:

Node.js installation docs

Installation guide for Node.js on other platforms can be found here.

You can head over to the Building the bot section to learn how to build the bot on your own.

Otherwise, if you just want to try out the bot on your local system, follow the steps below:

1. Clone the repository​

Use the following commands to clone the GitHub repository and navigate to the directory:

git clone https://github.com/wechaty/wechaty-getting-started.git
cd wechaty-getting-started

2. Install dependencies​

You can install the npm packages required for running the bot, using this command:

npm install

3. Run the bot​

You have to export/set the environment variables:

export WECHATY_LOG=verbose
export WECHATY_PUPPET=wechaty-puppet-wechat

There are various Wechaty puppets available, you can know more about them here.

Run the bot by using the following command:

node examples/basic/contact-bot.js

It will generate a QR code, scan it using WeChat or WhatsApp (according to the puppet you have used), and you are ready to play with the bot.

Building the bot​

Let's get started with building the Wechaty Contact bot using Wechaty.

1. Initialize project​

Create a new folder called contact-bot and move into that directory:

mkdir contact-bot
cd contact-bot

Use the following command to initialize an npm project:

npm init -y

This will generate the package.json file containing these:

{
  "name": "contact-bot",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

2. Install dependencies​

You will need the wechaty NPM package for building this bot & qrcode-terminal for displaying the QR code that can be scanned for using the bot. Install them using the following command:

npm install wechaty
npm install qrcode-terminal

You will also need to add dependencies for using any Wechaty Puppet which helps to integrate Wechaty with various instant messaging (IM) systems (such as WeChat, WhatsApp, and WeCom):

  1. If you want to use WhatsApp, install wechaty-puppet-whatsapp:

    npm install wechaty-puppet-whatsapp

  2. If you want to use WeChat, you can try the following puppets:

    • Web Protocol: Install wechaty-puppet-wechat:

      npm install wechaty-puppet-wechat

    • iPad Protocol:

      • padlocal: Install wechaty-puppet-padlocal:

        npm install wechaty-puppet-padlocal

        Then get a token like puppet_padlocal_XXX, know more about puppet service padlocal here.

      • paimon: Install wechaty-puppet-service:

        npm install wechaty-puppet-service

        Then get a token like puppet_paimon_XXX, know more about puppet service paimon here.

  3. If you want to use WeCom, install wechaty-puppet-service:

    npm install wechaty-puppet-service

    Then get a token like puppet_wxwork_XXXXX, more about puppet service wxwork here.

You can find more information about the puppets here.

3. Write code for bot​

Start by creating a new folder called src, and add a file contact-bot.js. We will be writing the code here.

Let's import the required packages in the JavaScript file:

import qrTerm  from 'qrcode-terminal';
import { Contact, log, Wechaty }  from 'wechaty';

Specify some functions that you will require for handling different events returned by the Wechaty bot.

  • onScan

    This function will be used for generating the QR code for the puppet specified, and display it on the console.

    function onScan (qrcode, status) {
      qrTerm.generate(qrcode, { small: true })
    }

  • onLogin

    This will print a log message when an user logs in to the bot, and will call the main() function.

    function onLogin (user) {
      console.log(`${user} login`)
      main()
    }

    We'll look into the content of this main() function in a moment.

  • onLogout

    This will print a log message when an user logs out of the bot.

    function onLogout (user) {
      console.log(`${user} logout`)
    }

  • onError

    This is for printing an error message to the console.

    function onError (e) {
      console.error(e)
    }

You have completed defining all the functions required for handling various bot events. Now, provide a name to initialize the Wechaty bot:

const bot = new Wechaty({
    name: "contact-bot",
})

Assign proper function to call when an event is triggered by the bot:

bot.on('scan',    onScan)
bot.on('login',   onLogin)
bot.on('logout',  onLogout)
bot.on('error',   onError)

Use the following to start the bot:

bot.start()
  .catch(console.error)

Add the following to the main() function for printing the official and personal contacts list to the console:

async function main() {
  const contactList = await bot.Contact.findAll();

  log.info("Bot", "#######################");
  log.info("Bot", "Contact number: %d\n", contactList.length);

  /**
   * official contacts list
   */
  for (let i = 0; i < contactList.length; i++) {
    const contact = contactList[i];
    if (contact.type() === Contact.Type.Official) {
      log.info("Bot", `official ${i}: ${contact}`);
    }
  }

  /**
   *  personal contacts list
   */
  for (let i = 0; i < contactList.length; i++) {
    const contact = contactList[i];
    if (contact.type() === Contact.Type.Personal) {
      log.info("Bot", `personal ${i}: ${contact.name()} : ${contact.id}`);
    }
  }

  const SLEEP = 7;
  log.info(
    "Bot",
    "I will re-dump contact weixin id & names after %d second... ",
    SLEEP
  );
  setTimeout(main, SLEEP * 1000);
}

Running the bot​

In order to run the bot, first you have to export/set an environment variable with the type of puppet to use:

export WECHATY_LOG=verbose
export WECHATY_PUPPET=wechaty-puppet-wechat

# For using WhatsApp:
# export WECHATY_PUPPET=wechaty-puppet-whatsapp

# For using WeCom:
# export WECHATY_PUPPET=wechaty-puppet-service
# export WECHATY_PUPPET_SERVICE_TOKEN="puppet_wxwork_XXXXX"

If you are using WeCom, you can get token from puppet service wxwork.

Run the bot using the following command:

node src/contact-bot.js

This will start the bot and generate a QR code.

Scan it using your WeChat/WhatsApp as per the puppet you have selected, and you are ready to play with the bot!

References​