Listar chats da instância

Amb. de Desenv.

http://localhost:3000

GET

/instances/{instanceId}/chats

Lista os chats visíveis para a instância.

Observações:

a instância precisa estar conectada

use o id retornado como targetId nas rotas de mensagens

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

🟠422Erro de Parâmetro

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Lista de chats

{
    "chats": [
        {
            "id": "120363123456789@g.us",
            "name": "Grupo Comercial",
            "isGroup": true
        }
    ]
}

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