POST
/chat/findListar conversas conhecidas
Não consulta histórico remoto sob demanda. wa_lastMsgTimestamp e wa_lastMessageTime estão em segundos. Sem filtros de lead/etiqueta.
Autenticação
Header obrigatório: token. Use o token da instância.
Base URL: a API do servidor selecionado, como https://1.atendro.cloud. O domínio wpp.atendro.cloud hospeda a documentação e o console.
Headers adicionais
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
X-Request-Id | string | opcional | ASCII visível sem espaços, 1–128 caracteres. Inválido/ausente é substituído por UUID. Ecoado na resposta. Comprimento máximo: 128 |
Corpo da requisição
Formato: application/json. Corpo opcional.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
limit | integer / string | opcional | 0/ausente retorna até 5000. Padrão: 5000 |
offset | integer / string | opcional | Deslocamento da página. |
wa_isGroup | boolean / string / integer / null | opcional | — |
includeLeft | boolean / string / integer / null | opcional | — |
Respostas
Listar conversas conhecidas
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
chats | array<object> | obrigatório | — |
chats[].id | string | obrigatório | — |
chats[].wa_chatid | string | obrigatório | — |
chats[].name | string | opcional | — |
chats[].wa_name | string | opcional | — |
chats[].wa_contactName | string | opcional | — |
chats[].wa_isGroup | boolean | obrigatório | — |
chats[].wa_unreadCount | integer | opcional | — |
chats[].wa_archived | boolean | opcional | — |
chats[].wa_lastMsgTimestamp | integer | obrigatório | Unix em segundos. Formato: int64 |
chats[].wa_lastMessageTime | integer | obrigatório | Unix em segundos. Formato: int64 |
chats[].owner | string | opcional | — |
chats[].phone | string | opcional | Vazio para grupo ou LID sem telefone conhecido. |
chats[].pictureId | string | opcional | — |
chats[].wa_isGroup_announce | boolean | opcional | — |
chats[].participantCount | integer | opcional | — |
chats[].topic | string | opcional | — |
hasMore | boolean | obrigatório | — |
pagination | object | obrigatório | — |
pagination.limit | integer | obrigatório | — |
pagination.offset | integer | obrigatório | — |
pagination.returned | integer | obrigatório | — |
nextOffset | integer | opcional | — |
unauthorized: header ausente, inválido ou duplicado. Bearer/query/instancekey não substituem admintoken/token.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
error | string | obrigatório | — |
message | string | opcional | — |
messageid | string | opcional | ID para reconciliação quando o resultado é ambíguo. |
messageId | string | opcional | — |
id | string | opcional | — |
provider_code | integer | opcional | — |
error_key | string | opcional | — |
error_source | string | opcional | — |
details | object | opcional | — |
instance | object | opcional | Modelo: Instance. |
storage_unavailable (Retry-After=5). Algumas rotas também retornam 502 por falha da conexão/mídia; consultar error.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
error | string | obrigatório | — |
message | string | opcional | — |
messageid | string | opcional | ID para reconciliação quando o resultado é ambíguo. |
messageId | string | opcional | — |
id | string | opcional | — |
provider_code | integer | opcional | — |
error_key | string | opcional | — |
error_source | string | opcional | — |
details | object | opcional | — |
instance | object | opcional | Modelo: Instance. |
Falha; usar HTTP status e error. 404 rota inexistente; 405 método inválido com Allow. Ver catálogo no guia de integração.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
error | string | obrigatório | — |
message | string | opcional | — |
messageid | string | opcional | ID para reconciliação quando o resultado é ambíguo. |
messageId | string | opcional | — |
id | string | opcional | — |
provider_code | integer | opcional | — |
error_key | string | opcional | — |
error_source | string | opcional | — |
details | object | opcional | — |
instance | object | opcional | Modelo: Instance. |