API Local da Plataforma do WhatsApp Business

Integridade

/v1/health

Use o nó health para verificar o status do cliente da WhatsApp Business API.

Antes de começar

O nó health é compatível com a autenticação por token de portador e chaves de API.

Chaves de 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.

Restrições

A chave de API definida deve ter no mínimo 12 e no máximo 128 caracteres.

Recuperação

Faça uma chamada GET para esse nó a fim de recuperar o status do cliente da WhatsApp Business API.

Exemplo

Solicitação:

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

A resposta fornece o status de integridade do gateway ao servidor do WhatsApp. Se o cabeçalho Authorization não estiver presente ou for inválido, um código de erro 401 será exibido.

Instância única

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

Alta disponibilidade/multiconexão

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

No modo Alta disponibilidade, apenas um Coreapp será conectado ao servidor do WhatsApp. Todos os outros nós, incluindo o Master principal, terão um gateway_status de disconnected. No modo Multiconexão com X fragmentos, X Coreapps, além do Mestre principal, serão conectados ao servidor do WhatsApp.

Parâmetros

NomeDescrição

health

tipo: objeto

Contém os campos que descrevem a integridade do cliente da WhatsApp Business API.

gateway_status

tipo: string

Status da conexão entre o Coreapp e os servidores do WhatsApp.


Valores compatíveis:

  • connected, connecting – A integridade é satisfatória.
  • uninitialized – O app pode estar no processo de atualização ou inicialização do esquema de banco de dados. Tente novamente em alguns minutos. Se você continuar vendo esse status, entre em contato com o Suporte do WhatsApp.
  • unregistered – Você precisa registrar o seu cliente da WhatsApp Business API. Para saber mais, consulte a documentação sobre registro.
  • disconnected – O Coreapp não está conectado aos servidores do WhatsApp.

role

tipo: string

A função do contêiner nas configurações de alta disponibilidade/multiconexão. Para saber mais sobre essas configurações, consulte a documentação sobre disponibilidade e dimensionamento.


Valores compatíveis:primary_master, secondary_master e coreapp