Zalo (Bot API)
状态:实验性。支持私信。下方的 Capabilities 部分反映了当前 Marketplace-bot 的行为。需要插件
Zalo 作为插件提供,不包含在核心安装中。- 通过 CLI 安装:
openclaw plugins install @openclaw/zalo - 或者在设置期间选择 Zalo 并确认安装提示
- 详情:Plugins
快速设置(初学者)
- 安装 Zalo 插件:
- 从源代码检出:
openclaw plugins install ./extensions/zalo - 从 npm(如果已发布):
openclaw plugins install @openclaw/zalo - 或者在设置中挑选 Zalo 并确认安装提示
- 从源代码检出:
- 设置 token:
- 环境变量:
ZALO_BOT_TOKEN=... - 或者配置:
channels.zalo.accounts.default.botToken: "..."。
- 环境变量:
- 重启 Gateway(或完成设置)。
- 私信访问默认为配对模式;在首次联系时批准配对码。
简介
Zalo 是一款面向越南的通讯应用;其 Bot API 允许 Gateway(网关) 运行机器人以进行 1:1 对话。 它非常适合支持或通知场景,尤其是在您希望确定性地路由回 Zalo 时。 本页面反映了当前 OpenClaw 针对 Zalo Bot Creator / Marketplace bots 的行为。 Zalo Official Account (OA) bots 是不同的 Zalo 产品界面,行为可能有所不同。- 由 Gateway 拥有的 Zalo Bot API 渠道。
- 确定性路由:回复会发回给 Zalo;模型从不选择渠道。
- 私信共享代理的主会话。
- 下方的 Capabilities 部分显示了当前 Marketplace-bot 的支持情况。
设置(快速路径)
1) 创建 bot token (Zalo Bot Platform)
- 前往 https://bot.zaloplatforms.com 并登录。
- 创建一个新的 bot 并配置其设置。
- 复制完整的 bot token(通常为
numeric_id:secret)。对于 Marketplace bots,可用的运行时 token 可能会在创建后出现在 bot 的欢迎消息中。
2) 配置 token (env 或 config)
示例:groupPolicy 和 groupAllowFrom。有关当前 Marketplace-bot 的行为,请参阅 Capabilities。
环境变量选项:ZALO_BOT_TOKEN=...(仅适用于默认帐户)。
多帐户支持:使用 channels.zalo.accounts 配合每个帐户的 token 和可选的 name。
- 重启 Gateway。当解析到 token(env 或 config)时,Zalo 会启动。
- 私信访问默认为配对。首次联系 bot 时批准代码。
工作原理(行为)
- 入站消息会被标准化为带有媒体占位符的共享渠道信封。
- 回复总是路由回同一个 Zalo 聊天。
- 默认为长轮询;通过
channels.zalo.webhookUrl可使用 webhook 模式。
限制
- 出站文本会被分块为 2000 个字符(Zalo API 限制)。
- 媒体下载/上传受
channels.zalo.mediaMaxMb限制(默认为 5)。 - 由于 2000 个字符的限制,流式传输默认被阻止,因为流式传输的作用降低。
访问控制(私信)
私信访问
- 默认值:
channels.zalo.dmPolicy = "pairing"。未知发送者将收到配对码;在批准之前消息将被忽略(代码在 1 小时后过期)。 - 通过以下方式批准:
openclaw pairing list zaloopenclaw pairing approve zalo <CODE>
- 配对是默认的令牌交换方式。详情:配对
channels.zalo.allowFrom接受数字用户 ID(无法通过用户名查找)。
访问控制(群组)
对于 Zalo Bot Creator / Marketplace 机器人,实际上无法提供群组支持,因为机器人根本无法添加到群组中。 这意味着以下与群组相关的配置键存在于架构中,但对于 Marketplace 机器人不可用:channels.zalo.groupPolicy控制群组入站处理:open | allowlist | disabled。channels.zalo.groupAllowFrom限制在群组中可以触发机器人的发送者 ID。- 如果未设置
groupAllowFrom,Zalo 将回退到allowFrom进行发送者检查。 - 运行时注意:如果完全缺少
channels.zalo,出于安全考虑,运行时仍将回退到groupPolicy="allowlist"。
groupPolicy: "disabled"— 阻止所有群组消息。groupPolicy: "open"— 允许任何群组成员(提及限制)。groupPolicy: "allowlist"— 默认为故障关闭;仅接受允许的发送者。
长轮询与 Webhook
- 默认值:长轮询(不需要公共 URL)。
- Webhook 模式:设置
channels.zalo.webhookUrl和channels.zalo.webhookSecret。- Webhook 密钥长度必须在 8 到 256 个字符之间。
- Webhook URL 必须使用 HTTPS。
- Zalo 发送带有
X-Bot-Api-Secret-Token标头的事件以进行验证。 - Gateway HTTP 在
channels.zalo.webhookPath处理 Webhook 请求(默认为 Webhook URL 路径)。 - 请求必须使用
Content-Type: application/json(或+json媒体类型)。 - 重复事件(
event_name + message_id)会在短时间内重放窗口中被忽略。 - 突发流量按路径/源进行速率限制,并可能返回 HTTP 429。
支持的消息类型
如需快速了解支持概况,请参阅 功能。以下注释在行为需要额外上下文时提供了详细信息。- 文本消息:完全支持,具有 2000 字符的分块功能。
- 文本中的纯 URL:表现与普通文本输入类似。
- 链接预览 / 富链接卡片:请参阅 功能 中的 Marketplace-bot 状态;它们未能可靠地触发回复。
- 图片消息:请参阅 功能 中的 Marketplace-bot 状态;入站图片处理不可靠(有正在输入指示器但无最终回复)。
- 贴纸:请参阅 功能 中的 Marketplace-bot 状态。
- 语音笔记 / 音频文件 / 视频 / 通用文件附件:请参阅 功能 中的 Marketplace-bot 状态。
- 不支持的类型:已记录(例如,来自受保护用户的消息)。
功能
此表总结了 OpenClaw 中当前的 Zalo Bot Creator / Marketplace bot 行为。| 功能 | 状态 |
|---|---|
| 私信 | ✅ 支持 |
| 群组 | ❌ Marketplace bot 不可用 |
| 媒体(入站图片) | ⚠️ 受限 / 请在您的环境中验证 |
| 媒体(出站图片) | ⚠️ 未针对 Marketplace bot 重新测试 |
| 文本中的纯 URL | ✅ 支持 |
| 链接预览 | ⚠️ 对于 Marketplace bot 不可靠 |
| 回应 | ❌ 不支持 |
| 贴纸 | ⚠️ Marketplace bot 无客服回复 |
| 语音笔记 / 音频 / 视频 | ⚠️ Marketplace bot 无客服回复 |
| 文件附件 | ⚠️ Marketplace bot 无客服回复 |
| 话题 | ❌ 不支持 |
| 投票 | ❌ 不支持 |
| 原生命令 | ❌ 不支持 |
| 流式传输 | ⚠️ 受阻(2000 字符限制) |
投递目标 (CLI/cron)
- 使用聊天 ID 作为目标。
- 示例:
openclaw message send --channel zalo --target 123456789 --message "hi"。
故障排除
Bot 不响应:- 检查令牌是否有效:
openclaw channels status --probe - 验证发送者已获批准(配对或 allowFrom)
- 检查网关日志:
openclaw logs --follow
- 确保 Webhook URL 使用 HTTPS
- 验证密令为 8-256 个字符
- 确认网关 HTTP 端点在配置的路径上可访问
- 检查 getUpdates 轮询是否未运行(它们互斥)
配置参考 (Zalo)
完整配置:配置 扁平的顶级键(channels.zalo.botToken、channels.zalo.dmPolicy 等)是旧版单账户简写形式。对于新配置,建议使用 channels.zalo.accounts.<id>.*。由于这两种形式都存在于架构中,因此此处均保留文档。
提供商选项:
channels.zalo.enabled:启用/禁用渠道启动。channels.zalo.botToken:来自 Zalo Bot 平台的 Bot 令牌。channels.zalo.tokenFile:从常规文件路径读取令牌。拒绝符号链接。channels.zalo.dmPolicy:pairing | allowlist | open | disabled(默认:配对)。channels.zalo.allowFrom:私信允许列表(用户 ID)。open需要"*"。向导会要求输入数字 ID。channels.zalo.groupPolicy:open | allowlist | disabled(默认:允许列表)。存在于配置中;有关当前 Marketplace-bot 行为,请参阅 功能 和 访问控制(群组)。channels.zalo.groupAllowFrom:群组发送者允许列表(用户 ID)。未设置时回退到allowFrom。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>.groupPolicy:每个账户的群组策略。存在于配置中;有关当前 Marketplace 机器人的行为,请参阅功能和访问控制(群组)。channels.zalo.accounts.<id>.groupAllowFrom:每个账户的群组发件人允许列表。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。
本页面源自 openclaw/openclaw,由 BeaversLab 翻译,遵循 MIT 协议 发布。