跳转到主要内容
使用 Chatwoot 启用,GOWA 转发WhatsApp 消息(正在导入) 和从手机发送到Chatwoot API 通道的收件箱,并且将来自Chatwoot 的代理回复发送回WhatsApp。 文本、图像、音频、视频、文档、贴纸、位置和联系人都被支持;群聊每个群组显示为一个对话,并且有发件人名称前缀。

B. 所需经费

  • 通过 Chatwoot 可访问公共网址 (适合代理回复Webhooks)。
  • 带有管理员权限的Chatwoot 帐户和用户 API 访问令牌。
  • 至少有一个登入的 WhatsApp 设备。

设置

1

创建 API 频道收件箱

在 Chatwoot 中转到设置 -> 收件箱 -> 添加收件箱 -> API。 请注意收件箱URL中的数字收件箱ID,以及频道中的 webhook 秘密Chatwoot 显示。 或者,让 GOWA 创建收件箱(见 Auto-provisioning)。
2

收集 ID 和令牌

account ID 是 /app/accounts/<id>/... 中的数字。复制用户 Access token 从 Profile 设置 。 两个ID都必须是数字ID,而不是频道 identifier 或 hmac_token 。
3

配置 GOWA

.env
重新启动GOWA:Chatwoot 路由在启动时注册。
4

GOWA地区的交汇点

将 API 通道的 webhook URL 设置为 https://gowa.example.com/chatwoot/webhook (使用 APP_BASE_PATH, 包括基础路径)。 此路由是公开的:它受到webhook 秘密的保护,而不是基本Auth的保护。
5

测试

从另一个手机消息WhatsApp 号码;它应出现在收件箱中。请从Chatwoot 回复,然后检查它到达WhatsApp 上。

配置

大多数设置也有对应的 --chatwoot-* 标志;CHATWOOT_URL、CHATWOOT_API_TOKEN、CHATWOOT_ACCOUNT_ID 和 CHATWOOT_INBOX_ID 只能通过环境变量设置。请参阅配置参考。 在 v9.9.0 之后的 GOWA main 分支上,设置 CHATWOOT_EVENTS=message 可继续将消息同步到 Chatwoot,同时单独过滤普通 webhook 投递。message 选择器还允许表情回应、回执、编辑和删除事件通过 Chatwoot 过滤器。独立的已读、编辑和删除设置仍然生效。 将 CHATWOOT_EVENTS 留空可继承 WHATSAPP_WEBHOOK_EVENTS。如果最终生效的过滤器为空,则允许所有受支持的事件。如果过滤器排除了 message,GOWA 会在启动时记录警告,并停止将 WhatsApp 消息同步到 Chatwoot。 在这些构建中,GOWA会在 api-access-token 标题中发送Chatwoot 用户令牌,因此nginx 可以通过默认标题设置传递它。

Webhook 密钥

一个空有效的 webhook 秘密拒绝交付。CHATWOOT_WEBHOOK_ALLOW_UNSIGNED=true 明确允许在有效的秘密为空时发送未签名的货物。 已配置秘密,每个请求必须由以下之一证明:
  1. Chatwoot 签名(X-Chatwoot-Signature + X-Chatwoot-Timestamp),推荐使用此方式。使用 API 渠道自身的 webhook 密钥。GOWA 会校验 <timestamp>.<raw body> 的 HMAC-SHA256,并拒绝超出所配置容差范围的时间戳。
  2. 尸体的X-Hub-Signature-256HMAC’。
  3. 通过 X-Chatwoot-Webhook-Secret 或 X-Gowa-Chatwoot-Secret 请求头传递密钥。
  4. ?secret=在 webhook 的 URL,仅适用于无法签名或添加标题的 Chatwoot 版本。然后在访问日志中显示秘密。
验证失败时返回 401;GOWA 会记录原因(signature does not match 表示密钥错误,timestamp outside the tolerance window 表示时钟偏差)。 设备的 webhook_secret 在共享和单个设备的端点上替换该设备的全局秘密。如果没有设备保密,则应用全局秘密。 GOWA 在发送、删除、标记读取或写入数据之前验证路由设备的秘密。 当几个设备使用相同的帐户和收件箱ID时,优先使用每个设备的回调URL。 一个重复的 Chatwoot-签名且已经收到了 2xx 的请求通过 200 承认,并在时间戳窗口内跳过了。 失败请求仍然可以重试。一个仍在进行中的相同请求可以在等待30秒后返回 503 。 回放内存是本地的,重启后丢失,与65 536个被接受的请求连接。它不是在 GOWA 实例之间共享的。 两个单独签名发送的Chatwoot 消息仍然可以发送两次。 仅限实体HMAC、秘密信头和查询秘密不会提供这种退货。

自动配置

使用 CHATWOOT_AUTO_CREATE=true 且没有 CHATWOOT_INBOX_ID GOWA 在启动时寻找名为 CHATWOOT_INBOX_NAME 的 API 收件箱,并重新使用它,或者创建一个 CHATWOOT_WEBHOOK_URL 作为其Webhook。

每台设备一个收件箱

环境变量配置所有设备共享的一个目标。 为了将每个设备路由到自己的收件箱、帐户或聊天服务器,存储每个设备的配置(基本认证应用):
响应包含 webhook_url(<base>/chatwoot/webhook/<device_id>);请将其设为该收件箱的 Webhook。其他路由:GET /chatwoot/configs,以及 GET 和 DELETE /devices/{device_id}/chatwoot/config。
一旦存在每台设备配置任何,CHATWOOT_*目标将不再被用作备份。没有配置的设备不会被镜像。
  • api_token 存储在GOWA的数据库中,并已被读取;webhook_secret 永远不会返回。
  • chatwoot_url 必须是 HTTP 或 HTTPS 无凭据。没有 CHATWOOT_ALLOWED_HOSTS 、私有、循环、链接本地和元数据地址被拒绝。 一个在 CHATWOOT_ALLOWED_HOSTS 中的明确匹配主机是受信任的,并且可以在私人网络上针对自己托管的聊天窗口。设置此允许列表仅用于您控制的主机上。
  • 在对话链接返回 409后,更改 chatwoot_url, account_id 或 inbox_id ;删除并重新创建配置。
  • 可以在设备对应之前创建配对。
  • 直接数据库导入仅在单个(环境)配置模式下工作。

回复和格式

当代理人在Chatwoot 使用 回复 时, GOWA 引用原来的 WhatsApp 消息,当它可以在发送设备的本地商店和同一聊天中解决它。 这适用于文本和每个附件,包括音频至文件回退。标题仅保留在第一个附件。 对于入站的 WhatsApp 消息,GOWA 解决了 in_reply_to_external_id 使用 WAID:<id> 前缀。 对于早先的代理回复,数字in_reply_to 会通过同一设备、 对话、 帐户、 收件箱和配置中的持久消息链接解析。 包含多个附件的消息引用了它的第一个文件。如果目标无法解决,则在没有引用的情况下发送回复。 在 Chatwoot 中传入WhatsApp 的回复和反应线程。代理回复Markdown 链接和强调线转换为可读的 WhatsApp 文本。 Lists, line breaks和代码被保留。空签名分隔符被删除。CHATWOOT_SIGN_MSG 前缀着代理人的名称。 只发送合格的公开发出代理消息。私人笔记和排除的聊天不会被传送。 GOWA 使用配置的设备和帐户/收件箱身份来路由共享回调。每次回调提供一个明确的路由。

调查和代理删除

在 GOWA v9.9.0后的 main 上,Chatwoot 镜像投票创建、编辑和添加选项。 要处理单个投票,请在 WhatsApp webhooks 中订阅 message 并读取结构化投票数据。 在这些构建中,设置 CHATWOOT_REVOKE_ON_DELETE=true 只将聊天窗口中的删除同步到 WhatsApp 删除必须匹配有效Chatwoot 配置下发出消息的持久链接。 GOWA 撤销了每个链接的 WhatsApp 消息,包括单独发送的附件。通过 CHATWOOT_FORWARD_DELETES=true, 从WhatsApp 中删除仍然是私人笔记。 使用 CHATWOOT_MESSAGE_DELETE=true 来删除双向链接的消息。

导入历史记录

默认值为 days_limit=3、include_media=true 和 include_groups=true。同步会读取 GOWA 的本地聊天存储,并在后台运行。每个设备同一时间只能运行一个同步任务。 在 GOWA v9.9.0后的main上,历史同步可以让手机重新上传过期的媒体。手机必须在线且仍然有文件。 如果手机未能在 30 秒内回答,同步跳板将继续重新上传请求,并继续导入消息。 文件不可用的消息在没有附件的情况下导入。 REST 路径不能设置原始的时间戳;导入的消息会得到导入时间。对于自托的Chatwoot, CHATWOOT_IMPORT_DB_URI 直接写入和保存到 Chatwoot 的 PostgreSQL 在 GOWA main 上使用 CHATWOOT_REOPEN_CONVERSATION=true 在 v9.9.0后,历史同步只是在有新消息导入时重新打开已解决的对话。 REST 同步在发布之前重新打开对话,如果重新打开失败,则重试下次同步的聊天。 直接导入的 PostgreSQL 导入在同一交易中重新打开消息写入。 关闭设置后,REST 同步会为新消息创建新的对话,而直接导入则会保持使用已解决的对话。

交货和重试

触碰短暂Chatwoot 错误的在线消息 (网络错误) HTTP 429 或 5xxx 队列在本地存储中,然后在后台重试,带有指数后端。 其它4xx错误被记录和丢弃。

故障排除

用 APP_DEBUG=true 运行,寻找以 Chatwoot: 和 Chatwoot Webhook:开头的日志行。 上游的 Chatwoot 指南 涵盖更深的直接数据库导入和格式化规则。