要件
- パブリックURL(エージェントリプライ用Webフック用)を介してチャットウッドからGOWAアクセス可能です。
- 管理者アクセスとユーザ API アクセストークンを持つ Chatwoot アカウント。
- 少なくとも1つのログインのWhatsAppデバイス。
設定
1
API チャンネル受信トレイを作成
Chatwoot で 設定 → 受信トレイ → API に移動します。 受信トレイの URL からの数値の 受信トレイID とチャンネルの Webhook シークレット Chatwoot ショーに注意してください。 あるいは、GOWA に受信トレイを作成させてください ( Auto-provisioningを参照してください)。
2
IDとトークンを収集
account ID is the number in
/app/accounts/<id>/... . Copy a user access token from Profile Settings . identifier または hmac_token ではなく、どちらのIDも数値IDでなければなりません。3
GOWAの設定
.env
4
GOWAでのポイントChatwoot
API チャンネルの webhook URL を
https://gowa.example.com/chatwoot/webhook に設定します(APP_BASE_PATH にベースパスを追加します)。 このルートは公開されています。Basic Authではなく、Webhookのシークレットによって保護されています。5
テスト
別の携帯電話からのWhatsApp番号をメッセージ; それは受信トレイに表示されるはずです. Chatwootから返信し、それがのWhatsAppに到着確認します.
設定
ほとんどの設定には
--chatwoot-* フラグがあります。CHATWOOT_URL、CHATWOOT_API_TOKEN、CHATWOOT_ACCOUNT_ID、CHATWOOT_INBOX_IDは環境のみです。設定リファレンスを参照してください。
v9.9.0以降のGOWA main で、CHATWOOT_EVENTS=message を設定すると、通常のWebフック配信を別々にフィルタリングしながら、Chatwootにミラーリングを続けることができます。 message セレクターでは、Chatwoot フィルターを使用してリアクション、レシート、編集、削除を行うこともできます。設定の読み取り、編集、削除はまだ適用されます。
WHATSAPP_WEBHOOK_EVENTS を継承するには、CHATWOOT_EVENTS を空のままにします。有効なフィルタが空の場合、サポートされているすべてのイベントを許可します。 messageを除外すると、GOWAは起動時に警告を記録し、ChatwootにWhatsAppメッセージのミラーリングを停止します。
これらのビルドでは、GOWA は api-access-token ヘッダに Chatwoot ユーザー・トークンを送信するため、nginx はデフォルトのヘッダ設定でそれを渡すことができます。
Webhook secret
空の有効な webhook シークレットが配信を拒否します。CHATWOOT_WEBHOOK_ALLOW_UNSIGNED=true は、効果的なシークレットが空の場合、署名されていない配信を明示的に許可します。 シークレットが設定されている場合、すべてのリクエストは次のいずれかによって証明されなければなりません:
- Chatwoot の署名(
X-Chatwoot-Signature+X-Chatwoot-Timestamp)を推奨します。API チャンネル自身の Webhook シークレットを使用してください。GOWA は<timestamp>.<raw body>の HMAC-SHA256 を検証し、設定された許容範囲外のタイムスタンプを拒否します。 - 体の
X-Hub-Signature-256HMAC X-Chatwoot-Webhook-SecretまたはX-Gowa-Chatwoot-Secretヘッダーのシークレット。- Webhook URLの
?secret=は、署名またはヘッダーを追加できないChatwootバージョンのみです。シークレットはアクセスログに表示されます。
401を返します。GOWAは理由を記録します。signature does not matchは間違った秘密を意味し、timestamp outside the tolerance window はクロックドリフトを意味します。
デバイスの webhook_secret は、デバイスごとの共有エンドポイントとデバイスごとのエンドポイントの両方でそのデバイスのグローバルシークレットを置き換えます。デバイスシークレットがなければ、グローバルシークレットが適用されます。 GOWAは、データの送信、削除、読み取り、書き込みを行う前に、ルーティングされたデバイスの秘密を検証します。 複数のデバイスが同じアカウントと受信トレイIDを使用している場合は、デバイスごとのコールバックURLを優先します。
2xxを受け取った繰り返しChatwood-signedリクエストは200で認識され、タイムスタンプウィンドウ内でスキップされます。 失敗したリクエストは再実行可能です。同じリクエストが進行中の場合、最大30秒後に503を返すことができます。 リプレイメモリはプロセスにローカルであり、再起動時に失われ、65,536個のリクエストに制限されています。GOWAインスタンス間では共有されません。 同じ Chatwoot メッセージの 2 つの別々に署名されたデリバリは、2 回送信できます。 ボディ専用の HMAC 、シークレットヘッダ、およびクエリシークレットは、この配信重複排除を提供しません。
自動プロビジョニング
CHATWOOT_AUTO_CREATE=true と CHATWOOT_INBOX_ID はありません GOWAは起動時にCHATWOOT_INBOX_NAMEという名前のAPI受信トレイを探し、再利用するか、CHATWOOT_WEBHOOK_URLをWebフックとして作成します。
デバイスごとに1つの受信トレイ
環境変数は、すべてのデバイスで共有される1つの宛先を設定します。 各デバイスを独自の受信トレイ、アカウント、またはChatwootサーバーにルーティングするには、デバイスごとの設定を保存します (Basic Authが適用されます):webhook_url(<base>/chatwoot/webhook/<device_id>)が含まれます。これを対象の受信トレイの Webhook に設定してください。その他のルートは、GET /chatwoot/configs、および GET と DELETE /devices/{device_id}/chatwoot/config です。
api_tokenはGOWAのデータベースに保存され、読み取りにマスクされます。webhook_secretは返されません。chatwoot_urlは認証情報なしでHTTPまたはHTTPSでなければなりません。CHATWOOT_ALLOWED_HOSTS、private、loopback、link-local、メタデータアドレスは拒否されます。CHATWOOT_ALLOWED_HOSTS内の明示的に一致するホストは信頼されており、プライベートネットワーク上の自己ホストChatwootをターゲットにすることができます。この許可リストはあなたがコントロールしているホストにのみ設定してください。- 会話がリンクされた後に
chatwoot_url、account_idまたはinbox_idを変更すると409が返されます; 代わりに設定を削除して再作成してください。 - 設定はデバイスペアの前に作成できます。
- 直接データベースのインポートは、環境設定モードでのみ動作します。
返信と書式設定
エージェントが Chatwoot で 返信 を使用する場合 GOWAは、送信デバイスのローカルストアと同じチャットでそれを解決できる場合、元のWhatsAppメッセージを引用します。 これは、テキストとすべての添付ファイルに適用されます, オーディオ-ファイルフォールバックを含みます. キャプションは、最初の添付ファイルにのみ表示されます. インバウンドのWhatsAppメッセージの場合、GOWAはin_reply_to_external_id を WAID:<id> プレフィックスで解決します。 以前のエージェントの返信では、数値の in_reply_to は、同じデバイス、会話、アカウント、受信トレイ、設定内の耐久性のあるメッセージリンクで解決します。 複数の添付ファイルを持つメッセージは最初のファイルを引用符で囲みます.ターゲットが解決できない場合は,返信は引用符なしで配信されます.
受信のWhatsAppはChatwootで参照されたメッセージに応答や反応スレッドを返します. エージェントの返信 Markdown リンクと強調は、読み取り可能なWhatsAppのテキストに変換されています. リスト、改行、およびコードは保持されます。空の署名区切り文字は削除されます。CHATWOOT_SIGN_MSG は変換後にエージェントの名前をプレフィックスします。
適格な公開送信エージェントメッセージのみが送信されます。プライベートノートと除外チャットは転送されません。 GOWAは、設定されたデバイスとアカウント/受信トレイのIDを使用して共有コールバックをルーティングします。デバイス毎のコールバックは明確なルートを提供します。
アンケートとエージェントの削除
v9.9.0以降のGOWAmainでは、Chatwootミラーは作成、編集、追加オプションをポーリングします。 個々の投票を処理するには、WhatsApp webhooksでmessageを購読し、構造化された投票データを読んでください。
これらのビルドでは、CHATWOOT_REVOKE_ON_DELETE=true を設定すると、ChatwootからのみのWhatsAppに削除を同期できます。 削除は、アクティブな Chatwoot 設定の送信メッセージへの耐久性のあるリンクと一致する必要があります。 GOWAは、別々に送信された添付ファイルを含む、各リンクされたWhatsAppメッセージを取り消します. とともに CHATWOOT_FORWARD_DELETES=true , WhatsAppからの削除はまだプライベートノートとして表示されます. 両方向のリンクされたメッセージを削除するには CHATWOOT_MESSAGE_DELETE=true を使用してください。
インポート履歴
days_limit=3 、include_media=true 、および include_groups=true です。 同期はGOWAのローカルチャットストレージを読み込み、バックグラウンドで実行されます。各デバイスは一度に同期を実行できます。
v9.9.0以降のGOWA mainでは、履歴同期が期限切れのメディアを再度アップロードするように電話に要求することができます。電話はオンラインである必要があり、ファイルが保存されている必要があります。 携帯電話が30秒以内に応答しない場合、同期はさらに実行されたメッセージの再アップロード要求をスキップし、メッセージをインポートし続けます。 添付ファイルなしでファイルをインポートできないメッセージがインポートされます。
RESTパスは元のタイムスタンプを設定できません。インポートされたメッセージはインポート時間を取得します。セルフホスティングされたChatwootの場合、CHATWOOT_IMPORT_DB_URIはChatwootのPostgreSQLに直接書き込んで保存します。
v9.9.0以降のGOWA main で CHATWOOT_REOPEN_CONVERSATION=true を使用すると、インポートする新しいメッセージが表示された場合にのみ、履歴同期が解決された会話を再開します。 REST 同期は、投稿前に会話を再開し、再開に失敗した場合は次の同期でチャットを再試行します。 直接PostgreSQLインポートは、メッセージが書かれたのと同じトランザクションで再開します。 この設定がオフの場合、REST 同期は新しいメッセージに対して新しい会話を作成し、直接インポートは解決済みの会話を使用し続けます。
配信と再試行
一時的なChatwootエラーが発生したライブメッセージ (ネットワークエラー) HTTP 429 または 5xx) はローカルストレージでキューに入れられ、バックグラウンドで再試行されます。 その他の4xxエラーは記録およびドロップされます。トラブルシューティング
APP_DEBUG=trueで実行し、Chatwoot:とChatwoot Webhook:で始まるログ行を探します。 上流のChatwoot guideは、直接データベースのインポートとフォーマットのルールをより深くカバーしています。