Contar conversas
GET /chats/count
Devolve quantas conversas a inbox tem, no total e por estado, etiqueta, tag do lead e atendente. Em cada grupo, total é o número de conversas e unread, quantas delas têm mensagem não lida.
Os números são mantidos pela api, sem consultar o WhatsApp. As listas vêm vazias quando não há etiquetas ou atendentes.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Respostas
{
"200": {
"description": "Os contadores.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"total_chats",
"open_chats",
"archived_chats",
"group_chats",
"blocked_chats",
"label_counts",
"attendant_counts",
"tag_counts"
],
"properties": {
"total_chats": {
"type": "object",
"required": [
"total",
"unread"
],
"properties": {
"total": {
"type": "integer",
"format": "int64",
"description": "Quantas conversas."
},
"unread": {
"type": "integer",
"format": "int64",
"description": "Quantas delas têm mensagem não lida."
}
},
"description": "As conversas fora do arquivo (o \"Tudo\" do WhatsApp). As arquivadas contam só em `archived_chats`."
},
"open_chats": {
"type": "object",
"required": [
"total",
"unread"
],
"properties": {
"total": {
"type": "integer",
"format": "int64",
"description": "Quantas conversas."
},
"unread": {
"type": "integer",
"format": "int64",
"description": "Quantas delas têm mensagem não lida."
}
},
"description": "Conversas com atendimento aberto."
},
"archived_chats": {
"type": "object",
"required": [
"total",
"unread"
],
"properties": {
"total": {
"type": "integer",
"format": "int64",
"description": "Quantas conversas."
},
"unread": {
"type": "integer",
"format": "int64",
"description": "Quantas delas têm mensagem não lida."
}
},
"description": "Conversas arquivadas."
},
"group_chats": {
"type": "object",
"required": [
"total",
"unread"
],
"properties": {
"total": {
"type": "integer",
"format": "int64",
"description": "Quantas conversas."
},
"unread": {
"type": "integer",
"format": "int64",
"description": "Quantas delas têm mensagem não lida."
}
},
"description": "Conversas de grupo."
},
"blocked_chats": {
"type": "object",
"required": [
"total",
"unread"
],
"properties": {
"total": {
"type": "integer",
"format": "int64",
"description": "Quantas conversas."
},
"unread": {
"type": "integer",
"format": "int64",
"description": "Quantas delas têm mensagem não lida."
}
},
"description": "Conversas com contato bloqueado."
},
"label_counts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"name",
"total",
"unread"
],
"properties": {
"id": {
"type": "string",
"description": "O `id` da etiqueta (como em `GET /labels/list` e em `labels` da conversa)."
},
"name": {
"type": "string",
"description": "Nome da etiqueta."
},
"total": {
"type": "integer",
"format": "int64",
"description": "Quantas conversas têm a etiqueta."
},
"unread": {
"type": "integer",
"format": "int64",
"description": "Quantas delas têm mensagem não lida."
}
}
},
"description": "Uma linha por etiqueta (as sem nome não aparecem)."
},
"attendant_counts": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"total",
"unread"
],
"properties": {
"id": {
"type": "string",
"description": "Id do atendente."
},
"name": {
"type": "string",
"description": "Nome do atendente."
},
"total": {
"type": "integer",
"format": "int64",
"description": "Quantas conversas estão atribuídas a ele."
},
"unread": {
"type": "integer",
"format": "int64",
"description": "Quantas delas têm mensagem não lida."
}
}
},
"description": "Uma linha por atendente do CRM."
},
"tag_counts": {
"type": "array",
"description": "Uma linha por tag do lead em uso (sem diferença de maiúsculas, como o filtro `tag` de `GET /chats`), arquivadas incluídas. Para o total de cada coluna do kanban.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"total",
"unread"
],
"properties": {
"name": {
"type": "string",
"description": "A tag, como em `lead.tags`."
},
"total": {
"type": "integer",
"format": "int64",
"description": "Quantas conversas têm a tag."
},
"unread": {
"type": "integer",
"format": "int64",
"description": "Quantas delas têm mensagem não lida."
}
}
}
}
}
}
}
}
},
"401": {
"description": "Token inválido ou ausente.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unauthorized",
"message": "Token inválido."
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
},
"501": {
"$ref": "#/components/responses/CloudUnsupported"
}
}
Estado: Disponível
Compatibilidade de canais
| Canal | Compatível | Observação |
|---|---|---|
| WhatsApp (Web) | Sim | |
| WhatsApp (API oficial) | Não | Só no WhatsApp Web: a API oficial não tem a lista de conversas do celular. |
| Não | ||
| Messenger | Não | |
| Telegram | Não |
Eventos que esta rota gera
Nenhum. Esta rota não gera evento no webhook (nem em GET /events): o resultado vem só na resposta.
Antes e depois (uazapi → Orkesio)
Na uazapi: GET /chat/totalcount.
GET /chats/count, mesmo formato.
#/components/schemas/OrkesioError
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
},
"message": {
"type": "string",
"description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
},
"field": {
"type": "string",
"description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
}
},
"required": [
"error",
"message"
],
"additionalProperties": true,
"description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}
#/components/responses/RateLimited
{
"description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
"headers": {
"Retry-After": {
"description": "Segundos até poder chamar de novo.",
"schema": {
"type": "integer",
"minimum": 1
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "rate_limited",
"message": "Muitas requisições."
}
}
}
}
#/components/responses/InternalError
{
"description": "`internal_error`: falha inesperada na api (no banco, por exemplo); tente de novo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "internal_error",
"message": "Falha inesperada."
}
}
}
}
#/components/responses/CloudUnsupported
{
"description": "`unsupported_for_channel`: o canal da inbox não atende esta rota (rota só do WhatsApp Web numa inbox oficial, ou rota da API oficial numa inbox do WhatsApp Web). O canal está em `Inbox.channel`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unsupported_for_channel",
"message": "Esta rota não está disponível no canal da inbox."
}
}
}
}
Guias relacionados
Visão geral · O que funciona em cada canal · O que muda da uazapi