WeRoBot 0.6.1 微信公众号开发框架文档

• 语言: 英语
• 格式: .epub
• 来源: werobot.readthedocs.io

摘要

WeRoBot 是一个基于 MIT 协议的微信机器人框架，支持微信支付功能和会话管理。框架提供了包括文本、图片、链接、地理位置、事件、语音、视频等多种消息处理能力，并支持通过 Session 实现用户状态记录。开发者可以利用该框架创建自定义菜单、发送消息、管理分组等，并提供了丰富的 API 操作类，如 WeRoBot.Client 和 WeixinPayClient。同时，框架支持多种存储方式，如文件存储、MongoDB存储等。版本更新中添加了对视频消息的支持，并修复了部分功能问题。

AI总结

《WeRoBot 0.6.1 微信公众号开发框架文档》总结如下：

### 1. **框架概述**
WeRoBot 是一个基于 MIT 协议的微信机器人框架，支持丰富的功能，包括消息处理、会话管理、微信 API 操作和微信支付功能。框架地址：[https://github.com/whtsky/WeRoBot](https://github.com/whtsky/WeRoBot)。

---

### 2. **核心功能**
- **消息处理**：
- 支持多种消息类型，包括文本、图片、链接、地理位置、事件、语音和视频消息。
- 提供 `TextReply`、`ArticlesReply`、`MusicReply` 和 `TransferCustomerServiceReply` 四种回复类型。
- **会话管理**：
- 从版本 0.4.0 起引入 Session 系统，支持用户状态记录。
-_session_storage_ 默认为 `FileStorage`，支持 `MongoDBStorage` 和 `RedisStorage`。
- **微信 API 操作**：
- 通过 `WeRoBot.Client` 类提供主动发送消息、创建分组、自定义菜单等功能。
- **微信支付功能**：
- 提供 `WeRoBot.pay.WeixinPayClient` 类，支持 Native 支付和 JS 支付。

---

### 3. **详细功能说明**
#### **消息处理**
- **消息类型**：
- `TextMessage`：包含 `content` 属性。
- `ImageMessage`：包含 `img` 属性，表示图片网址。
- `LinkMessage`：包含 `title`、`description` 和 `url` 属性。
- `EventMessage`：支持地理位置事件。
- **回复类型**：
- `TextReply`：支持文本消息，自动将字符串转化为文本消息。
- `ArticlesReply`：支持图文消息。
- `TransferCustomerServiceReply`：将消息转发给多客服。

#### **会话管理**
- 启用会话：通过 `enable_session=True` 启用，支持跨请求状态记录。
- 示例：

  robot = WeRoBot(token=generate_token(), enable_session=True)
  @robot.text
  def first(message, session):
      if 'last' in session:
          return session['last']
      session['last'] = message.content
      return message.content

#### **微信 API 操作**
- 主要功能：
- 创建分组：`create_group(name)`。
- 创建自定义菜单：`create_menu(menu_data)`。
- 主动发送消息：支持文本、图片、视频等类型。
- 示例：创建自定义菜单：

  client = Client("id", "secret")
  client.create_menu({
      "button": [
          {
              "type": "click",
              "name": "今日歌曲",
              "key": "V1001_TODAY_MUSIC"
          },
          # 其他按钮定义
      ]
  })

#### **微信支付功能**
- 提供 `create_native_pay_url` 方法创建 Native 支付 URL。
- 提供 `create_js_pay_params` 方法生成 JS 支付参数。

---

### 4. **部署与支持**
- 支持在独立服务器或 SAE 上部署。
- 提供多种存储方式：`FileStorage`、`MongoDBStorage` 和 `RedisStorage`。

---

### 5. **更新日志**
- **版本 0.6.1**：修复 URL 错误，增加 VideoMessage 支持。
- **版本 0.6.0**：新增 `@werobot.filter`、`werobot.session.saekvstorage` 和微信支付功能。
- **版本 0.5.0**：新增 `werobot.client`、`werobot.config` 和 `werobot.logger`。

---

### 6. **开发者资源**
- 官方文档：[WeRoBot 0.6.1 文档](https://whtsky.github.io/WeRoBot/)。
- GitHub 项目地址：[https://github.com/whtsky/WeRoBot](https://github.com/whtsky/WeRoBot)。

如需进一步帮助，可以通过 Issue 或邮件（[e-mail]）联系开发者。