# Puppet

## 1. 介绍 <a href="#intro" id="intro"></a>

不同的[Puppet](https://github.com/Chatie/wechaty/wiki/Puppet) 代表的我们对微信协议的不同实现方式, Puppet的英文意思是`傀儡`, 很形象的描述了我们希望Puppet做的事情：帮助 Wechaty 来控制微信的操作。

所有的实现方式都以`PuppetXXX` 来命名的，比如[PuppetPuppeteer](https://github.com/Chatie/wechaty-puppet-puppeteer) 是通过谷歌浏览器，通过 [google puppeteer](https://github.com/GoogleChrome/puppeteer)来控制[网页微信API](https://wx.qq.com)。[PuppetPadchat](https://github.com/lijiarui/wechaty-puppet-padchat) 是通过WebSocket 连接一个协议服务器来控制iPad 微信。

如果你希望深入了解Puppet是如何在Wechaty 运行的，你可以在<https://github.com/Chatie/wechaty-puppet/blob/master/src/puppet.ts> 查看源代码。

基于网页微信的实现方式是免费的，基于其他的接入方式是收费的，详细介绍：[收费说明](https://github.com/lijiarui/wechaty-puppet-padchat/wiki/%E8%B4%AD%E4%B9%B0token)

以下是Puppet 和Wechaty 的架构图，更多Puppet 的介绍在这里： [Puppet in wiki](https://github.com/Chatie/wechaty-puppet/wiki)

![](https://github.com/Chatie/wechaty/wiki/image/abstract-info.png)

## 2. Wechaty Puppet 清单 <a href="#puppet-list" id="puppet-list"></a>

### 2.1 调用 Wechaty 的开发者 <a href="#puppet-developer" id="puppet-developer"></a>

| Puppet                                                                | 使用的微信协议          | Npm 名称                                                                                     | Npm 版本                                                                                                                                                                                                                              | 状态                                                                      |
| --------------------------------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [PuppetPuppeteer](https://github.com/Chatie/wechaty-puppet-puppeteer) | 通过浏览器 Hook 网页API | wechaty-puppet-puppeteer                                                                   | ![PuppetPuppeteer](https://badge.fury.io/js/wechaty-puppet-puppeteer.svg) [![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-puppeteer/next.svg)](https://www.npmjs.com/package/wechaty-puppet-puppeteer?activeTab=versions) | ![Stage:Release](https://img.shields.io/badge/Stage-Release-green.svg)  |
| [PuppetPadchat](https://github.com/lijiarui/wechaty-puppet-padchat)   | iPad 协议          | wechaty-puppet-padchat                                                                     | ![PuppetPadchat](https://badge.fury.io/js/wechaty-puppet-padchat.svg)   [![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-padchat/next.svg)](https://www.npmjs.com/package/wechaty-puppet-padchat?activeTab=versions)       | ![Stage:Release](https://img.shields.io/badge/Stage-Release-green.svg)  |
| [PuppetPadpro](https://github.com/botorange/wechaty-puppet-padpro)    | iPad 协议          | 增强版本的wechaty-puppet-padchat,  详见[issue1668](https://github.com/Chatie/wechaty/issues/1668) | ![PuppetPadpro](https://badge.fury.io/js/wechaty-puppet-padpro.svg)   [![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-padpro.svg)](https://www.npmjs.com/package/wechaty-puppet-padpro?activeTab=versions)                | ![Stage:Release](https://img.shields.io/badge/Stage-Release-green.svg)  |
| [PuppetWechat4u](https://github.com/Chatie/wechaty-puppet-wechat4u)   | 通过HTTP 调用网页API   | wechaty-puppet-wechat4u                                                                    | ![PuppetWechat4u](https://badge.fury.io/js/wechaty-puppet-wechat4u.svg)   [![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-wechat4u/next.svg)](https://www.npmjs.com/package/wechaty-puppet-wechat4u?activeTab=versions)   | ![Stage:Release](https://img.shields.io/badge/Stage-Alpha-red.svg)      |
| [PuppetIosbird](https://github.com/botorange/wechaty-puppet-iosbird)  | iPhone Hook      | wechaty-puppet-iosbird                                                                     | ![PuppetIosbird](https://badge.fury.io/js/wechaty-puppet-iosbird.svg)   [![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-iosbird.svg)](https://www.npmjs.com/package/wechaty-puppet-iosbird?activeTab=versions)            | ![Stage:Release](https://img.shields.io/badge/Stage-Alpha-red.svg)      |
| TBW                                                                   | Android Hook     | Android                                                                                    | 0.0.0                                                                                                                                                                                                                               | ![Stage:Release](https://img.shields.io/badge/Stage-Plan-lightgrey.svg) |
| TBW                                                                   | Win32 Hook       | Win32                                                                                      | 0.0.0                                                                                                                                                                                                                               | ![Stage:Release](https://img.shields.io/badge/Stage-Plan-lightgrey.svg) |

### 2.2 开发 Puppet 开发者 <a href="#puppet-builder" id="puppet-builder"></a>

| Puppet                                                      | 使用的微信协议     | Npm 名称              | Npm 版本                                                                                                                                                                                                            | 状态                                                                     |
| ----------------------------------------------------------- | ----------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| [Puppet](https://github.com/Chatie/wechaty-puppet)          | 抽象父类        | wechaty-puppet      | ![Puppet](https://badge.fury.io/js/wechaty-puppet.svg)   [![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet/next.svg)](https://www.npmjs.com/package/wechaty-puppet?activeTab=versions)                    | ![Stage:Release](https://img.shields.io/badge/Stage-Release-green.svg) |
| [PuppetMock](https://github.com/Chatie/wechaty-puppet-mock) | 为单元测试提供模拟调用 | wechaty-puppet-mock | ![PuppetMock](https://badge.fury.io/js/wechaty-puppet-mock.svg)   [![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-mock/next.svg)](https://www.npmjs.com/package/wechaty-puppet-mock?activeTab=versions) | ![Stage:Release](https://img.shields.io/badge/Stage-Release-green.svg) |

## 3. Wechaty Puppet 兼容性 <a href="#puppet-compatibility" id="puppet-compatibility"></a>

### 3.1 Puppet 联系人接口 <a href="#puppet-contact" id="puppet-contact"></a>

| Contact API                 | 描述         | PuppetWechat4u & PuppetPuppeteer | PuppetPadchat & PuppetPadPro | PuppetIosbird |
| --------------------------- | ---------- | :------------------------------: | :--------------------------: | :-----------: |
| Permanent ContactPayload.id | 唯一id       |              ~~No~~              |              Yes             |      Yes      |
| ContactPayload.friend       | 判断是否为机器人好友 |              ~~No~~              |              Yes             |      Yes      |
| weixin()                    | 获取微信号      |              ~~No~~              |              Yes             |      Yes      |

### 3.2 Puppet 消息收发接口 <a href="#puppet-message" id="puppet-message"></a>

| Message API          | 描述      | PuppetWechat4u & PuppetPuppeteer | PuppetPadchat & PuppetPadPro |     PuppetIosbird     |
| -------------------- | ------- | :------------------------------: | :--------------------------: | :-------------------: |
| messageSendContact() | 发送联系人名片 |              ~~No~~              |              Yes             |         ~~No~~        |
| messageFile()        | 接收文件    |                Yes               |    Yes: 图片/音频/视频 No: 其他文件    | Yes: 图片/音频/视频/其他文件/连接 |
| messageSendFile()    | 发送文件    |                Yes               |    Yes: 图片/音频/视频 No: 其他文件    |    Yes: 图片 No: 其他文件   |
| messageSendUrl()     | 发送链接消息  |              ~~No~~              |              Yes             |         ~~No~~        |

{% hint style="info" %}
Wechaty-puppet-padpro 已经支持发送各类文件，包括word,pdf,ppt等，正在内测中，如需要请在[issue 1668](https://github.com/Chatie/wechaty/issues/1668) 报名哦
{% endhint %}

### 3.3 Puppet 微信群接口 <a href="#puppet-room" id="puppet-room"></a>

| Room API                 | 描述      | PuppetWechat4u & PuppetPuppeteer | PuppetPadchat & PuppetPadPro | PuppetIosbird |
| ------------------------ | ------- | :------------------------------: | :--------------------------: | :-----------: |
| Permanent RoomPayload.id | 唯一群id   |              ~~No~~              |              Yes             |      Yes      |
| roomQrcode()             | 获取群二维码  |              ~~No~~              |              Yes             |      Yes      |
| roomCreate()             | 创建微信群   |              ~~No~~              |              Yes             |      Yes      |
| roomAdd()                | 邀请好友入群  |              ~~No~~              |              Yes             |      Yes      |
| roomDel()                | 将用户踢出群聊 |              ~~No~~              |              Yes             |      Yes      |
| roomQuit()               | 主动退群    |              ~~No~~              |              Yes             |      Yes      |
| roomAnnounce()           | 发群公告    |              ~~No~~              |              Yes             |      Yes      |
| roomPayload.owner        | 获取群主信息  |              ~~No~~              |              Yes             |     ~~No~~    |
| roomInvitaition          | 自动接受群邀请 |              ~~No~~              |              Yes             |     ~~No~~    |

## 4. 了解更多 <a href="#more" id="more"></a>

你可以参考这里了解更多的 Wechaty Puppet 内容： <https://github.com/Chatie/wechaty-puppet/wiki>

* Github: <https://github.com/Chatie/wechaty-puppet>
* 文档说明: <https://chatie.io/wechaty-puppet/typedoc/classes/puppet.html>
* Puppet 开发指南: <https://github.com/Chatie/wechaty-puppet/wiki/Development>
* Puppet 相关链接: <https://github.com/Chatie/wechaty-puppet/wiki/Links>


---

# Agent Instructions: 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/zh/puppet.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.