PPAgent 文档

Appearance

微信对话开放平台 ​

通过微信对话开放平台，可以支持 公众号、小程序、微信客服、网页H5等平台的接入。注意这里是##将对话开放平台作为消息源使用，而不是用于回复的大模型##。

步骤

  • 登录微信对话开放平台，创建机器人
  • 切换到管理-应用绑定-开放API
    • 从这里获取appId,token,aesKey的信息
    • 回调地址设置为 http(s)\://你的域名/api/{instanceName}/api
    • 如果开启了第三方客服，则微信的客服消息会被接管
  • 在上一步的页面中，切换到想要绑定的平台，按操作提示进行绑定
  • 根据拿到的信息，按本文的步骤创建实例或者在可视化平台中填入

支持的消息类型 ​

  • 文本消息
  • 图片消息
  • 语音消息
  • 链接消息
  • 图文消息（回复时）

使用代码配置 ​

typescript
const app = new PPAgent({
  // ...
  sources: [
    {
      name: "wcai",
      options: {
        instanceName: "wcai", // 实例名称，必填
        appId: "你的应用ID", // 微信对话开放平台的appId，必填
        token: "你的Token", // 微信对话开放平台的Token，必填
        aesKey: "你的AESKey", // 微信对话开放平台的AESKey，必填
        me: {
          userId: "机器人ID", // 自定义机器人ID，必填
          userName: "机器人名称", // 自定义机器人名称，必填
          nickName: "机器人昵称" // 自定义机器人昵称，必填
        },
        apiBase: "https://chatbot.weixin.qq.com" // API基础地址，可选，默认为https://chatbot.weixin.qq.com
      }
    }
  ],
  // ... 其他配置
});

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

流式回复支持 ​

微信对话开放平台消息源不支持流式回复，所有消息都是一次性发送的。

配置注意事项 ​

  1. 需要在微信对话开放平台的管理-应用绑定-开放API中开启开放API功能才能获取必填的appId、token和aesKey。

  2. 微信对话开放平台支持接入公众号、企业微信、小程序、微信客服和网页H5等多种渠道。

  3. 由于微信对话机器人不存在群聊，所以me配置中的机器人信息可以填写任意值，主要用于识别公众平台消息源。

  4. 对于语音消息，微信对话开放平台会自动进行语音识别，并在消息中提供识别结果。

  5. 图片和链接等富媒体消息会通过卡片形式展示给用户。

  6. 微信公众号一次回复允许的条数有限，可以在Agent的配置中对拆分的条数进行限制。