メインコンテンツへスキップ

ベースURL

デフォルトは http://localhost:3000 です。APP_BASE_PATH=/gowa の場合、/health を除くすべてのルートは /gowa の下に移動します。

認証

APP_BASIC_AUTHが設定されている場合、/health、/statics/*、Chatwootウェブフック、MCP OAuthエンドポイントを除くすべてのルートでHTTPベーシック認証が必要になります。 Authentication を参照してください。

デバイス選択

ほとんどのルートは、1つのWhatsAppデバイス上で動作します。X-Device-Idヘッダー(スロットIDまたはJID)またはdevice_idクエリパラメータで選択します。 サーバーが正確に1つのデバイスを持っている場合は、それを省略することができます。 Multi-device を参照してください。

エンドポイントグループ

このタブのエンドポイントページはGOWAのOpenAPI仕様から生成されます。権威あるコントラクトは、サーバーリポジトリのdocs/openapi.yamlです。 このサイトは openapi.yml で同期されたコピーを使用しており、/send/interactive を含みます。interactive guide は現在の制限を記録します。

リクエスト

  • JSON body: Content-Type: application/json 。
  • ファイルアップロード: multipart/form-data 。
  • 電話番号: 国コード (628123456789) または完全な JID (...@s.whatsapp.net, ...@g.us) の桁数。

回答

code は SUCCESS またはエラーコードです。results はデータを保持しています。 Errors を参照してください。

例

連絡先名

GET /user/my/contacts は各コンタクトの表示名を返します。GOWA main after v9.9. で保存されている full_name 、 first_name 、 push_name 、 business_name を個別のフィールドとして取得するには、 GET /user/my/contacts/detailed を呼び出します。 GOWAは空の名前を省略し、デバイスにマッピングがある場合は電話番号のJIDにlidを含みます。 結果には、選択したデバイスの連絡先がjidでソートされています。

その他のインターフェース

  • WebSocket の /ws でライブダッシュボードイベントを表示します。
  • MCP at /mcp for AI agents (MCP server).
  • Webhooks があなたの URL (Webhooksにプッシュしました。