Visão geral do CRM
As ferramentas de gestão do atendimento do PEPINO ZAP — relatórios, etiquetas, justificativas de encerramento, equipe e permissões, e o construtor de chatbot. O que cada recurso é, onde fica no painel e quais endpoints o expõem.
Além de conectar números e enviar mensagens, o PEPINO ZAP é um CRM de atendimento: as conversas recebidas viram um Inbox compartilhado pela equipe, com status, atribuição a atendentes, etiquetas, justificativas de encerramento, relatórios de gestão e um construtor de chatbot. Esta seção documenta o que cada recurso faz, o modelo de dados por trás dele e como consumi-lo pela API — para quem quer automatizar a gestão a partir do próprio sistema.
Tudo aqui é escopado ao Projeto da sua API key e respeita o modo (Teste/Produção) do host,
igual ao resto da API. Os endpoints citados usam a mesma autenticação por Authorization: Bearer
descrita na Visão geral da API.
O que existe
| Recurso | O que é | No painel | Na API |
|---|---|---|---|
| Relatórios | Métricas de gestão do atendimento (receptivo×ativo, resolvidas, tempo de 1ª resposta, produtividade por atendente). | Gestão → Relatórios | getReportsSummary — guia em Relatórios |
| Etiquetas | Tags coloridas para classificar e filtrar conversas. | Inbox (na conversa) | Etiquetas — guia em Etiquetas e encerramento |
| Justificativas de encerramento | Catálogo de motivos registrados ao resolver uma conversa. | Inbox → Resolver | Justificativas |
| Status e atribuição | Abrir/pendência/resolver e direcionar a conversa a um atendente. | Inbox | setConversationStatus, assignConversation |
| Equipe e permissões | Atendentes, presença (online/offline), permissões granulares e política de roteamento. | Equipe | Gerido pelo painel — modelo em Equipe e permissões |
| Departamentos | Organiza a equipe em departamentos e transfere conversas entre eles (Suporte → Financeiro). | Inbox + Equipe | Departamentos — guia em Departamentos |
| Construtor de fluxo | Chatbot visual que responde automaticamente por número. | Fluxos | Fluxos — guia em Construtor de fluxo |
| Funil configurável | Funil cujas etapas são regras sobre a conversa (origem, status, etiqueta, posição no fluxo). | Funil | Funil — guia em Funil configurável |
Como o Inbox se relaciona com a API de mensagens
O Inbox é a leitura persistida das conversas (veja Inbox — conversas e mensagens); o envio de respostas continua sendo feito pelos endpoints de Mensagens (POST /v1/instances/{id}/messages/...). Os recursos de gestão desta seção operam sobre essas conversas: marcam status, aplicam etiquetas, atribuem atendentes e — no caso do construtor de fluxo — respondem sozinhos antes de um humano assumir.
Por onde começar
- Quero consumir/construir o inbox → Inbox — conversas e mensagens (listar conversas, carregar mensagens e os padrões de uma UI responsiva).
- Quero medir o atendimento → Relatórios (o modelo de dados de cada métrica).
- Quero classificar e encerrar conversas → Etiquetas e encerramento.
- Quero entender atendentes e permissões → Equipe e permissões.
- Quero organizar a equipe em departamentos → Departamentos (vincular atendentes + transferir conversas).
- Quero automatizar respostas (chatbot) → Construtor de fluxo.
- Quero ver o funil de vendas → Funil configurável (etapas por regra sobre a conversa).
WebSocket (tempo real)
Receba os eventos do PEPINO ZAP por uma conexão WebSocket, sem precisar expor um endpoint público — endpoint wss, autenticação por ?token=, envelope dos eventos, ciclo de vida e tratamento de erros.
Inbox — conversas e mensagens
Como consumir o inbox do PEPINO ZAP — listar conversas, carregar mensagens (com histórico paginado) e os padrões para uma interface de chat responsiva — cache por conversa, preservação de URLs de mídia, tempo real por polling ou WebSocket e rolagem para o fim.