Skip to content

Latest commit

 

History

History
167 lines (140 loc) · 6.11 KB

File metadata and controls

167 lines (140 loc) · 6.11 KB
summary Zalo bot 支持状态、功能和配置
read_when
开发 Zalo 功能或 webhooks

Zalo (Bot API)

状态: 实验性。仅支持私信;根据 Zalo 文档,群组即将推出。

需要插件

Zalo 作为插件提供,不包含在核心安装中。

  • 通过 CLI 安装: moltbot plugins install @moltbot/zalo
  • 或在入职期间选择 Zalo 并确认安装提示
  • 详情: 插件

快速设置(初学者)

  1. 安装 Zalo 插件:
    • 从源检出: moltbot plugins install ./extensions/zalo
    • 从 npm(如果已发布): moltbot plugins install @moltbot/zalo
    • 或在入职中选择 Zalo 并确认安装提示
  2. 设置令牌:
    • 环境变量: ZALO_BOT_TOKEN=...
    • 或配置: channels.zalo.botToken: "..."
  3. 重启网关(或完成入职)。
  4. 私信访问默认为配对;首次联系时批准配对代码。

最小配置:

{
  channels: {
    zalo: {
      enabled: true,
      botToken: "12345689:abc-xyz",
      dmPolicy: "pairing"
    }
  }
}

它是什么

Zalo 是一个专注于越南的消息应用程序;其 Bot API 允许网关为 1:1 对话运行 bot。 它适合支持或通知,您希望确定性路由回 Zalo。

  • 网关拥有的 Zalo Bot API 频道。
  • 确定性路由: 回答返回到 Zalo;模型从不选择频道。
  • 私信共享代理的主会话。
  • 尚不支持群组(Zalo 文档说明"即将推出")。

设置(快速路径)

1) 创建 bot 令牌(Zalo Bot Platform)

  1. 访问 https://bot.zaloplatforms.com 并登录。
  2. 创建一个新 bot 并配置其设置。
  3. 复制 bot 令牌(格式: 12345689:abc-xyz)。

2) 配置令牌(环境变量或配置)

示例:

{
  channels: {
    zalo: {
      enabled: true,
      botToken: "12345689:abc-xyz",
      dmPolicy: "pairing"
    }
  }
}

环境变量选项: ZALO_BOT_TOKEN=...(仅适用于默认账户)。

多账户支持: 使用 channels.zalo.accounts 和每账户令牌以及可选的 name

  1. 重启网关。当令牌被解析(环境变量或配置)时,Zalo 启动。
  2. 私信访问默认为配对。bot 首次联系时批准代码。

工作原理(行为)

  • 入站消息被规范化到共享频道信封中,并带有媒体占位符。
  • 回答总是路由回相同的 Zalo 聊天。
  • 默认长轮询;webhook 模式可通过 channels.zalo.webhookUrl 使用。

限制

  • 出站文本分块为 2000 个字符(Zalo API 限制)。
  • 媒体下载/上传受 channels.zalo.mediaMaxMb 限制(默认 5)。
  • 由于 2000 字符限制使流式传输不太有用,默认阻止流式传输。

访问控制(私信)

私信访问

  • 默认: channels.zalo.dmPolicy = "pairing"。未知发送者会收到配对代码;消息将被忽略,直到被批准(代码在 1 小时后过期)。
  • 通过以下方式批准:
    • moltbot pairing list zalo
    • moltbot pairing approve zalo <CODE>
  • 配对是默认的令牌交换。详情: 配对
  • channels.zalo.allowFrom 接受数字用户 ID(无用户名查找可用)。

长轮询 vs webhook

  • 默认: 长轮询(不需要公共 URL)。
  • Webhook 模式: 设置 channels.zalo.webhookUrlchannels.zalo.webhookSecret
    • webhook 密钥必须为 8-256 个字符。
    • Webhook URL 必须使用 HTTPS。
    • Zalo 使用 X-Bot-Api-Secret-Token 标头发送事件以进行验证。
    • 网关 HTTP 在 channels.zalo.webhookPath(默认为 webhook URL 路径)处理 webhook 请求。

注意: 根据 Zalo API 文档,getUpdates(轮询)和 webhook 互斥。

支持的消息类型

  • 文本消息: 完全支持 2000 字符分块。
  • 图像消息: 下载和处理入站图像;通过 sendPhoto 发送图像。
  • 贴纸: 已记录但未完全处理(无代理响应)。
  • 不支持的类型: 已记录(例如,来自受保护用户的消息)。

功能

功能 状态
私信 ✅ 支持
群组 ❌ 即将推出(根据 Zalo 文档)
媒体(图像) ✅ 支持
表情回应 ❌ 不支持
线程 ❌ 不支持
投票 ❌ 不支持
原生命令 ❌ 不支持
流式传输 ⚠️ 阻止(2000 字符限制)

传递目标(CLI/cron)

  • 使用聊天 id 作为目标。
  • 示例: moltbot message send --channel zalo --target 123456789 --message "hi"

故障排除

Bot 不响应:

  • 检查令牌是否有效: moltbot channels status --probe
  • 验证发送者是否已批准(配对或 allowFrom)
  • 检查网关日志: moltbot logs --follow

Webhook 未接收事件:

  • 确保 webhook URL 使用 HTTPS
  • 验证密钥令牌为 8-256 个字符
  • 确认网关 HTTP 端点在配置的路径上可访问
  • 检查 getUpdates 轮询是否未运行(它们互斥)

配置参考(Zalo)

完整配置: 配置

提供程序选项:

  • channels.zalo.enabled: 启用/禁用频道启动。
  • channels.zalo.botToken: 来自 Zalo Bot Platform 的 bot 令牌。
  • channels.zalo.tokenFile: 从文件路径读取令牌。
  • channels.zalo.dmPolicy: pairing | allowlist | open | disabled(默认: pairing)。
  • channels.zalo.allowFrom: 私信允许列表(用户 ID)。open 需要 "*"。向导将询问数字 ID。
  • channels.zalo.mediaMaxMb: 入站/出站媒体上限(MB,默认 5)。
  • channels.zalo.webhookUrl: 启用 webhook 模式(需要 HTTPS)。
  • channels.zalo.webhookSecret: webhook 密钥(8-256 字符)。
  • channels.zalo.webhookPath: 网关 HTTP 服务器上的 webhook 路径。
  • channels.zalo.proxy: API 请求的代理 URL。

多账户选项:

  • channels.zalo.accounts.<id>.botToken: 每账户令牌。
  • channels.zalo.accounts.<id>.tokenFile: 每账户令牌文件。
  • channels.zalo.accounts.<id>.name: 显示名称。
  • channels.zalo.accounts.<id>.enabled: 启用/禁用账户。
  • channels.zalo.accounts.<id>.dmPolicy: 每账户私信策略。
  • channels.zalo.accounts.<id>.allowFrom: 每账户允许列表。
  • channels.zalo.accounts.<id>.webhookUrl: 每账户 webhook URL。
  • channels.zalo.accounts.<id>.webhookSecret: 每账户 webhook 密钥。
  • channels.zalo.accounts.<id>.webhookPath: 每账户 webhook 路径。
  • channels.zalo.accounts.<id>.proxy: 每账户代理 URL。