WhatsApp Business 平台內部部署 API

健康狀態

/v1/health

使用 health 節點可檢查 WhatsApp Business API 用戶端的狀態。

準備工作

health 節點支援持有人權杖和 API 密鑰驗證。

API 密鑰

If you wish to monitor the health, metrics, and stats nodes from an orchestrator, Bearer tokens are not the best option for ongoing checks as they expire every 7 days. To mediate this, you can use an API key, which can be set using the WA_API_KEY environment variable in the waweb environment section in the .yml file of your installation setup. 
services:
...
  waweb:
  ...
    environment:
    ...
    WA_API_KEY: your-api-key-token
The API key you set must have a minimum of 12 characters and a maximum of 128 characters. The Webapp must be restarted whenever you change the API key.

限制

您設定的 API 密鑰必須至少包含 12 個字元，最多包含 128 個字元。

擷取

請向此節點發出 GET 呼叫，以擷取 WhatsApp Business API 用戶端的狀態。

範例

要求：

GET /v1/health
{
  Authorization: Bearer your-auth-token | Apikey your-api-key-token
}

回應會提供 WhatsApp 伺服器閘道的健康狀態。如果 Authorization 標頭不存在或無效，會傳回 401 錯誤代碼。

單一實例

{
    "health": {
       "gateway_status": "connected | connecting | disconnected | 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"
      },
    }
}

在高可用性模式中，只有一個核心應用程式將連接到 WhatsApp 伺服器，所有其他節點（包括主要主節點）都將處於 disconnected 的 gateway_status。在具有 X 分片的多點連線模式中，X 核心應用程式將連接到 WhatsApp 伺服器，主要主節點也將連接到 WhatsApp 伺服器。如需瞭解高可用性／多點連線模式的詳細資訊，請參閱可用性和調整性指南。

參數

名稱說明

health

類型：物件

包含說明 WhatsApp Business API 用戶端健康狀態的欄位。

gateway_status

類型：字串

核心應用程式與 WhatsApp 伺服器之間的連線狀態。


支援的值：

  • connected、connecting - 健康狀態良好。
  • uninitialized - 應用程式可能正在升級或初始化資料庫架構。請等幾分鐘後再試一次，如果仍然持續此狀態，請聯絡 WhatsApp 支援團隊。
  • unregistered - 您需要註冊 WhatsApp Business API 用戶端。如需詳細資訊，請參閱註冊文件。
  • disconnected - 核心應用程式沒有連接到 WhatsApp 伺服器。

role

類型：字串

高可用性／多點連線設定下容器的角色。如需這些設定的詳細資訊，請參閱可用性和調整性文件。


支援的值：primary_master、secondary_master、coreapp