n8n WhatsApp API Community Node

Este é um Community Node para n8n que permite a integração com uma API personalizada do WhatsApp, facilitando o envio de mensagens, gerenciamento de contatos, tickets, sessões e oportunidades diretamente de seus workflows do n8n.

Funcionalidades

Este node oferece uma ampla gama de operações para interagir com sua API do WhatsApp:

Mensagens

• Enviar Texto: Envia mensagens de texto para um número específico.
• Enviar Arquivo por URL: Envia arquivos (imagens, documentos, etc.) fornecendo uma URL.
• Enviar Áudio: Envia mensagens de áudio.
• Enviar Base64: Envia arquivos codificados em Base64.
• Enviar Template: Envia mensagens de template aprovadas pelo WhatsApp Business.
• Enviar Texto para Grupo: Envia mensagens de texto para um grupo do WhatsApp.

Contatos

• Criar Contato: Adiciona um novo contato.
• Atualizar Contato: Modifica informações de um contato existente.
• Buscar Contato: Recupera detalhes de um contato.

Tickets

• Criar Ticket: Abre um novo ticket de atendimento.
• Criar Notas: Adiciona notas a um ticket existente.
• Atualizar Informações: Modifica detalhes de um ticket.
• Buscar Informações: Recupera detalhes de um ticket.
• Listar Todas as Mensagens: Obtém todas as mensagens associadas a um ticket.

Sessões

• Criar Sessão: Inicia uma nova sessão da API do WhatsApp.
• Iniciar Sessão: Ativa uma sessão existente.
• Mostrar QR Code: Exibe o QR Code para vincular uma nova sessão.
• Deletar Sessão: Remove uma sessão.

Oportunidades

• Criar Oportunidade: Registra uma nova oportunidade de negócio.
• Atualizar Oportunidade: Modifica detalhes de uma oportunidade existente.
• Deletar Oportunidade: Remove uma oportunidade.

Instalação

Para instalar este community node em sua instância n8n:

1. Navegue até o diretório de instalação do n8n.
   Geralmente, é onde o package.json do n8n está localizado, ou o diretório ~/.n8n/ se você instalou globalmente.

2. Instale o node via npm:

   cd ~/.n8n/
   npm install n8n-nodes-whatsapp-api
   # Ou, se você estiver desenvolvendo localmente:
   # npm install /caminho/para/seu/projeto/n8n-nodes-whatsapp-api
   

   Se você estiver desenvolvendo, pode usar npm link no diretório do seu projeto e depois npm link n8n-nodes-whatsapp-api no diretório do n8n para criar um link simbólico.

3. Reinicie sua instância n8n.
   Após a instalação, você precisará reiniciar o n8n para que o novo node seja carregado.

Configuração de Credenciais

Antes de usar o node, você precisará configurar as credenciais da sua API do WhatsApp no n8n.

1. No n8n, clique em "Credentials" (Credenciais) no menu lateral esquerdo.
2. Clique em "New Credential" (Nova Credencial).
3. Procure por "WhatsApp API Credentials".
4. Preencha os seguintes campos:
   • Base URL: A URL base da sua API do WhatsApp (ex: https://seu-dominio.com.br).
   • Bearer Token: Seu token de autenticação Bearer para a API.
   • API Instance ID: O ID da instância da API (UUID) que será usado nas URLs.

Uso

Após configurar as credenciais, você pode adicionar o node "WhatsApp API" aos seus workflows.

1. No editor de workflow do n8n, clique no botão "+" para adicionar um novo node.
2. Procure por "WhatsApp API".
3. Arraste e solte o node no seu workflow.
4. Configure o "Resource" (Recurso) e a "Operation" (Operação) desejados.
5. Preencha os parâmetros específicos para a operação escolhida (ex: Phone Number, Message Text, Media URL, etc.).

Desenvolvimento

Se você estiver desenvolvendo este node:

1. Clone o repositório:

   git clone https://github.com/yourusername/n8n-nodes-whatsapp-api.git
   cd n8n-nodes-whatsapp-api
   

2. Instale as dependências:

   npm install
   

3. Compile o código:

   npm run build
   

   Isso compilará os arquivos TypeScript para JavaScript e copiará o ícone para o diretório dist.

4. Para desenvolvimento contínuo (watch mode):

   npm run dev
   

   Isso observará as mudanças nos arquivos .ts e recompilará automaticamente.

Contribuição

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou pull requests.

Licença

Este projeto é licenciado sob a licença MIT.