API On-Premises della piattaforma WhatsApp Business

Piattaforma WhatsApp Business > API On-Premises > Riferimento

Health

/v1/health

Usa il nodo health per verificare dello stato del client dell'API di WhatsApp Business.

Prima di iniziare

Il nodo health supporta l'autenticazione con bearer token e chiavi dell'API.

Chiavi dell'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.

Limiti

La chiave dell'API impostata deve contenere un minimo di 12 caratteri e un massimo di 128 caratteri.

Recupero

Effettua una chiamata GET a questo nodo per recuperare lo stato del client dell'API di WhatsApp Business.

Esempio

Richiesta:

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

La risposta fornisce lo stato dell'integrità del gateway al server WhatsApp. Se l'intestazione Authorization non è presente o non è valida, viene restituito il codice di errore 401 .

Istanza singola

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

High Availability/Multiconnect

{
    "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"
      },
    }
}

In modalità High Availability, solo un Coreapp sarà connesso al server WhatsApp, tutti gli altri nodi, compreso il Master primario, avranno un gateway_status di disconnected. In modalità Multiconnect con X shard, X Coreapp saranno connessi al server WhatsApp, come anche il Master principale.

Parametri

NomeDescrizione

health

tipo: oggetto

Contiene i campi che descrivono l'integrità del client dell'API di WhatsApp Business.

gateway_status

tipo: stringa

Stato della connessione tra i server Coreapp e WhatsApp.


Valori supportati:

  • connected, connecting : buono stato.
  • uninitialized : l'applicazione potrebbe essere in fase di aggiornamento o inizializzazione dello schema del database. Riprova tra qualche minuto e contatta l'assistenza di WhatsApp se continui a visualizzare questo stato.
  • unregistered : devi registrare il client dell'API di WhatsApp Business. Consulta la documentazione sulla registrazione per maggiori informazioni.
  • disconnected : Coreapp non connesso ai server WhatsApp.

role

tipo: stringa

Ruolo del contenitore in configurazioni High Availability/Multiconnect. Consulta la documentazione su availability e scaling per maggiori informazioni su queste configurazioni.


Valori supportati: primary_master, secondary_master, coreapp