README

Chatopera Home　|　Chatopera Docs　|　Wechaty Docs　|　Help

WECHATY-CHATOPERA

INTRODUCTION

Bring your bots into Wechat with Wechaty Chatopera Plugin.

REQUIREMENTS

Node.js v16+
NPM v7+
Wechaty v0.68+
Chatopera Plugin

USAGE

To use the plugin:

import { WechatyChatopera } from 'wechaty-chatopera'

const config = {
  /**
   * Chatopera Service ID
   */
  clientId: 'YOUR_CLIENTID',
  secret: 'YOUR_SECRET',
  personalAccessToken: 'YOUR_PERSONAL_ACCESS_TOKEN',
  faqBestReplyThreshold: 0.8,
  faqSuggReplyThreshold: 0.2
  repoConfig: {}
}

const ChatoperaPlugin = WechatyChatopera(config)

const wechaty = new Wechaty()
wechaty.use(ChatoperaPlugin)

In config, either {personalAccessToken, repoConfig} or {clientId, secret} must be present.

Chatopera BOT of clientId would response as the global bot for all groups and private chats.

When personalAccessToken and repoConfig are added, the rooms defined by repoConfig would response with the bot that mapping with names. Check out apache.ts and asker.ts to learn the repoConfig schema. Rooms are not belong to any repo, it would route to clientId BOT.

If both personalAccessToken and clientId are not present, Wechaty Chatopera Plugin would throw an error.