Pular para o conteúdo

Miscellaneous API Routes

Routes menores: notifications, orders, quick-replies, stats, tags, chatbot.


Descrição: Lista as últimas 50 notificações da conta. Inclui contagem de não-lidas. Auth: Required

Response:

  • 200: { notifications: Notification[], unread_count: number }

Descrição: Marca notificações específicas como lidas (por IDs).

Request:

  • Body: { ids: ["uuid", "uuid"] }

Response:

  • 200: { updated: number }

Descrição: Marca uma notificação específica como lida.

Response:

  • 200: { updated: true }

Descrição: Marca todas as notificações não-lidas do usuário como lidas.

Response:

  • 200: { updated: true }

Descrição: Lista pedidos de e-commerce com suporte a filtros e paginação offset-based. Auth: Required

Request:

  • Query params: page, limit, sort, order, platform, financial_status, from, to

Response:

  • 200: { data: EcommerceOrder[], total, page, limit }

Descrição: Lista todas as respostas rapidas da conta. Auth: Required Rate Limit: Custom - 30 req/60s

Response:

  • 200: QuickReply[] (ordenadas por title ascendente)

Descrição: Cria uma nova resposta rapida.

Request:

  • Body: { title: string, content: string, shortcut?: string, category?: string }

Response:

  • 201: QuickReply

Descrição: Atualiza uma resposta rapida existente.

Response:

  • 200: QuickReply (atualizada)
  • 404: Não encontrada

Descrição: Exclui uma resposta rapida permanentemente (hard delete).

Response:

  • 204: No content

Descrição: Retorna overview estatistico com KPIs principais, variação semanal, e conversas recentes. Auth: Required

Response:

  • 200: { totalContacts, activeConversations, messagesToday, totalCampaigns, *Change, recentConversations }

Descrição: Retorna dados para gráficos: mensagens por dia, campanhas recentes e conversas por status. Auth: Required

Request:

  • Query params: period (“7d” | “30d” | “90d”, default “7d”)

Response:

  • 200: { messages_by_day, campaigns_recent, conversations_by_status }

Descrição: Lista todas as tags da conta (limite 100, ordenadas por nome). Auth: Required

Response:

  • 200: Tag[]

Descrição: Cria uma nova tag.

Request:

  • Body: { name: string, color: string (#RRGGBB) }

Response:

  • 201: Tag