API On-Premises de la plateforme WhatsApp Business

État

/v1/health

Utilisez le nœud health pour vérifier le statut de votre client de l’API WhatsApp Business.

Avant de commencer

Le nœud health prend en charge le token Bearer et l’authentification par clés d’API.

Clés d’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.

Contraintes

Vous devez définir une clé d’API comprenant 12 à 128 caractères.

Récupération

Effectuez un appel GET vers ce nœud pour récupérer le statut de votre client de l’API WhatsApp Business.

Exemple

Requête :

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

La réponse indique le statut de la passerelle vers le serveur WhatsApp. Si l’en-tête Authorization est absent ou invalide, un code d’erreur 401 est renvoyé.

Instance unique

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

Haute disponibilité/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"
      },
    }
}

En mode Haute disponibilité, un seul Coreapp est connecté au serveur WhatsApp, tous les autres nœuds, y compris le Maître primaire, ont un gateway_status égal à disconnected. En mode Multiconnect avec X partitions, X Coreapps sont connectés au serveur WhatsApp, ainsi que le Maître primaire.

Paramètres

NomDescription

health

type : objet

Contient les champs qui décrivent l’état du client de l’API WhatsApp Business.

gateway_status

type : chaîne

État de la connexion entre le Coreapp et les serveurs WhatsApp.


Valeurs acceptées :

  • connected, connecting  : état correct.
  • uninitialized  : l’application peut être en train de mettre à niveau ou d’initialiser le schéma de la base de données. Patientez quelques minutes avant de réessayer et contactez l’assistance WhatsApp si le problème persiste.
  • unregistered  : vous devez inscrire votre client de l’API WhatsApp Business. Pour en savoir plus, voir la documentation sur la procédure d’inscription.
  • disconnected  : le Coreapp n’est pas connecté aux serveurs WhatsApp.

role

type : chaîne

Rôle du conteneur dans les configurations Haute disponibilité/Multiconnect. Pour plus d’informations sur ces configurations, voir la documentation sur la disponibilité et la mise à l’échelle.


Valeurs acceptées :primary_master, secondary_master, coreapp