Skip to main content

What is Wechaty

A chatbot is a software application used to conduct an on-line chat conversation, in lieu of providing direct contact with a live human agent. A chatbot is a type of software that can automate conversations and interact with people through messaging platforms. — Wikipedia

Wechaty is a modern Conversational RPA SDK for Chatbot Makers which can create a bot in a few lines of code.

Wechaty offers out-of-the box support for the common features you'd expect from turning your IM account into chatbot, and can be easily customised and extended by developers to create a chatbot that is tailored to their precise needs.

Wechaty support lots of popular instant messaging platforms:

Wechaty Puppet WeChat Wechaty Puppet Whatsapp Wechaty Puppet Official Account Wechaty Puppet Gitter Wechaty Puppet Lark Wechaty Puppet PadLocal Wechaty Puppet WeChat4U Wechaty Puppet Service Wechaty Puppet Mock Wechaty Puppet DIY

And you can write Wechaty in almost all popular programming languages:

OpenAPI Wechaty TypeScript Wechaty Python Wechaty Go Wechaty Kotlin(Java) Wechaty Scala Wechaty PHP Wechaty .NET Wechaty Rust Wechaty DIY Wechaty


  1. Message processing: Receive and send messages, support text, image, audio, video, and attatchments.
  2. Room management: Create rooms, add/remove room members, manage topics, etc
  3. Contact management: Search by name, alias, tags, get profile data and avatar
  4. Friendship management: Search and add new friends, accept friendship requests, etc
  5. Intelligent dialogue Management: Just several configuration can get a task-oriented bot.
  6. last but not least: Write once, run on all IM platforms!
API References

Learn more functions from API Reference and How-to Guides.

Voice of developers#

"Wechaty is a great solution, I believe there would be much more users recognize it." link
— @Gcaufy, Tencent Engineer, Author of WePY

— @xinbenlv, Google Engineer, Founder of

"最好的微信开发库" link
— @Jarvis, Baidu Engineer

"Wechaty让运营人员更多的时间思考如何进行活动策划、留存用户,商业变现" link
— @lijiarui, Founder & CEO of Juzi.BOT.

"If you know js ... try Wechaty, it's easy to use."
— @Urinx Uri Lee, Author of WeixinBot(Python)

"Wechaty is a good project, I hope it can continue! Therefore, I became a contributors in open collective."
— @Simple

World's shortest chatbot#

We can build a chatbot in minimum 6 lines of code with Wechaty.

import { Wechaty } from 'wechaty'
async function main () {
const bot = new Wechaty()
.on('scan', (qrcode, status) => console.log(`Scan QR Code to login: ${status}\n${encodeURIComponent(qrcode)}`))
.on('login', user => console.log(`User ${user} logged in`))
.on('message', message => console.log(`Message: ${message}`))
await bot.start()
Polyglot Wechaty

Read more codes from Polyglot.

Release notes#

Stargazers over time#

Stargazers over time


GitHub issues GitHub pull requests Open Collective Backers Open Collective Sponsors

contributor contributor contributor contributor contributor contributor contributor contributor

This project exists thanks to all the people who contribute.



Backers on Open Collective

Thank you to all our backers! 🙏 [Become a backer]

Open Collective Wechaty


Sponsors on Open Collective

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Wechaty Sponsor

Join us#

Scan the following QRCode, reply ''wechaty" to join Wechaty Developers' Home.

Wechaty Developers' Home

Last updated on by Souvik Biswas