メインコンテンツへスキップ
GOWA は、メッセージ、レシート、受信するすべてのWhatsAppイベントのURLにJSONドキュメントを投稿します。 リアクション、編集、削除、インジケータ入力、グループ変更、ラベル、ニュースレターや通話。 Webhook登録エンドポイントがありません。起動時またはデバイスごとに、/devices/{device_id}/webhook を使用してWebhookを設定します。

配送方法

各ターゲット URL はそれぞれ個別にシークレットとリトライで配信されます。

設定

同等のフラグ: --webhook, --webhook-secret, --webhook-events, --webhook-ignore-jids, --webhook-insecure-skip-verify, and --webhook-all-device-receipts 明示的に秘密の署名キーを設定します。 未設定のキーまたは古い公開された値 secret を使用すると、GOWA は再起動時に変更され警告を記録するランダムなキーを生成します。 受信者は再起動時に署名を検証するために明示的な共有鍵を必要とします。HTTPS 証明書はデフォルトで検証されます。

イベント

許容リストのイベント名は大文字と小文字を区別しません。

積載量

すべてのリクエストには同じエンベロープがあります:
返信は replied_to_id と quoted_body を追加します。レシートは ids (配列) と receipt_type を使用します。 グループ参加イベントは chat_id 、 type 、 jids を持ちます。グループ名の変更は別の group.info 形式を使用します。 sender_display_name は from が空でない文字列の場合にのみ表示されます。 別の送信者の場合は、保存された連絡先名、ライブイベントのプッシュ名、保存されたプッシュ名、ビジネス名、JIDユーザーの方をお選びいただけます。 アクティブなアカウントでは、アカウントのプッシュ名、JID IDを好みます。 解決策は最善の努力です。従来の from_name はメッセージイベントのプッシュ名のままです。 WhatsAppが認証された名前証明書を提供する場合、受信メッセージにはis_business: true、verified_name、および verified_levelを含めることができます。これらのフィールドはそれ以外の場合は省略されます。 送信者がビジネスであるかどうかは不在であり、公式バッジの保証ではなく、 verified_level は生の上流の値です。

メディア

WHATSAPP_AUTO_DOWNLOAD_MEDIA=true(デフォルト)では、メディアはstatics/media/に保存され、メディアフィールドはパスを保持します。
キャプションがある場合、フィールドは {"path": "...", "caption": "..."} となり、キャプションは body にも含まれます。自動ダウンロードが無効の場合は {"url": "https://mmg.whatsapp.net/...", "caption": "..."} となります。後から GET /message/{message_id}/download?phone=<chat> でファイルを取得してください。 ペイロードの全一覧(投票、位置情報、連絡先、一度だけ表示、広告経由の参照情報など)は、アップストリームの Webhook ペイロードリファレンスを参照してください。

アルバムと構造化メッセージ

複数の message イベントとしてアルバムが届きます。ヘッダーにはメッセージ本文がなく、期待されるアイテム数が含まれています。
それぞれの写真やビデオは album_id: "ALBUM_HEADER_ID" で通常のメディア・イベントに届きます。 そのIDでグループ項目。ヘッダーはダウンロード可能なメディア項目ではなく、Chatwootに転送されません。 投票の作成、投票、編集、追加オプションは message を使用します。body に頼るのではなく、構造化された poll オブジェクトを調査します。 オプションハッシュは、正確なオプション名の小文字の16進SHA-256ハッシュです。既存のWHATSAPP_WEBHOOK_EVENTS=messageサブスクリプションはこれらの相互作用を受け取ります。

オンラインとオフラインの存在

イベントを受信する同じデバイスを使用して、個々の連絡先ごとに購読する:
成功したレスポンスには results.subscribed: true と results.jid が含まれています。グループとニュースレターの JID は拒否されます。 サブスクリプションは、デバイスのプレゼンス設定を上書きしません。継続的なアップデートの場合は、以下のようにGOWAを開始してください。
デフォルトのプレゼンスパルスは、デバイスが利用できない状態にマークすることで終了し、連絡先のプレゼンスの更新が停止します。 利用可能なデバイスをマークすると、それが実行中のWhatsAppプッシュ通知を抑制します. 連続トラッキングを有効にする前に、このトレードオフのためのアカウント.
state は available または unavailable です。last_seen は、連絡先のプライバシー設定で不明または非表示になった場合は省略されます。 from_lidは該当する場合に含まれます。入力と記録は別個のchat_presenceイベントのままで、このサブスクリプションは使用しません。

グループ名の変更

name_set_byは、可能な場合はLIDから電話JIDに解決され、WhatsAppが俳優を特定しない場合は省略されます。 イベントが他のイベントを除外する場合は、明示的に group.info を購読します。

ニュースレターカウンターの更新

newsletter.message は新しい投稿の本文ではなくライブカウンターを報告します。エントリーには常にserver_idが含まれます。 message_id、type、timestampはWhatsAppが提供していない場合は省略されます。ゼロまたは欠席カウンターは省略できます。
利用可能な場合、reaction_countsにはWhatsAppのリアクションカウントが含まれます。 ニュースレターIDとサーバーIDで更新を消費します。欠落しているカウンターをゼロにリセットしないでください。

アカウントの制限とログアウト

デバイスイベントは常に session_id を持ち、同じWhatsApp番号を使用するスロットは区別可能です。このイベントでは発光スロットのWebフック設定を使用します。 リモートログアウトは、再ペアリングのためのスロットを保持し、ログアウト前からIDを報告します。 スロットのWebhook設定は再ペアリングのまま残ります。これらのイベントはChatwootには送信されません。
コードは変更されずに転送され、理由のテキストは whatsmeow から来ています。未知のコードはまだ届いています。 403と406だけでログアウトコードは正確な原因を確立しません。 一時的な禁止期間は、WhatsAppが期限切れを与えなかったことを意味します。リーチアウトタイムロックは新しいチャットを開始し、送信エラー463を発生させる可能性があります。

署名の確認

それぞれのリクエストには X-Hub-Signature-256: sha256=<hex>、webhookシークレット付きのraw リクエストボディの HMAC-SHA256 が含まれます。 JSON を解析する前に、受信した正確なバイト数を計算します。

配信と再試行

  • それぞれの試みは10秒後に繰り返されます。
  • 2xx以外の応答またはネットワークエラーは再試行されます。 GOWAは5回の試行を行い、1秒、2秒、4秒、8秒の試行を行います。 イベントハンドラーのコンテキスト期限は、すべての試行が完了する前に配信を停止することができます。
  • 最後の失敗後、イベントは削除され、記録されます。永続的なキューまたはデッドレターストアはありません。
  • いくつかのURLが独立して配信されます。
イベントをあなた自身の耐久性のある処理キューに受け入れた後、2xxに対応します。再試行されたイベントが複数回到着する可能性があるため、ハンドラを無防備にします。

リンクされたデバイスの領収書を表示する

既定では、GOWAはプライマリデバイスからの連絡先確認を転送し、重複を軽減します。 すべてのデバイスから現在のアカウントのreadとread-selfレシートが渡されます。 これらの領収書については、payload.fromはアカウントJIDで、payload.idsは読み込まれたメッセージを識別します。 連絡先の電話がオフラインの場合を含め、リンクされたデバイスから連絡先のレシートを受け取るには、WHATSAPP_WEBHOOK_ALL_DEVICE_RECEIPTS=true または --webhook-all-device-receipts=true を設定してください。 CLI フラグは明示的な false を含む環境を上書きします。 このオプトインは、重複またはオーダー外の確認を生成することができます。アカウント、チャット、およびメッセージ ID ごとに同期的に更新を適用します。 古いレシートが到着したときに配信される読み取りメッセージをダウングレードしないでください。メッセージIDと送信者JIDはデバイスのサフィックスなしで標準的なフォームを保持します。

予定をフィルター

型順: WHATSAPP_WEBHOOK_EVENTS=message,message.ack はこれらのイベントのみを転送します。 チャットまたは送信者: WHATSAPP_WEBHOOK_IGNORE_JIDSはchat_id、from、chat_lid、from_lidにマッチします。 @で始まるエントリは、アドレス空間全体(@g.us、@s.whatsapp.net、@lid)のワイルドカードです。
@s.whatsapp.net もグループメッセージと一致します。fromはユーザーJIDです。グループをミュートするには@g.usを使用します。 2つのフィルタの組み合わせ: イベントは、そのタイプが許可されている場合にのみ送信され、そのJIDは無視されません。

デバイス毎のWebhook数

スロットに独自のWebhook、シークレット、およびイベント許可リストを与えます:
同じフィールドは POST /devices で受け付けられています。GET /devices/{device_id}/webhook で現在の設定を読んでください。"webhook_url": "" でクリアしてください。 空のデバイス webhook_secret または webhook_events は対応するグローバル設定に戻ります。保存されているデバイス webhook_insecure_skip_verify ブール値はグローバル設定に置き換えられます。 特に、false は、グローバルバイパスが有効な場合でも証明書の検証が有効になります。 デフォルトでは、デバイス毎のURLを置き換え、そのスロットにグローバルなWHATSAPP_WEBHOOKを置き換えます。 WHATSAPP_WEBHOOK_DEVICE_MERGE_GLOBAL=trueでは、代わりにグローバルURLに追加されます。デバイスURLはデバイスのシークレットと許可リストを使用します。 グローバルURLはグローバルURLを保持し、両方に存在するURLはイベントを一度受信します。 無視する JID ルールは両方に適用されます。

ローカルテスト

ローカルの受信者をトンネル(例えば ngrok http 8080)で公開し、WHATSAPP_WEBHOOK をトンネル URL に設定します。 --debug=trueでは、GOWAは配達の試行と失敗ごとにログを記録します。

イベントを受け取るその他の方法

  • WebSocket at /ws?device_id=<id> は、ペアリングとステータスイベントをダッシュボードのクライアントにプッシュします。メッセージ配信にWebhookを使用します。
  • ポーリング: GET /chats と GET /chat/{chat_jid}/messages はGOWAのローカルチャットストレージを読み込みます。Receiving messagesを参照してください。