Visão Geral#
A entidade Modelo representa modelos de mensagens ou documentos usados para automação de comunicações, como mensagens de WhatsApp, vinculados a pipelines e empresas.Estrutura da Entidade#
Campos Principais#
| Campo | Tipo | Descrição | Obrigatório |
|---|
id | number | Identificador único do template | ✅ (auto) |
name | string | Nome descritivo do template | ✅ |
pipeId | number | ID do pipeline associado | ✅ |
companyId | number | ID da empresa proprietária (via pipeline) | ✅ (auto) |
createdAt | DateTime | Data/hora de criação | ✅ (auto) |
updatedAt | DateTime | Data/hora da última atualização | ✅ (auto) |
Relacionamentos#
Funil: Vinculado a um Funil específico.
Empresa: Vinculada à empresa do usuário (via funil).
Atividade: Utilizado em atividades, como envio de mensagens.
Status Disponíveis#
| Status | Descrição |
|---|
active | Template ativo e funcional |
deactivated | Template desabilitado |
Casos de Uso Detalhados#
1. Automação de Mensagens#
Cenário: Uma empresa deseja enviar mensagens automáticas de WhatsApp para negociações em um funil.O usuário cria um modelo com placeholders para personalização.
O modelo é associado a um funil específico.
O sistema preenche variáveis dinâmicas (ex.: nome do cliente) e cria uma atividade de WhatsApp.
Regras de Negócio#
Criação de Templates#
Modelos são únicos por funil.
Vinculação automática à empresa do funil.
Status inicial definido como active.
Controle de Acesso#
Usuários só podem gerenciar modelos de funil de sua empresa.
Isolamento por empresa (multi-tenancy).
Templates desativados não são usados em automações.
Segurança#
Validação de placeholders para evitar erros de formatação.
Exclusão de templates não afeta atividades já criadas.
Operações Disponíveis#
| Operação | Descrição | Método HTTP |
|---|
| Listar | Recupera templates com paginação | GET |
| Criar | Cria um novo template | POST |
| Visualizar | Exibe detalhes de um template específico | GET |
| Atualizar | Modifica o template | PUT/PATCH |
| Excluir | Remove um template | DELETE |
| Preencher | Preenche template com dados da negociação | POST |
Fluxo de Uso#
Segurança e Boas Práticas#
Para Desenvolvedores#
Garantir validação de placeholders para evitar erros de substituição.
Usar transações para criar atividades associadas.
Para Usuários#
Usar nomes descritivos para modelos.
Testar modelos antes de usar em automações.
Desativar modelos não utilizados.
Limitações e Restrições#
Modelos são específicos por funil e empresa.
Não suportam edição direta de atividades geradas.
Modificado em 2025-06-16 17:10:41
