# Examples

You can get all of the following examples as follows

<https://github.com/wechaty/wechaty-getting-started/tree/master/examples>

## 1. BASIC

Wechaty Basic Functions, see <https://github.com/Chatie/wechaty-getting-started/tree/master/examples/basic>

| FileName                                       | Description                                                             |
| ---------------------------------------------- | ----------------------------------------------------------------------- |
| the-worlds-shortest-chatbot-code-in-6-lines.js | The very first wechaty example showcasing how easy it is to get started |
| ding-dong-bot.js                               | Practical example illustrates on how to do message handling             |
| contact-bot.js                                 | List all contacts by Wechat ID & Name                                   |

## 2. ADVANCED

Wechaty Advanced Functions, see <https://github.com/Chatie/wechaty-getting-started/tree/master/examples/advanced>

| FileName                    | Description                                                            |
| --------------------------- | ---------------------------------------------------------------------- |
| demo-in-tutorial.js         | the demo bot from the tutorial                                         |
| busy-bot.js                 | auto response "busy" message for you when you are                      |
| media-file-bot.js           | Save Media Attachment in Message to local files                        |
| room-bot.js,room-say-cli.js | Practical example illustrates on how to do room handling               |
| friend-bot.js               | Practical example illustrates on how to do friend handling             |
| gist-bot/                   | Best template for bigger modules, with each handler in separated files |

## 3. PROFESSIONAL

Wechaty Integrated with Other Modules/Services, see <https://github.com/Chatie/wechaty-getting-started/tree/master/examples/professional>

| FileName              | Description                                                                                                         |
| --------------------- | ------------------------------------------------------------------------------------------------------------------- |
| hot-import-bot/       | Using Hot Module Reload(HMR) for Wechaty Listeners                                                                  |
| ctrl-c-signal-bot.ts  | Ctrl-C signal handling demo                                                                                         |
| monster-bot/          | demo that tried to include everything -- message, room, HMR & signal handling, with each handler in separated files |
| api-ai-bot.ts         | Wechaty bot that uses ApiAi.com brain                                                                               |
| speech-to-text-bot.ts | bot that uses baidu speech (vop.baidu.com)                                                                          |
| tuling123-bot.ts      | Connect to [tuling123](http://www.tuling123.com/) chatbot                                                           |
| telegram-roger-bot.js | single bot that runs under/for both Telegram and WeChaty                                                            |
| blessed-twins-bot/    | Wechaty multi-instance support (v0.16+) demo                                                                        |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wechaty.gitbook.io/wechaty/examples.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.