正常性

/v1/health

WhatsApp Business APIクライアントのステータスを、healthノードで確認します。このノードは、ゲートウェイの正常性をサンプリングし、JSON応答を返信します。

リクエスト

GET /v1/health

応答

応答は、ゲートウェイの正常性のステータスを提供します。

1つのインスタンス

{
    "health": {
       "gateway_status": "connected | connecting | uninitialized | unregistered"
    }
}

ハイアベイラビリティ/マルチコネクト

{
    "health": {
      "your-hostname1:your-container-id1": {
          "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
          "role": "primary_master | secondary_master | coreapp"
      },
      "your-hostname2:your-container-id2": {
          "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
          "role": "primary_master | secondary_master | coreapp"
      },
    }
}

パラメーター

名前説明

health

healthオブジェクトには、WhatsApp Business APIクライアントの正常性を記述するフィールドが含まれています。

Object

gateway_status

CoreappとWhatsAppサーバー間の接続のステータス。
値:

  • connected, connecting — 正常です。
  • uninitialized — アプリはデータベーススキーマのアップグレードまたは初期化プロセス中である可能性があります。数分待ってから再試行してください。このステータスが引き続き表示される場合は、WhatsAppサポートに連絡してください。
  • unregistered — WhatsApp Business APIクライアントを登録する必要があります。詳細については、登録のドキュメントをご覧ください。

String

role

ハイアベイラビリティ/マルチコネクト設定でのコンテナの役割
: primary_mastersecondary_mastercoreapp
これらの設定の詳細については、アベイラビリティとスケーリングのドキュメントをご覧ください。

String