Consultar status da instância

Amb. de Produção

https://api.way-api.io

GET

/instances/{instanceId}/status

Última modificação:2026-09-17 22:00:23

Informa se a instância está conectada ao WhatsApp.

connected: forma rápida de verificar a conexão.

status: mostra se a instância está connected, connecting ou disconnected.

phoneNumber: telefone conectado, ou null antes da primeira conexão.

Requisição

Authorization

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

Parâmetros de Caminho

Parâmetros Header

🟢200OK

application/json

The request has succeeded.

Bodyapplication/json

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🔴502Gateway Inválido

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.way-api.io/instances//status' \
--header 'x-api-key: <api-key>'

Response Example

200 - Instância desconectada

{
    "connected": false,
    "status": "disconnected",
    "phoneNumber": null
}

Modificado em 2026-09-17 22:00:23