Consultar status da instância

Amb. de Produção

https://api.way-api.io

GET

/instances/{instanceId}/status

Última modificação:2026-07-22 01:30:53

Retorna o estado de conexão da instância e o número persistido.

Regras:

connected = true apenas quando o runtime estiver com status connected

phoneNumber vem do número salvo na instância e pode ser null

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,
    "phoneNumber": null
}

Modificado em 2026-07-22 01:30:53