Connecting ChatBots.
Wechaty is a Bot Framework for Wechat Personal Account.
Easy creating personal wechat bot in 9 lines of code.
It supports linux, win32 and darwin(OSX/Mac).
@GasLin : it may be the best wecaht sdk i have seen in github! link
@ak5 : Thanks for this it's quite cool! link
Wechaty is dead easy to use: 9 lines javascript for your 1st wechat bot.
The following 9 lines of code implement a bot log all message to console:
const Wechaty = require('wechaty')
const bot = new Wechaty()
bot.on('scan', ({url, code}) => {
console.log(`Use Wechat to scan QrCode in url to login: ${code}\n${url}`)
}).on('login', user => {
console.log(`user ${user} logined`)
}).on('message', m => {
console.log(`Message: ${m}`)
}).init()
Notice that you need to wait a moment while bot trys to get the login QRCode from Wechat. As soon as the bot gets login QRCode url, he will print url out. You need to scan the qrcode on wechat, and confirm login.
After that, bot will be on duty. (roger-bot source can be found at here)
Here's an chatbot ding-dong-bot who can reply dong when receives a message ding.
Here's a chatbot api-ai-bot, who can slightly understand NLP.
Natual Language Understanding enabled by api.AI, you can get your module on api.AI by it's free plan.
TBD
Follow these instructions. Then,
TBD
Use NPM is recommended to install a stable version of Wechaty published on NPM.com
npm install --save wechaty
Then you are set.
Cloud9 IDE is Google Docs for Code, which is my favourite IDE today. Almost all my wechaty development is based on Cloud9.
Cloud9 IDE written in JavaScript, uses Node.js on the back-end. It uses Docker containers for its workspaces, and hosted on Google Compute Engine.
Open Terminal in Cloud9 IDE, use nvm to install nodejs v6, which is required by Wechaty.
$ nvm install 6
Downloading https://nodejs.org/dist/v6.2.1/node-v6.2.1-linux-x64.tar.xz...
######################################################################## 100.0%
Now using node v6.2.1 (npm v3.9.3)
$ nvm alias default 6
default -> 6 (-> v6.2.1)
$ node --version
v6.2.1
$ npm install
$ node example/ding-dong-bot.js
You are set.
In case that you want to dive deeper into Wechaty, fork & clone to run Wechaty bot on your machine, and start hacking.
Node.js Version 6.0 or above is required.
- Visit Node.js
- Download NodeJS Installer(i.e. "v6.2.0 Current")
- Run Installer to install NodeJS to your machine
If you have no github account, you can just clone it via https:
git clone https://github.com/zixia/wechaty.git
This will clone wechaty source code to your current directory.
cd wechaty
npm install
node example/ding-dong-bot.js
After a little while, bot will show you a message of a url for Login QrCode. You need to scan this qrcode in your wechat in order to permit your bot login.
Enjoy hacking Wechaty! Please submit your issue if you have any, and a fork & pull is very welcome for showing your idea.
If wechaty is not run as expected, run unit test maybe help to find some useful message.
$ npm test
To test with full log messages
$ WECHATY_LOG=silly npm test
Wechaty use npmlog to output log message. You can set log level by environment variable WECHATY_LOG
to show log message.
environment variable WECHATY_LOG
values:
silly
verbose
info
warn
error
silent
for disable logging
Linux/Darwin(OSX/Mac):
$ export WECHATY_LOG=verbose
Win32:
set WECHATY_LOG=verbose
Tips: You may want to have more scroll buffer size in your CMD window in windows.
mode con lines=32766
Here's a quick and dirty patch, to npmlog/log.js
m.message.split(/\r?\n/).forEach(function (line) {
var date = new Date();
var min = date.getMinutes()
var sec = date.getSeconds()
var hour = date.getHours()
if (sec < 10) { sec = '0' + sec }
if (min < 10) { min = '0' + min }
if (hour < 10) { hour = '0' + hour }
this.write(hour + ':' + min + ':' + sec + ' ')
if (this.heading) {
this.write(this.heading, this.headingStyle)
this.write(' ')
}
And we can looking forward the official support from npmlog: npm/npmlog#24
set environment variable WECHATY_DEBUG to enable DEBUG in Wechaty.
this will:
- open phantomjs debugger port on 8080
ECMAScript2015(ES6). I develop and test wechaty with Node.js v6.0.
I'll try my best to keep the api as sample as it can be.
Wechaty support the following 5 events:
- scan
- login
- logout
- message
- error
A scan
event will be emitted when the bot need to show you a QrCode for scaning.
wechaty.on('scan', ({code, url}) => {
console.log(`[${code}] Scan ${url} to login.` )
})
- url: {String} the qrcode image url
- code: {Number} the scan status code. some known status of the code list here is:
- 0 initial
- 200 login confirmed
- 201 scaned, wait for confirm
- 408 wait for scan
scan
event will be emit when it will detect a new code status change.
After the bot login full successful, the event login
will be emitted, with a Contact of current logined user.
wechaty.on('login', user => {
console.log(`user ${user} login`)
})
logout
will be emitted when bot detected it is logout, with a Contact of current logined user.
wechaty.on('logout', user => {
console.log(`user ${user} logout`)
})
Emit when there's a new message.
wechaty.on('message', message => {
console.log('message ${message} received')
})
The message
here is a Message.
To be support.
Main bot class.
const bot = new Wechaty({
profile
, token
})
profile
(OPTIONAL): profile name. if a profile name is provided, the login status will be saved to it, and automatically restored on next time of wechaty start(restart).- can be set by environment variable:
WECHATY_PROFILE
- can be set by environment variable:
token
(OPTIONAL): wechaty io token. Be used to connect to cloud bot manager.
Initialize the bot, return Promise.
wechaty.init()
.then(() => {
// do other staff with bot here
}
Reply a message
with reply
.
That means: the to
field of the reply message is the from
of origin message.
wechaty.reply(message, 'roger')
Check if message is send by self.
Return true
for send from self, false
for send from others.
if (wechaty.self(message)) {
console.log('this message is sent by myself!')
}
All wechat messages will be encaped as a Message.
Get prop from a message.
Supported prop list:
id
:Stringfrom
:Contactto
:Contactcontent
:Stringroom
:Roomdate
:Date
message.get('content')
Set prop to value for a message.
Supported prop list: the same as get(prop)
message.set('content', 'Hello, World!')
A message may be not fully initialized yet. Call ready()
to confirm we get all the data needed.
Return a Promise, will be resolved when all data is ready.
message.ready()
.then(() => {
// Here we can be sure all the data is ready for use.
})
Get prop from a contact.
Supported prop list:
id
:Stringweixin
:Stringname
:Stringremark
:Stringsex
:Numberprovince
:Stringcity
:Stringsignature
:String
contact.get('name')
A Contact may be not fully initialized yet. Call ready()
to confirm we get all the data needed.
Return a Promise, will be resolved when all data is ready.
contact.ready()
.then(() => {
// Here we can be sure all the data is ready for use.
})
Get prop from a room.
Supported prop list:
id
:Stringname
:Stringmembers
:Arraycontact
:Contactname
:String
room.get('members').length
A room may be not fully initialized yet. Call ready()
to confirm we get all the data needed.
Return a Promise, will be resolved when all data is ready.
room.ready()
.then(() => {
// Here we can be sure all the data is ready for use.
})
Wechaty use TAP protocol to test itself by tap.
To test Wechaty, run:
npm test
Know more about TAP: Why I use Tape Instead of Mocha & So Should You
- add wechaty.io cloud management support: set environment variable
WECHATY_TOKEN
to enable io support - rename
WECHATY_SESSION
toWECHATY_PROFILE
for better name - fix watchdog timer & reset bug
- add a watchdog to restore from unknown state
- add support to download image message by
ImageMessage.readyStream()
- fix lots of stable issues with webdriver exceptions & injection js code compatible
- add support to save & restore wechat login session
- add continious integration tests on win32 platform. (powered by AppVeyor)
- add environment variables HEAD/PORT/SESSION/DEBUG to config Wechaty
- use event
scan
to show login qrcode image url(and detect state change) - new examples: Tuling123 bot & api.AI bot
- more unit tests
- code coverage status
- Receive & send message
- Show contacts info
- Show rooms info
- 1st usable version
- Start coding from May 1st 2016
- Contact
- Accept a friend request
- Send a friend request
- Delete a contact
- Chat Room
- Create a new chat room
- Invite people to join a existing chat room
- Rename a Chat Room
- Events
- Use EventEmitter2 to emit message events, so we can use wildcard
message
message.recv
message.sent
message.recv.image
message.sent.image
message.recv.sys
message.**.image
message.recv.*
- Use EventEmitter2 to emit message events, so we can use wildcard
- Message
- Send/Reply image/video/attachment message
- Save video message to file
- Save image message to file
- Session save/load
Everybody is welcome to issue your needs.
Github Issue - https://github.com/zixia/wechaty/issues
- Lint: eslint
$ npm lint
- Create an issue, fork, then send a pull request(with unit test please).
- Weixinbot Nodejs 封装网页版微信的接口,可编程控制微信消息
- MojoWeixin 使用Perl语言编写的微信客户端框架,基于Mojolicious,要求Perl版本5.10+,可通过插件提供基于HTTP协议的api接口供其他语言或系统调用
- WeixinBot Very well documented 网页版微信API,包含终端版微信及微信机器人
- wxBot: Wechat Bot API
- ItChat: 微信个人号接口(支持文件、图片上下载)、微信机器人及命令行微信。三十行即可自定义个人号机器人
- SuperScript A dialog system and bot engine for conversational UI's. (Pure Javascript)
- RiveScript A simple scripting language for giving intelligence to chatbots and other conversational entities. (Perl original, Multi-Language support)
- 助手管家 It's a Official Account of wechat, which can manage your personal wechat account as a robot assistant.
- Luis.ai Language Understanding Intelligent Service (LUIS) offers a fast and effective way of adding language understanding to applications from Microsoft
- API.ai Build conversational user interfaces
- Wit.ai Turn user input into action from Facebook
- Watson a comprehensive, robust, platform for managing conversations between virtual agents and users through an application programming interface (API) from IBM
- Advanced Natural Language Processing Tools for Bot Makers a good article of comparing the above services.
- Bot Framework Build and connect intelligent bots to interact with your users naturally wherever they are, from text/sms to Skype, Slack, Office 365 mail and other popular services. from Microsoft
My daily life/work depends on too much chat on wechat.
- I almost have 14,000 wechat friends till May 2014, before wechat restricts a total number of friends to 5,000.
- I almost have 400 wechat rooms that most of them have more than 400 members.
Can you image that? I'm dying...
So a tireless bot working for me 24x7 on wechat, moniting/filtering the most important message is badly needed. For example: highlights discusstion which contains the KEYWORDS I want to follow up(especially in a noisy room). ;-)
At last, It's built for my personal study purpose of Automatically Testing.
Zhuohuan LI zixia@zixia.net (http://linkedin.com/in/zixia)
- Code & Docs 2016© zixia
- Code released under the ISC license
- Docs released under Creative Commons