API local de la Plataforma de WhatsApp Business

Estado

/v1/health

Usa el nodo health para comprobar el estado del cliente de la API de WhatsApp Business.

Antes de empezar

El nodo health admite la autenticación de las claves de la API y el identificador de portador.

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.

Restricciones

La clave de la API que definas debe tener un mínimo de 12 caracteres y un máximo de 128.

Recuperación

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

Ejemplo

Solicitud:

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

En la respuesta se proporciona el estado de la puerta al servidor de WhatsApp. Si el encabezado Authorization no está presente o no es válido, se devuelve un código de error 401.

Instancia única

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

Alta disponibilidad o conexión múltiple

{
    "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, solo se conectará una aplicación principal al servidor de WhatsApp y los demás nodos (incluido el maestro principal) tendrán el valor disconnected en el parámetro gateway_status. En el modo de conexión múltiple con X particiones, se conectarán X aplicaciones principales al servidor de WhatsApp y el nodo maestro principal también se conectará a este servidor. Para obtener más información sobre el modo de alta disponibilidad o conexión múltiple, consulta la guía de escalado y disponibilidad.

Parámetros

NombreDescripción

health

Tipo: objeto

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

gateway_status

Tipo: cadena

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


Valores admitidos:

  • connected, connecting: el estado es correcto.
  • uninitialized: la aplicación podría estar actualizando o inicializando el esquema de la base de datos. Vuelve a intentarlo en unos minutos y ponte en contacto con el equipo de asistencia de WhatsApp si sigues viendo este estado.
  • unregistered: debes registrar el cliente de la API de WhatsApp Business. Para obtener más información, consulta la documentación sobre el proceso de registro.
  • disconnected: la aplicación principal no está conectada a los servidores de WhatsApp.

role

Tipo: cadena

Rol del contenedor en las configuraciones de alta disponibilidad o conexión múltiple. Consulta la documentación sobre escalado y disponibilidad para obtener más información acerca de estas configuraciones.


Valores admitidos: primary_master, secondary_master, coreapp