WhatsApp Business Platform On-Premises API

Health

/v1/health

Verwende den health- Node, um den Status deines WhatsApp Business API-Clients zu überprüfen.

Bevor du beginnst

Der health- Node unterstützt ein Bearer-Token und die API-Schlüssel-Authentifizierung.

API-Schlüssel

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.

Einschränkungen

Der von dir festgelegte API-Schlüssel muss zwischen 12 und 128 Zeichen haben.

Abrufen

Führe einen GET- Aufruf an diesen Node durch, um den Status deines WhatsApp Business API-Clients abzurufen.

Beispiel

Anfrage:

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

Die Antwort liefert den Health-Status des Gateways an den WhatsApp-Server. Wenn der Header Autorisierung nicht vorhanden oder ungültig ist, wird ein Fehlercode 401 zurückgegeben.

Einzelinstanz

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

Hohe Verfügbarkeit/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"
      },
    }
}

Im Hochverfügbarkeits-Modus wird nur die Coreapp mit dem WhatsApp-Server verbunden. Alle anderen Nodes einschließlich des primären Masters verfügen über einen gateway_status„Nicht verbunden“. Im Mulitconnect-Modus mit X Shards werden X Coreapps mit dem WhatsApp-Server verbunden und der primäre Master stellt ebenfalls eine Verbindung zum WhatsApp-Server her.

Parameter

NameBeschreibung

health

Typ: Objekt

Enthält die Felder, die den Zustand des WhatsApp Business API-Clients beschreiben.

gateway_status

Typ: String

Status der Verbindung zwischen der Coreapp und den WhatsApp-Servern.


Unterstützte Werte:

  • Verbunden, Verbindung wird hergestellt – Der Zustand ist gut.
  • Nicht initialisiert – Die Anwendung aktualisiert oder startet möglicherweise gerade das Datenbankschema. Versuche es in einigen Minuten erneut und kontaktiere den WhatsApp-Support, wenn dieser Status weiterhin angezeigt wird.
  • Nicht registriert – Du musst deinen WhatsApp Business API-Client registrieren. Weitere Informationen findest du in der Dokumentation zur Registrierung.
  • „Nicht verbunden“ – Die Coreapp ist nicht mit den WhatsApp-Servern verbunden.

role

Typ: String

Rolle des Containers in Hochverfügbarkeits-/Multiconnect-Setups. Weitere Informationen zu diesen Einrichtungen findest du in der Dokumentation zu Verfügbarkeit und Skalierung.


Unterstützte Werte: primary_master, secondary_master, coreapp