@rtenorioh/n8n-nodes-pressticket

Este pacote contém um nó personalizado para n8n que permite integração com a API do Press Ticket®, uma plataforma de atendimento via WhatsApp.

Importante: Este nó requer a versão v1.14.0 ou superior do Press Ticket®.

Instalação

Instalação Global (Recomendado para n8n Self-Hosted)

npm install -g @rtenorioh/n8n-nodes-pressticket

Instalação Local (Para desenvolvimento)

1. Clone este repositório
2. Navegue até o diretório do projeto
3. Execute os comandos:

npm install
npm run build

Configuração

Credenciais

Para utilizar o nó Press Ticket®, você precisa configurar as credenciais de acesso à API:

1. No n8n, vá para Configurações > Credenciais > Adicionar nova credencial
2. Selecione o tipo "Press Ticket® API"
3. Preencha os campos:
   • API URL: URL base da API (ex: https://apiback.pressticket.com.br)
   • API Token: Token de acesso à API do Press Ticket®

Permissões Necessárias

O token de API deve ter as seguintes permissões, dependendo das operações que você deseja realizar:

• create:messages: Para enviar mensagens de texto, mídia, enquetes e encaminhar
• read:messages: Para obter mídia e reações de mensagens
• update:messages: Para editar mensagens e reagir
• delete:messages: Para excluir mensagens

• read:contacts: Para listar, obter, exportar contatos e verificar bloqueio
• create:contacts: Para criar contatos e bloquear/desbloquear
• update:contacts: Para atualizar contatos e tags
• delete:contacts: Para excluir contatos

• read:tickets: Para listar, obter e contar tickets
• create:tickets: Para criar tickets e fechar todos
• update:tickets: Para atualizar tickets
• delete:tickets: Para excluir tickets

• read:queue: Para listar setores
• create:queue: Para criar setores
• update:queue: Para atualizar setores
• delete:queue: Para excluir setores

• read:tags: Para listar tags
• create:tags: Para criar tags
• update:tags: Para atualizar tags
• delete:tags: Para excluir tags

• read:whatsapp: Para listar e obter conexões WhatsApp e QR Codes
• create:whatsapp: Para criar conexões WhatsApp, verificar número, reiniciar e encerrar
• update:whatsapp: Para atualizar conexões WhatsApp
• delete:whatsapp: Para excluir conexões WhatsApp

• create:whatsappsession: Para criar sessões
• update:whatsappsession: Para atualizar sessões
• delete:whatsappsession: Para excluir sessões

• create:presence: Para enviar status de digitando, gravando e disponível

• read:groups: Para listar grupos, participantes e links de convite
• create:groups: Para criar grupos, adicionar/remover participantes
• update:groups: Para alterar nome, descrição e configurações do grupo
• delete:groups: Para remover foto e sair do grupo

• read:users: Para listar e obter usuários
• create:users: Para criar usuários
• update:users: Para atualizar usuários
• delete:users: Para excluir usuários

• read:quick-answers: Para listar e obter respostas rápidas
• create:quick-answers: Para criar respostas rápidas
• update:quick-answers: Para atualizar respostas rápidas
• delete:quick-answers: Para excluir respostas rápidas

• read:client-status: Para listar, obter e ver estatísticas
• create:client-status: Para criar status
• update:client-status: Para atualizar status
• delete:client-status: Para excluir status

• admin:backups: Para gerenciar backups
• admin:activity-logs: Para visualizar logs de atividade
• admin:error-logs: Para gerenciar logs de erro
• admin:system-update: Para verificar e instalar atualizações
• admin:videos: Para gerenciar vídeos
• admin:system: Para monitorar disco, memória, CPU, banco de dados e rede

Recursos e Operações

Enviar Texto

Envia uma mensagem de texto para um número de WhatsApp.

• Número do WhatsApp: Número no formato internacional (ex: 5511999999999)
• ID do Usuário: ID do usuário que está enviando a mensagem
• ID do Setor: ID do setor
• ID da Conexão WhatsApp: ID da conexão do WhatsApp
• Texto da Mensagem: Conteúdo da mensagem a ser enviada

Enviar Mídia

Envia uma mensagem com mídia (imagem, vídeo, áudio ou documento).

• Número do WhatsApp: Número no formato internacional
• ID do Usuário / Setor / Conexão WhatsApp
• Tipo de Mídia: Imagem, Vídeo, Áudio ou Documento
• Método de Entrada: URL ou Arquivo Binário
• Legenda: Texto que acompanha a mídia (opcional)

Obter Mídia em Base64

Obtém a mídia de uma mensagem em formato base64.

• ID da Mensagem: ID da mensagem que contém a mídia

Editar Mensagem

Edita o conteúdo de uma mensagem já enviada.

• ID da Mensagem: ID da mensagem a ser editada
• Novo Conteúdo: Novo texto da mensagem

Excluir Mensagem

Exclui uma mensagem enviada.

• ID da Mensagem: ID da mensagem a ser excluída

Reagir a Mensagem

Adiciona uma reação (emoji) a uma mensagem.

• ID da Mensagem: ID da mensagem
• Emoji: Emoji da reação
• Remover Emoji: Emoji a ser removido (opcional)

Obter Reações

Obtém todas as reações de uma mensagem.

• ID da Mensagem: ID da mensagem

Encaminhar Mensagens

Encaminha mensagens para outros tickets.

• IDs das Mensagens: IDs separados por vírgula
• IDs dos Tickets de Destino: IDs separados por vírgula

Enviar Enquete

Envia uma enquete em um ticket.

• ID do Ticket: ID do ticket
• Pergunta da Enquete: Texto da pergunta
• Opções: Opções separadas por vírgula
• Permitir Múltiplas Respostas: Sim ou Não

Marcar como Lidas

Marca todas as mensagens de um ticket como lidas.

• ID do Ticket: ID do ticket

Listar

Lista todos os contatos cadastrados.

Obter

Obtém detalhes de um contato específico.

• ID do Contato: Identificador único do contato

Criar

Cria um novo contato.

• Nome: Nome do contato
• Número: Número no formato internacional (ex: 5511999999999)
• Email: Email do contato (opcional)
• Endereço: Endereço do contato (opcional)

Atualizar

Atualiza um contato existente.

• ID do Contato, Nome, Número, Email, Endereço

Excluir

Exclui um contato existente.

• ID do Contato: Identificador único do contato

Atualizar Tags

Atualiza as tags associadas a um contato.

• ID do Contato: Identificador único do contato
• IDs das Tags: Lista de IDs separados por vírgula

Consultar

Consulta um contato por número, email ou nome.

• Número / Email / Nome: Pelo menos um campo obrigatório

Bloquear

Bloqueia um contato no WhatsApp.

• ID do Contato: Identificador único do contato
• ID da Conexão WhatsApp: ID da conexão

Desbloquear

Desbloqueia um contato no WhatsApp.

• ID do Contato: Identificador único do contato
• ID da Conexão WhatsApp: ID da conexão

Verificar Bloqueio

Verifica se um contato está bloqueado.

• ID do Contato: Identificador único do contato
• ID da Conexão WhatsApp: ID da conexão

Listar Bloqueados

Lista todos os contatos bloqueados.

• ID da Conexão WhatsApp: ID da conexão

Obter "Sobre"

Obtém o texto "Sobre" do perfil de um contato.

• ID do Contato: Identificador único do contato
• ID da Conexão WhatsApp: ID da conexão

Grupos em Comum

Obtém grupos em comum com um contato.

• ID do Contato: Identificador único do contato
• ID da Conexão WhatsApp: ID da conexão

Exportar

Exporta todos os contatos.

Listar

Lista todos os tickets.

Obter

Obtém detalhes de um ticket específico.

• ID do Ticket: Identificador único do ticket

Obter Ticket Aberto do Contato

Obtém o ticket aberto de um contato específico.

• ID do Contato: Identificador único do contato

Criar

Cria um novo ticket.

• ID do Contato: ID do contato
• Status: Aberto, Pendente ou Fechado
• ID do Setor (opcional) / ID do Usuário (opcional)

Atualizar

Atualiza um ticket existente.

• ID do Ticket, Status, ID do Setor (opcional), ID do Usuário (opcional)

Excluir

Exclui um ticket.

• ID do Ticket: Identificador único do ticket

Contar

Retorna a contagem total de tickets.

Fechar Todos

Fecha todos os tickets abertos.

Listar

Lista todos os setores cadastrados.

Obter

Obtém detalhes de um setor específico.

• ID do Setor: Identificador único

Criar

Cria um novo setor.

• Nome: Nome do setor
• Cor: Cor em formato hexadecimal (ex: #FF0000)

Atualizar

Atualiza um setor existente.

• ID do Setor, Nome, Cor

Excluir

Exclui um setor.

• ID do Setor: Identificador único

Listar / Listar Todas

Lista tags com ou sem paginação.

Obter

Obtém detalhes de uma tag específica.

• ID da Tag: Identificador único

Criar

Cria uma nova tag.

• Nome: Nome da tag
• Cor: Cor em formato hexadecimal

Atualizar

Atualiza uma tag existente.

• ID da Tag, Nome, Cor

Excluir

Exclui uma tag.

• ID da Tag: Identificador único

Sincronizar

Sincroniza tags de um contato.

• ID do Contato: Identificador do contato
• IDs das Tags: Lista de IDs separados por vírgula

Listar

Lista todas as conexões WhatsApp cadastradas.

Obter

Obtém detalhes de uma conexão WhatsApp específica.

• ID do WhatsApp: Identificador único da conexão

Criar

Cria uma nova conexão WhatsApp.

• Nome, Status, Padrão (boolean)

Atualizar

Atualiza uma conexão WhatsApp existente.

• ID do WhatsApp, Nome, Status, Padrão

Excluir

Exclui uma conexão WhatsApp.

• ID do WhatsApp: Identificador único

Verificar Número

Verifica se um número possui WhatsApp.

• Número: Número no formato internacional

Reiniciar

Reinicia uma conexão WhatsApp.

• ID do WhatsApp: Identificador único

Encerrar

Encerra uma conexão WhatsApp.

• ID do WhatsApp: Identificador único

Obter QR Code

Obtém o QR Code de uma conexão WhatsApp.

• ID do WhatsApp: Identificador único
• Retorno: qrcode (string), qrcodeImage (base64), whatsappId

Criar

Cria uma nova sessão WhatsApp.

• ID do WhatsApp: ID da conexão

Atualizar

Atualiza uma sessão existente.

• ID da Sessão, ID do WhatsApp

Excluir

Exclui uma sessão WhatsApp.

• ID da Sessão: Identificador único

Digitando

Envia status de "digitando" em um ticket.

• ID do Ticket: ID do ticket
• Duração: Duração em milissegundos (padrão: 3000)

Gravando

Envia status de "gravando áudio" em um ticket.

• ID do Ticket: ID do ticket
• Duração: Duração em milissegundos (padrão: 3000)

Disponível

Envia status de "disponível" em um ticket.

• ID do Ticket: ID do ticket

Listar

Lista todos os grupos de uma conexão WhatsApp.

• ID da Conexão WhatsApp: ID da conexão

Criar

Cria um novo grupo.

• ID da Conexão WhatsApp, Nome do Grupo, Participantes (números separados por vírgula)

Obter

Obtém detalhes de um grupo.

• ID da Conexão WhatsApp, ID do Grupo

Alterar Nome / Descrição

Altera o nome ou descrição do grupo.

• ID do Grupo, Nome ou Descrição

Adicionar / Remover / Promover / Rebaixar Participantes

Gerencia participantes do grupo.

• ID do Grupo, Participantes (números separados por vírgula)

Listar Participantes

Lista participantes de um grupo.

• ID do Grupo

Obter / Revogar Link de Convite

Gerencia o link de convite do grupo.

• ID do Grupo

Configurar Modo de Adição / Anúncio / Restrição

Configura permissões do grupo.

• ID do Grupo, Modo ou Habilitado (boolean)

Definir / Remover Foto

Gerencia a foto do grupo.

• ID do Grupo, Propriedade Binária da Foto (para definir)

Listar / Aprovar / Rejeitar Solicitações de Adesão

Gerencia solicitações de adesão ao grupo.

• ID do Grupo, Participantes (para aprovar/rejeitar)

Sair do Grupo

Sai de um grupo.

• ID do Grupo

Listar

Lista todos os usuários.

Criar

Cria um novo usuário.

• Nome, Email, Senha, Perfil (admin ou user)

Obter

Obtém detalhes de um usuário.

• ID do Usuário

Atualizar

Atualiza um usuário.

• ID do Usuário, Nome, Email, Perfil

Excluir

Exclui um usuário.

• ID do Usuário

Listar

Lista todas as respostas rápidas.

Criar

Cria uma nova resposta rápida.

• Atalho: Texto de atalho (ex: /saudacao)
• Mensagem: Conteúdo da resposta

Obter

Obtém uma resposta rápida.

• ID da Resposta Rápida

Atualizar

Atualiza uma resposta rápida.

• ID da Resposta Rápida, Atalho, Mensagem

Excluir / Excluir Todas

Exclui uma ou todas as respostas rápidas.

Listar

Lista todos os status de cliente.

Criar

Cria um novo status.

• Nome, Cor (formato hexadecimal)

Obter

Obtém detalhes de um status.

• ID do Status

Atualizar

Atualiza um status.

• ID do Status, Nome, Cor

Excluir / Excluir Todos

Exclui um ou todos os status.

Estatísticas

Retorna estatísticas dos status de clientes.

Listar

Lista todos os backups disponíveis.

Criar

Cria um novo backup do sistema.

Obter

Obtém detalhes de um backup.

• Nome do Arquivo: Nome do arquivo de backup

Excluir

Exclui um backup.

• Nome do Arquivo: Nome do arquivo de backup

Restaurar

Restaura o sistema a partir de um backup.

• Nome do Arquivo: Nome do arquivo de backup

Listar

Lista todos os logs de atividade.

Listar Ações

Lista os tipos de ações registradas.

Listar Entidades

Lista os tipos de entidades registradas.

Obter Detalhes

Obtém detalhes de um log específico.

• ID do Log: Identificador único

Listar

Lista todos os logs de erro.

Criar

Registra um novo log de erro.

• Mensagem de Erro: Descrição do erro
• Stack Trace: Rastreamento de pilha (opcional)

Obter

Obtém detalhes de um log de erro.

• ID do Log de Erro

Limpar

Remove todos os logs de erro antigos.

Verificar Atualização

Verifica se há atualizações disponíveis.

Instalar Atualização

Instala a atualização disponível.

Status da Atualização

Obtém o status do processo de atualização.

Listar Backups

Lista os backups de atualização disponíveis.

Restaurar

Restaura o sistema a partir de um backup de atualização.

• Nome do Arquivo de Backup

Listar

Lista todos os vídeos.

Criar

Cria um novo vídeo.

• Título, URL do Vídeo

Obter

Obtém detalhes de um vídeo.

• ID do Vídeo

Atualizar

Atualiza um vídeo.

• ID do Vídeo, Título, URL do Vídeo

Excluir

Exclui um vídeo.

• ID do Vídeo

Espaço em Disco

Retorna informações sobre o espaço em disco.

Uso de Memória

Retorna informações sobre o uso de memória.

Uso de CPU

Retorna informações sobre o uso de CPU.

Status do Banco de Dados

Retorna o status do banco de dados.

Reiniciar PM2

Reinicia o processo PM2 do sistema.

Versão

Retorna a versão atual do sistema.

Status da Rede

Retorna informações sobre o status da rede.

Monitor de Filas

Retorna informações sobre o monitor de filas.

Atualizar Biblioteca WhatsApp

Atualiza a biblioteca do WhatsApp.

Exemplos de Uso

Envio de Mensagem de Texto

1. Adicione o nó "Press Ticket®" ao seu fluxo de trabalho
2. Selecione o recurso "Mensagem" e a operação "Enviar Texto"
3. Configure os parâmetros:
   • Número do WhatsApp: 5511999999999
   • ID do Usuário: 1
   • ID do Setor: 1
   • ID da Conexão WhatsApp: 1
   • Texto da Mensagem: "Olá, esta é uma mensagem de teste!"

Criação de Ticket

1. Adicione o nó "Press Ticket®" ao seu fluxo de trabalho
2. Selecione o recurso "Ticket" e a operação "Criar"
3. Configure os parâmetros:
   • ID do Contato: 1
   • Status: "open"
   • ID do Setor: 1

Obtenção de QR Code do WhatsApp

1. Adicione o nó "Press Ticket®" ao seu fluxo de trabalho
2. Selecione o recurso "WhatsApp" e a operação "Obter QR Code"
3. Configure os parâmetros:
   • ID do WhatsApp: 1
4. O nó retornará um objeto contendo:
   • qrcode: String do QR Code
   • qrcodeImage: Imagem do QR Code em formato base64 que pode ser exibida diretamente
   • whatsappId: ID da conexão WhatsApp

Solução de Problemas

Erro 403 (Forbidden)

Se você receber um erro 403 com a mensagem "Invalid token", verifique:

1. Se o token de API está correto
2. Se o token possui as permissões necessárias para a operação que está tentando realizar
3. Se os IDs de usuário, setor e conexão WhatsApp estão corretos

Documentação

Além deste README, o projeto conta com os seguintes documentos:

• Código de Conduta - Diretrizes de comportamento para a comunidade
• Guia de Contribuição - Como contribuir com o projeto
• Política de Segurança - Como reportar vulnerabilidades

Desenvolvimento

Estrutura do Projeto

n8n-nodes-pressticket/
├── credentials/
│   └── PressTicketApi.credentials.ts
├── nodes/
│   └── PressTicket/
│       ├── PressTicket.node.ts
│       ├── PressTicket.node.json
│       └── pressTicket.svg
├── dist/
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── docker-compose.yml
├── gulpfile.js
├── index.js
├── LICENSE
├── package.json
├── README.md
├── SECURITY.md
└── tsconfig.json

Compilação

Para compilar o projeto, execute:

npm run build

Publicação

Para publicar uma nova versão do pacote no npm:

npm version patch
npm run build
npm publish

Código de Conduta

Este projeto adota o Código de Conduta para garantir um ambiente acolhedor e inclusivo para todos os contribuidores e participantes. Por favor, leia-o antes de participar do projeto.

Licença

MIT