Package Information
Documentation
n8n Community Nodes - Fale Já
Integração completa com a Plataforma Fale Já para n8n
Este é o pacote oficial de community nodes para integrar o Fale Já - Plataforma de Atendimento Moderna com n8n, cobrindo todas as três categorias de APIs: Application, Client e Platform.
🔗 Site Oficial: https://faleja.com.br
🚀 Plataforma: https://app.faleja.com.br
📋 Índice
- Sobre
- Recursos
- Instalação
- Autenticação
- Recursos Disponíveis
- Exemplos de Uso
- Troubleshooting
- Desenvolvimento
- Contribuindo
- Licença
🎯 Sobre
Este projeto foi desenvolvido por Yuri Silva para fornecer uma integração completa, robusta e atualizada entre o Fale Já e o n8n.
O que é o Fale Já?
Fale Já é uma plataforma de atendimento moderna e 100% escalável, desenvolvida para empresas brasileiras que precisam:
✅ Centralizar todas as mensagens de redes sociais em um só lugar
✅ Automatizar atendimentos com chatbots inteligentes
✅ Gerenciar múltiplos canais: WhatsApp, Instagram, Facebook, Telegram, E-mail, SMS e mais
✅ Acompanhar relatórios completos de desempenho e satisfação
✅ Integrar com CRMs, n8n e outras ferramentas via webhooks
Diferencial deste Pacote
Enquanto outras integrações cobrem funcionalidades básicas, este pacote oferece:
✅ Cobertura Completa: Todos os recursos das APIs oficiais
✅ 3 Tipos de API: Application, Client e Platform APIs
✅ 100% em Português: Interface e documentação em português brasileiro
✅ Testado: Validado na plataforma oficial Fale Já
✅ Código Limpo: TypeScript, modular e bem documentado
✅ Suporte Oficial: Desenvolvido por Yuri Silva, CEO do Fale Já
🚀 Recursos
🎯 100% de Cobertura Absoluta - v5.0.1
Este pacote possui 137+ operações cobrindo LITERALMENTE TODOS os endpoints da API oficial do Fale Já!
✅ Application API - 21 recursos, 106+ operações
✅ Platform API - 4 recursos, 17 operações
✅ Client API - 3 recursos, 12 operações
✅ Other APIs - 1 recurso, 2 operações
🤖 100% compatível com AI Agents - Todas as operações disponíveis como Tools!
Application APIs
Automação e operações para agentes/administradores:
| Recurso | Operações | Descrição |
|---|---|---|
| Account | Get, Update | Detalhes e configurações da conta |
| Agents | Get All, Create, Update, Delete | Gestão completa de agentes |
| Audit Logs | Get All, Get | Logs de auditoria e segurança |
| Account Agent Bots | Get All, Create, Get, Update, Delete | Bots de agente da conta |
| Automation Rules | Get All, Create, Get, Update, Delete | Regras de automação |
| Canned Responses | Get All, Create, Delete, Update 🆕 | Respostas prontas |
| Contacts | Get, Get All, Create, Update, Delete, Search, Filter, Import, Get Conversations 🆕, Create Inbox 🆕, Get Contactable Inboxes 🆕, Merge 🆕 | Gestão completa de contatos |
| Contact Labels | Get All, Add, Remove | Etiquetas de contatos |
| Conversations | Get, Get All, Create, Toggle Status, Get Counts, Filter, Update, Toggle Priority, Update Custom Attributes, Get Events | Gestão avançada de conversas |
| Conversation Labels | Get All, Add | Etiquetas de conversas |
| Conversation Assignments | Assign Agent, Assign Team | Atribuição de conversas |
| CSAT Survey | Get Many, Get Metrics | Pesquisas de satisfação |
| Custom Attributes | Get All, Create, Get, Update, Delete | Atributos personalizados |
| Custom Filters | Get All, Create, Get, Update, Delete | Filtros customizados |
| Help Center | Portals (CRUD), Categories (CRUD), Articles (CRUD) | Central de ajuda completa |
| Inboxes | Get, Get All, Create, Update, Get Agent Bot, Add/Remove Agent Bot 🆕, Get Agents, Update Agents, Delete Agent, Get All Agents | Caixas de entrada |
| Integrations | Get All, Create Hook, Update Hook, Delete Hook | Integrações (Slack, etc) |
| Labels | Get All, Create, Get, Update, Delete | Etiquetas (nível conta) |
| Messages | Get All, Create, Delete | Mensagens |
| Profile | Get, Update, Get Availability, Update Availability | Perfil do agente |
| Reports | Account Summary, Agent Summary, Conversations, Agent Metrics, Team Summary, Account Events 🆕, By Channel 🆕 | Relatórios e analytics |
| Teams | Get, Get All, Create, Update, Delete, Get Agents 🆕, Add Agent 🆕, Remove Agent 🆕, Update Agents | Gestão de equipes |
| Webhooks | Get All, Create, Update, Delete | Webhooks para integrações |
Client APIs
Para interações públicas (chatbot, widget):
| Recurso | Operações | Descrição |
|---|---|---|
| Contacts | Create, Get, Update | Criar e gerenciar contatos públicos |
| Conversations | Get All, Create, Get, Toggle Status, Toggle Typing 🆕, Update Last Seen 🆕 | Conversas via API pública |
| Messages | Get All, Create, Update | Enviar e atualizar mensagens |
Platform APIs
Para operações de super admin (self-hosted):
| Recurso | Operações | Descrição |
|---|---|---|
| Accounts | Get, Get All, Create, Update, Delete | Gestão de contas |
| Account Users | Get All, Create, Delete | Usuários da conta |
| Agent Bots | Get, Get All, Create, Update, Delete | Bots de agente |
| Users | Get, Get All, Create, Update, Delete, Get SSO Link | Usuários da plataforma |
🆕 Novidades da v5.0.1 (2026-01-20)
15 novos endpoints implementados para 100% de cobertura absoluta:
Contacts (4 novos)
- ✅ Get Conversations - Lista todas as conversas de um contato
- ✅ Create Inbox - Cria associação de inbox para contato
- ✅ Get Contactable Inboxes - Lista inboxes disponíveis
- ✅ Merge - Mescla dois contatos duplicados
Teams (3 novos)
- ✅ Get Agents - Lista agentes do time
- ✅ Add Agent - Adiciona agente ao time
- ✅ Remove Agent - Remove agente do time
Client Conversations (2 novos)
- ✅ Toggle Typing - Indicador de digitação
- ✅ Update Last Seen - Atualiza última visualização
Reports (2 novos)
- ✅ Account Events - Timeline de eventos
- ✅ By Channel - Estatísticas por canal
Outros (2 novos)
- ✅ Inbox: Add/Remove Agent Bot - Gerenciar bot em inbox
- ✅ Canned Response: Update - Atualizar resposta pronta
📦 Instalação
Via n8n Interface (Recomendado)
- Abra seu n8n
- Vá em Settings → Community Nodes
- Clique em Install
- Digite:
n8n-nodes-faleja - Clique em Install
- Reinicie o n8n
Via npm
npm install n8n-nodes-faleja
Via n8n CLI
n8n-community-nodes add n8n-nodes-faleja
🔐 Autenticação
O Fale Já oferece três tipos de autenticação, dependendo da API que você quer usar:
1. Application API (Mais Comum)
Para automações administrativas e operações de agentes.
Onde obter:
- Acesse https://app.faleja.com.br
- Faça login
- Vá em Perfil → Configurações de Perfil
- Copie seu Access Token
- Copie também o Account ID (geralmente visível na URL)
Configuração no n8n:
- Credential Type: Fale Já Application API
- Base URL:
https://app.faleja.com.br - Access Token: Seu token de acesso
- Account ID: ID da sua conta (número)
2. Client API
Para interações públicas via chatbot ou widget.
Onde obter:
- Acesse Configurações → Caixas de Entrada
- Selecione uma API Inbox
- Copie o Inbox Identifier
- Copie o Contact Identifier (obtido ao criar um contato via API)
Configuração no n8n:
- Credential Type: Fale Já Client API
- Base URL:
https://app.faleja.com.br - Inbox Identifier: Identificador da caixa de entrada
- Contact Identifier: Identificador do contato
3. Platform API
Para operações de super admin (apenas self-hosted).
Onde obter:
- Acesse o Super Admin Console
- Vá em Platform Apps
- Copie o Platform Access Token
Configuração no n8n:
- Credential Type: Fale Já Platform API
- Base URL: URL da sua instância self-hosted
- Platform Access Token: Token de acesso da plataforma
📖 Exemplos de Uso
Exemplo 1: Criar um Contato
{
"nodes": [
{
"name": "Criar Contato Fale Já",
"type": "n8n-nodes-faleja.faleJa",
"parameters": {
"apiType": "application",
"resource": "contact",
"operation": "create",
"name": "João Silva",
"email": "joao@exemplo.com.br",
"phone": "+5511999999999"
},
"credentials": {
"faleJaApi": "Fale Já Credentials"
}
}
]
}
Exemplo 2: Enviar Mensagem
{
"nodes": [
{
"name": "Enviar Mensagem",
"type": "n8n-nodes-faleja.faleJa",
"parameters": {
"apiType": "application",
"resource": "message",
"operation": "create",
"conversationId": "123",
"content": "Olá! Como posso ajudar?",
"messageType": "outgoing"
},
"credentials": {
"faleJaApi": "Fale Já Credentials"
}
}
]
}
Exemplo 3: Webhook de Nova Mensagem
Configure um webhook no Fale Já e capture no n8n:
- No Fale Já: Configurações → Integrações → Webhooks
- URL do Webhook: Cole a URL do seu n8n webhook
- Eventos: Selecione "message_created"
- No n8n: Use o node Webhook para receber eventos
🐛 Troubleshooting
Erro: "Invalid credentials"
- Verifique se o Access Token está correto
- Confirme que o Account ID corresponde à sua conta
- Teste o token diretamente na plataforma Fale Já
Erro: "Resource not found"
- Verifique se o ID do recurso (contato, conversa, etc.) existe
- Confirme que você tem permissões para acessar o recurso
Logo não aparece
- Limpe o cache do navegador (Ctrl + F5)
- Reinicie completamente o n8n
- Aguarde alguns segundos para o n8n processar
Pacote não instala
- Verifique sua conexão com a internet
- Confirme que está usando Node.js 18+
- Tente instalar via terminal:
npm install n8n-nodes-faleja
💻 Desenvolvimento
Setup Local
# Clone o repositório
git clone https://github.com/yurisilvapro/faleja-community-nodes.git
cd faleja-community-nodes
# Instale dependências
npm install
# Build
npm run build
# Link localmente
npm link
cd ~/.n8n/nodes
npm link n8n-nodes-faleja
Estrutura do Projeto
n8n-nodes-faleja/
├── credentials/
│ ├── FaleJaApi.credentials.ts
│ ├── FaleJaClientApi.credentials.ts
│ └── FaleJaPlatformApi.credentials.ts
├── nodes/
│ └── FaleJa/
│ ├── FaleJa.node.ts
│ ├── ApplicationApi/
│ ├── ClientApi/
│ ├── PlatformApi/
│ └── GenericFunctions.ts
├── docs/
├── examples/
└── package.json
🤝 Contribuindo
Contribuições são bem-vindas! Por favor:
- Fork o projeto
- Crie uma branch para sua feature (
git checkout -b feature/NovaFuncionalidade) - Commit suas mudanças (
git commit -m 'Adiciona nova funcionalidade') - Push para a branch (
git push origin feature/NovaFuncionalidade) - Abra um Pull Request
📊 Status do Projeto
Cobertura Atual
| API Type | Recursos | Status |
|---|---|---|
| Application APIs | 10/20 | ✅ Versão 2.0.0 |
| Client APIs | 3/3 | ✅ Versão 2.0.0 |
| Platform APIs | 4/4 | ✅ Versão 2.0.0 |
🔄 Changelog
[3.0.0] - 2026-01-20
- 🎉 100% de cobertura da API - TODOS os endpoints implementados
- ✅ 20 recursos da Application API (10 novos!)
- ✅ 3 recursos da Client API
- ✅ 4 recursos da Platform API
- ✅ Mais de 100 operações disponíveis
- ✅ TODOS disponíveis como AI Agent Tools
[2.0.0] - 2026-01-19
- 🎨 Lançamento oficial da plataforma Fale Já
- ✅ Integração completa com plataforma Fale Já
- ✅ 10 recursos iniciais da Application API
- ✅ 3 recursos da Client API
- ✅ 4 recursos da Platform API
- ✅ Logo oficial do Fale Já
- ✅ Documentação 100% em português
- ✅ Publicado no npm
📜 Licença
MIT © 2026 Yuri Silva
👤 Autor
Yuri Silva
Desenvolvedor & CEO do Fale Já
Empresário Tecnologia na Saúde | Segurança da Informação | Inteligência Artificial
📬 Contato
- 🌐 Website: https://taggo.one/yurisistemas
- 📧 Email: yurisilvanegocios.me@gmail.com
- 💬 WhatsApp: +55 21 97208-9450
- 📸 Instagram: @yuri.sistemas
- 💼 GitHub: @yurisilvapro
- 🚀 Fale Já: https://faleja.com.br
🙏 Agradecimentos
- Equipe n8n pela plataforma incrível
- Comunidade n8n Brasil
- Usuários do Fale Já
🔗 Links Úteis
- 📦 npm Package
- 🐙 GitHub Repository
- 🌐 Fale Já - Site Oficial
- 🚀 Fale Já - Plataforma
- 📚 n8n Documentation
Desenvolvido com ❤️ por Yuri Silva para a comunidade brasileira