PPAgent 文档

Appearance

GeweChat ​

提醒

个人微信机器人，不受微信官方支持，存在封号风险。本框架没有默认支持。

您可以查询npm上有无第三方开源插件支持，本文介绍 https://www.npmjs.com/package/ppagent-source-gewechat。

插件仅供学习使用，请勿用于任何商业用途。插件本身仅对接消息，不存在任何逆向工程。

以下以gewechat插件为例，说明如何接入个人微信消息。

GeweChat 是一个基于 gewechaty 实现的个人微信消息源，允许用户通过个人微信账号与 PPAgent 进行交互。

支持的消息类型 ​

  • 文本消息
  • 图片消息
  • 表情消息
  • 链接消息
  • 引用消息
  • 拍一拍消息
  • 位置消息
  • 小程序消息
  • 联系人名片

使用代码配置 ​

要在 PPAgent 中配置 GeweChat 消息源，您需要按照以下方式设置：

typescript
const app = new PPAgent({
  sources: [
    {
      name: "Gewechat",
      options: {
        instanceName: "gewechat-source", // 实例名称，需保证全局唯一
        baseApi: "http://localhost:2531/v2/api", // GeweChat API 服务地址
        fileApi: "http://localhost:2532/download", // GeweChat 文件服务地址
        port: 3000, // 可选：服务端口，默认为 3000
        debug: false, // 可选：是否开启调试模式
      }
    }
  ],
  // ... 其他配置项
});

服务器运行请参考 install_code.md 文件。

流式回复支持 ​

GeweChat 不支持流式回复。

配置注意事项 ​

  1. 使用 GeweChat 前需确保已安装并运行 gewechaty 服务。
  2. baseApi 和 fileApi 为必填项，分别对应 gewechaty 的 API 服务地址和文件服务地址。
  3. 首次登录时需扫描二维码完成微信登录认证，二维码可以在服务端日志或者通过可视化客户端连接日志查看。
  4. 个人微信存在一定的封号风险，请合理使用，避免频繁发送大量消息。
  5. 因微信限制，部分消息类型（如音频、视频等）可能会转换为其他格式发送。