API de instalaciones locales de la Plataforma de WhatsApp Business

Health

/v1/health

Usa el nodo health para consultar el estado de tu cliente en la API de WhatsApp Business.

Antes de empezar

El nodo health admite la autenticación de tokens Bearer y de las claves de la API.

Claves de la 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.

Limitaciones

La API key que configures debe tener 12 caracteres como mínimo y 128 como máximo.

Recuperar

Haz una llamada GET a este nodo para recuperar el estado de tu cliente de la API de WhatsApp Business.

Ejemplo:

Solicitud

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

La respuesta envía información sobre el estado de la puerta del servidor de WhatsApp. Si el encabezado Authorization falta o no es válido, se devolverá un código de error 401.

Una sola instancia

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

Alta disponibilidad/multiconexión

{
    "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 el modo de alta disponibilidad, se conectará solo una app principal al servidor de WhatsApp; todos los demás nodos, incluido el objeto maestro principal, tendrán un gateway_status de disconnected. En el modo de multiconexión con fragmentos X, las apps principales X se conectarán al servidor de WhatsApp, y el objeto maestro principal también lo hará. Para obtener más información sobre el modo de alta disponibilidad y multiconexión, consulta la guía de disponibilidad y expansión.

Parámetros

NombreDescripción

health

Tipo: objeto

Contiene los campos que describen el estado del cliente en la API de WhatsApp Business.

gateway_status

Tipo: cadena

Estado de la conexión entre la app principal y los servidores de WhatsApp.


Valores admitidos:

  • connected, connecting: el estado es bueno.
  • uninitialized: la app podría estar actualizando o inicializando el esquema de la base de datos. Vuelve a probar en unos minutos y ponte en contacto con el Soporte de WhatsApp si sigues viendo este estado.
  • unregistered: debes registrar el cliente de la API de WhatsApp Business. Consulta la documentación de registro para obtener más información.
  • disconnected: la app principal no está conectada a los servidores de WhatsApp.

role

Tipo: cadena

Rol del contenedor en la configuración de alta disponibilidad y multiconexión. Consulta la documentación sobre disponibilidad y expansión para obtener más información sobre esta configuración.


Valores admitidos: primary_master, secondary_master y coreapp