AtomiksAPI
Ver .md

inbox.unread_count

Total de conversas não lidas (badge do menu). Quantas conversas abertas ou em atendimento, entre as que o membro enxerga, têm mensagens não lidas. Arquivadas não entram. archivedCount = total de conversas arquivadas. Contagem direta no banco, barata para consultar a cada minuto.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/inbox.unread_count (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: messages:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: inbox_unread_count
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId inbox.unread_count)

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/inbox.unread_count \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs inbox.unread_count --json '{}'

MCP: ferramenta inbox_unread_count com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "count": {
      "type": "number"
    },
    "archivedCount": {
      "type": "number"
    }
  },
  "required": [
    "count",
    "archivedCount"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).