botbuilder-wechaty-connector

BOTBUILDER-WECHATY-CONNECTOR

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 certified wechat office account, go to apply trial account
• depend on wechaty
• support receiving and sending almost any wechat message types
• for express framework

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

var builder   = require('botbuilder'),
    connector = require('botbuilder-wechaty-connector')
    
var wechatyConnector = new connector.WechatyConnector()

var bot = new builder.UniversalBot(wechatyConnector)

Step 2, create express app as usual and use wechat connector as middleware

var app    = express()
app.use('/bot/wechaty', wechatyConnector.listen())
app.listen(9090)

when you configure your wechaty message service, you have to offer an available public url, if can not, try ngrok. When submit this url in wechat backend, wechat server will send request to this url, so, ensure you server running good before submiting.

Step 3, 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.

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 wechat 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. botbuild-wechat-connector, so thanks @jyfcrw.
2. botbuilder-wechat, so thanks @markusf.

ISSUES

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

AUTHOR

Huan LI <[e-mail]>

COPYRIGHT & LICENSE

• Code & Docs © 2016-2018 Huan LI <[e-mail]>
• Code released under the Apache-2.0 License
• Docs released under Creative Commons