メインコンテンツへスキップ
GOWAは、そのAPIでWhatsAppチャンネルニュースレターを呼び出します。このページのすべてのリクエストは基本認証とX-Device-Idによって選択されたログインデバイスを使用します。 チャンネル ID は @newsletter で終わります; 連絡先番号またはグループ JID はチャンネル ID ではありません。 curl サンプルを実行する前にサーバーの URL と認証情報を設定します。リモートサーバーの HTTPS URL を使用し、設定された場合は APP_BASE_PATH を含めます。

チャンネルを検索

newsletter_id または invite のいずれかでチャンネルメタデータを検索します。正確なものを提供します。招待は完全な https://whatsapp.com/channel/... リンクまたはコードにすることができます。
results には、ID、スレッドメタデータ、ビューアーメタデータを含むチャンネルメタデータが含まれています。招待されたルックアップは、チャンネルをフォローせずにパブリックメタデータをサポートします。 JIDの検索は、選択したアカウントのチャンネルへのアクセスに依存します。viewer_metadataは、WhatsAppが公開メタデータのみを提供する場合、nullになります。 ディレクトリを参照するには、少なくとも1つの国コードを指定してください。名前で検索するには、 search_text を使用します。
ディレクトリ応答は、results.data にチャンネルを配置します。ディレクトリは文書化されていないWhatsAppクエリを使用し、GOWAとは独立して変更できます。

フォローまたはフォロー解除

POST /newsletter/unfollow と同じJSONボディを使用してフォローを解除します。GET /user/my/newsletters リストのニュースレターと選択したアカウント。 チャネルのフォローとライブエンゲージメントアップデートの購読は別々の操作です。/newsletter/live-updates でライブサブスクリプションを管理します。

メッセージとカウンターの読み取り

GET /newsletter/messagesは、WhatsAppから直接投稿を読み取ります。利用可能な履歴はWhatsAppによって制御されます。 GOWAは、保存ウィンドウやアーカイブの完了を保証するものではありません。count のデフォルトは 50 で、1–100 を受け付けます。 古い投稿をロードするには、before として返されたserver_id を渡します。 results.data には、server_id、message_id、type、timestamp、text、views_count、forwards_count、および任意の reaction_counts を持つ投稿が含まれます。コンテンツのフィールドは存在しない場合があります。WhatsApp はチャンネル管理者に閲覧数を報告します。他のアカウントには views_count: 0 と表示されることがあります。 ペジネーションやメディアのダウンロードには message_id ではなく server_id を使用してください。
GET /newsletter/message-updates は、メッセージの内容を取得せずにカウンターを更新します。after は必須で、正のサーバー ID を指定する必要があります。count のデフォルトは 50、最大値は 100 です。任意の since は、秒単位の非負の Unix タイムスタンプです。結果は同じ results.data のリスト形式を使用し、WhatsApp が返さないコンテンツフィールドは省略されます。

ライブカウンターの更新を受け取る

webhook を設定し、必要なチャンネルに各デバイスを登録します。
レスポンスの results には newsletter_id 、 duration_seconds 、 expires_at 、 renewed_at 、 オプションの last_error が含まれます。 WhatsAppは約90秒で観察された短いサブスクリプションを付与します。GOWAは有効期限前と再接続後にそれを更新します。カウンターイベントはnewsletter.messageのWebhookとして到着します。 GET /newsletter/live-updates のサブスクリプションを一覧表示します。results.data には同じステータスフィールドが含まれています。更新に失敗すると last_error を検査します。
サブスクリプションを削除すると更新が停止します。WhatsAppは、既存のグラントが期限切れになるまで更新を引き続き配信できます。 再接続または機内更新によってキャンセルが復活しません。サブスクリプションがないチャネルを削除すると検証エラーが返されます。
サブスクリプションはメモリ内に保持され、サーバーの再起動には耐えられません。GOWAを再起動した後に再作成してください。サブスクリプション状態は選択したデバイスに属します。

チャンネルメディアをダウンロード

このエンドポイントは、対象の投稿を WhatsApp から直接取得し、対応するメディアをサーバーのメディアディレクトリに保存します。JSON の results には、server_id、message_id、status、media_type、mime_type、filename、file_path、file_url、file_size が含まれます。REST ハンドラーは、保存したファイルの公開静的 URL を file_url として返します。バイナリファイルを返すレスポンスではありません。投稿が存在しない場合や、ダウンロード可能なメディアが投稿にない場合は、エラーが返されます。