Microsoft Bot Framework v3 Connector for Wechat PERSONAL Account
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
examples
scripts
src
tests/fixtures
.editorconfig
.gitignore
.travis.yml
LICENSE
README.md
azure-pipelines.yml
package.json
tsconfig.json
tslint.json

README.md

BOTBUILDER-WECHATY-CONNECTOR

npm version Powered by Wechaty TypeScript Greenkeeper badge Build Status Build Status

Microsoft Bot Framework v3 connector for Wechat PERSONAL Account

FEATURES

  • Ready for Microsoft Bot Framework v3
  • no need a registered bot on dev.botframework.com, but require a wechat personal(NOT official!) account.
  • Powered by wechaty
  • Support receiving and sending almost any wechat message types(WIP)

TODO

  • Add Room Message Support
  • Add Full Message Types Support(current we only support text messages)

INSTALLATION

npm install botbuilder-wechaty-connector

Preparation

We assume that, you already have a wechat personal account.

Usage

Step 1, create your bot with wechaty connector

import { UniversalBot }     from 'botbuilder'
import { WechatyConnector } from 'botbuilder-wechaty-connector'

const wechatyConnector = new WechatyConnector()
wechatyConnector.listen()

const bot = new UniversalBot(wechatyConnector)

Step 2, add dialogs and you can see message in session object include wechat message content you sent.

bot.dialog('/', function (session) {
  console.log('Wechat message: ', session.message)
})

And, you can find media content like image, voice, video, etc in message.attachments of session object.(Not implement yet)

bot.dialog('/', function (session) {
  console.log('Wechat media: ', session.message.attachments)
});

Step 4, sending message out is the same.

Send text message

bot.dialog('/', function (session) {
  session.send("Im a wechaty bot!");
});

Attachment

To Be Supported.

EXAMPLE

An example is located at examples/ directory. Using following command to run it.

npm run example

THANKS

This package is greatly inspired by:

  1. botbuilder-wechat-connector, so thanks @jyfcrw.
  2. botbuilder-wechat, so thanks @markusf.

ISSUES

Please feel free to open issues, if you have any suggestion.

SEE ALSO

CHANGELOG

v0.2 master (Apr 19, 2018)

  1. Skip messages from other than a personal account(like official account, and SYS message)
  2. Refactoring all the code from ConsoleConnector

v0.0.1 (Apr 17, 2018)

  1. Working with Wechaty Personal Text Messages.
  2. An example run by npm run example

AUTHOR

Huan LI <zixia@zixia.net>

profile for zixia on Stack Exchange, a network of free, community-driven Q&A sites

COPYRIGHT & LICENSE

  • Code & Docs © 2016-2018 Huan LI <zixia@zixia.net>
  • Code released under the Apache-2.0 License
  • Docs released under Creative Commons