Consultar status da instância

Amb. de Desenv.

http://localhost:3000

GET

/instances/{instanceId}/status

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

Respostas

🟢200OK

application/json

The request has succeeded.

Body

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🔴502Gateway Inválido

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://localhost:3000/instances//status' \
--header 'x-api-key: <api-key>'

Response Example

200 - Instância desconectada

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

Modificado em 2026-04-17 20:31:44

Página anterior

Desconectar instância

Próxima página

Enviar mensagem com imagem