NOTIFICA ZAPIDocumentação do addon
Guia de utilização

Como usar o NOTIFICA ZAPI no dia a dia

Um guia completo, aba por aba, para tirar o máximo proveito do addon: quais mensagens são enviadas automaticamente, como personalizá-las e como acompanhar tudo o que foi enviado.

8 abas explicadas
Todas as variáveis de mensagem
Dicas para evitar bloqueio

Pré-requisito

Antes de usar, confirme estes dois pontos

O addon só envia mensagens quando ambas as condições abaixo estiverem atendidas. Se ainda não configurou nenhuma delas, siga primeiro o Guia de Instalação.

Licença ativa

Verifique na aba Configurações se a Chave de Licença está preenchida e válida.

WhatsApp conectado

Verifique na aba QR Code se o status é "Dispositivo Conectado".

Aba Configurações

Ajustes gerais do addon

Além da licença e do token (definidos na instalação), esta aba concentra os ajustes que você pode querer revisar de tempos em tempos:

CampoPara que serve
Origem do NúmeroDefine de onde vem o número de WhatsApp de cada cliente: um campo padrão do WHMCS ou um campo personalizado configurado por você.
Assinatura das MensagensTexto (ex.: nome da equipe) inserido automaticamente onde o modelo usar a variável %assinatura%.
Sistema de Fila de EnviosLigado (padrão): as mensagens passam pela fila e são enviadas em segundo plano, respeitando horário, intervalo e teto diário. Desligado: todas as mensagens saem imediatamente, e a aba "Fila de Envios" fica oculta.
Lembrete Manual de FaturasQuando ligado, o botão "Enviar Lembrete" da lista de faturas do WHMCS também dispara o template Lembrete de Fatura no WhatsApp para cada fatura selecionada. Não afeta os lembretes automáticos.
Horário Inicial/Final PermitidoJanela de horário em que os lembretes automáticos podem ser enviados — fora dela, ficam retidos até o horário voltar a ser permitido. Continua valendo mesmo com a fila desligada (os lembretes automáticos sempre respeitam essa janela); só as mensagens transacionais é que saem na hora.
Teto Diário de EnviosLimite máximo de lembretes automáticos por dia, para reduzir o risco de bloqueio pelo WhatsApp.
Intervalo Entre EnviosTempo mínimo/máximo de espera entre uma mensagem e outra, simulando um envio mais humano.
Mensagem de AniversárioLiga/desliga o envio automático de parabéns e define o campo personalizado onde fica a data de nascimento do cliente.
Modo do Proxy"Não utilizar Proxy" (padrão), "Proxy Compartilhado da API" ou "Proxy Própria". Uso avançado — só altere se orientado.
Dica Sempre que salvar qualquer alteração nesta aba, a página recarrega automaticamente para confirmar que os novos valores foram gravados.

Aba QR Code

Mantendo a conexão do WhatsApp saudável

Esta aba mostra o status da conexão em tempo real e se atualiza sozinha a cada 30 segundos enquanto estiver aberta.

Se o status cair para "Desconectado"

  1. Abra a aba QR Code

    Um novo QR Code é gerado automaticamente.

  2. Escaneie novamente com o celular

    Mesmo processo da instalação: WhatsApp → Aparelhos conectados → Conectar um aparelho.

Se precisar trocar de número/aparelho

  1. Clique em "Desconectar"

    Encerra a sessão atual sem apagar o histórico de configuração.

  2. Escaneie o novo QR Code com o novo aparelho
Atenção Enquanto o WhatsApp estiver desconectado, nenhuma automação consegue enviar mensagens — os itens ficam retidos na Fila de Envios até a conexão voltar.

Aba Templates

O texto (e o interruptor) de cada mensagem automática

Cada evento do WHMCS que pode gerar uma mensagem automática — fatura criada, ticket respondido, serviço suspenso, aniversário do cliente, e assim por diante — tem um modelo (template) nesta aba.

  1. Ative ou desative cada modelo individualmente

    O interruptor Ativo em cada card decide se aquele tipo de mensagem é enviado ou não. Um modelo desativado nunca dispara, mesmo que o evento aconteça no WHMCS.

  2. Edite o texto livremente

    Escreva a mensagem do seu jeito, mantendo (ou não) as variáveis que quiser.

  3. Insira variáveis com um clique

    Use os botões de variável acima do campo de texto para inserir dados reais do cliente/fatura/serviço automaticamente na hora do envio.

  4. Salve o modelo

Variáveis disponíveis

Nem toda variável faz sentido em todo modelo — use apenas as que combinam com o contexto da mensagem (ex.: %invoiceid% só em mensagens de fatura).

VariávelSubstituída por
%name%Nome do cliente
%email%E-mail do cliente
%company%Nome da sua empresa (configurado no WHMCS)
%invoiceid%Número da fatura
%duedate%Data de vencimento da fatura
%value%Valor total da fatura
%invoicelink%Link direto para a fatura (sem login automático). Se o gateway da fatura for boleto/PIX, aponta para o boleto ou a página do PIX; senão, para viewinvoice.php.
%comprovante_pagamento%Link do comprovante de pagamento emitido pelo Asaas (mensagem Fatura Paga). Só é preenchido quando a fatura foi paga por um gateway Asaas, com a integração Asaas ativa e a API Key do Asaas informada na aba Integrações; nos demais casos sai em branco.
%product%Produto(s)/serviço(s) relacionado(s)
%domainwhmcs%Domínio configurado do seu WHMCS
%date%Data atual do envio
%hour%Hora atual do envio
%assinatura%Assinatura configurada na aba Configurações
%ticketid%Número do chamado/ticket
%subject%Assunto do chamado/ticket (ou da cotação)
%ticket_resposta%Texto da resposta que o atendente acabou de publicar no chamado (mensagem Ticket Respondido)
%quoteid%Número do orçamento/cotação
%quotestatus%Novo status da cotação, em português (mensagem Status da Cotação)
%autologin%Link de acesso automático à área do cliente (quando o módulo de autologin estiver disponível)
%dominio% %registrationdate% %expirydate%Nome, data de registro e data de expiração do domínio (mensagens de domínio)

Variáveis de serviço (mensagens de serviço)

Nas mensagens ligadas a um serviço (ex.: Serviço Criado), estão disponíveis também:

VariávelSubstituída por
%servico_id%ID do serviço
%servico_dominio%Domínio do serviço
%servico_status%Status (Active, Suspended, etc.)
%servico_tipo%Tipo do produto
%ciclo_cobranca%Ciclo de cobrança
%data_contratacao%Data de contratação
%proximo_vencimento%Próximo vencimento
%proxima_fatura%Data da próxima fatura
%valor_servico%Valor recorrente
%valor_primeiro%Valor do primeiro pagamento
%forma_pagamento%Forma de pagamento do serviço
%servico_servidor%Nome do servidor
%ip_dedicado%IP dedicado
%servico_ns1% %servico_ns2%Nameservers
%limite_disco% %limite_banda%Limites de disco e de banda
%servico_usuario% %servico_senha%Usuário e senha do serviço/painel
Cuidado com %servico_senha% — ela envia a senha do serviço em texto na mensagem de WhatsApp. Use apenas em modelos onde isso for aceitável (ex.: boas-vindas).
Se uma variável não se aplicar ao contexto da mensagem, ela simplesmente é removida no envio — nunca aparece "quebrada" ou literal para o cliente. As variáveis usam sempre o formato %nome% — não use a sintaxe {$variavel} dos e-mails do WHMCS, ela não é reconhecida aqui.

Aba Automações

Lembretes e alertas com dias configuráveis

Enquanto a aba Templates liga/desliga cada tipo de mensagem, a aba Automações configura especificamente os lembretes que dependem de contagem de dias — quantos dias antes (ou depois) de uma data cada aviso deve disparar.

Lembretes antes do vencimento

Até 3 lembretes independentes, cada um com sua própria quantidade de dias de antecedência (padrão: 7, 3 e 1 dia antes).

Fatura vencendo hoje

Aviso no próprio dia do vencimento, sem contagem de dias.

Fatura vencida

Até 3 cobranças independentes após o vencimento (padrão: 1, 3 e 5 dias depois).

Alerta de suspensão/cancelamento

Avisa o cliente com antecedência configurável antes de um serviço ser suspenso ou cancelado por falta de pagamento.

  1. Ative o lembrete desejado
  2. Ajuste a quantidade de dias

    Cada lembrete tem seu próprio campo numérico — não é possível repetir a mesma quantidade de dias duas vezes dentro do mesmo grupo.

  3. Salve
Mensagens de fatura criada/paga/cancelada, tickets, serviços, cadastro de cliente e cotações não dependem desta aba — elas disparam automaticamente sempre que o modelo correspondente estiver Ativo na aba Templates.

Aba Integrações

Botão "Pagar Agora" direto na mensagem de fatura

Se você já usa um dos gateways de pagamento suportados, o addon detecta automaticamente o módulo instalado no seu WHMCS e permite ativar a integração — a mensagem de fatura passa a vir enriquecida conforme a forma de pagamento da cobrança.

IntegraçãoO que a mensagem de fatura leva
AsaasBoleto → PDF do boleto anexado. PIX → imagem do QR Code + copia e cola. Cartão → botão "Pagar Agora". Fatura paga → link do comprovante de pagamento pela variável %comprovante_pagamento%.
Efi PayPIX — botão "Pagar Agora".
Mercado Pago - Checkout TransparenteSomente PIX — imagem do QR Code + copia e cola.
Mercado Pago - Checkout ProBoleto, PIX e cartão na página do Mercado Pago — botão "Pagar Agora".
Iugu (Edvan)PDF do boleto anexado.
PagHiperBoleto — botão "Pagar Agora".
Nota Fiscal (Asaas)Não é gateway — envia automaticamente o PDF da nota fiscal quando disponível.
  1. Abra a aba Integrações

    Gateways não instalados no seu WHMCS aparecem desabilitados — isso é esperado.

  2. Ative o gateway que você usa

    Alguns têm só o interruptor "Ativar"; no Asaas você ainda marca boleto/pix/cartão e informa a API Key do Asaas e o Ambiente (Produção ou Sandbox). A chave é necessária para enviar o link do comprovante de pagamento.

  3. Salve
Opcional Você não precisa ativar nenhuma integração para o addon funcionar — sem ela, as mensagens de fatura são enviadas como texto simples.

Aba Fila de Envios

Acompanhando o que está prestes a ser enviado

Toda mensagem passa primeiro por esta fila antes de ser efetivamente enviada — a menos que você tenha desligado o "Sistema de Fila de Envios" em Configurações, caso em que tudo é enviado na hora e esta aba fica oculta.

  • Ver detalhes — abre o conteúdo completo da mensagem antes de ser enviada.
  • Pular fila — envia a mensagem imediatamente, sem esperar o processamento automático.
  • Reprocessar — tenta reenviar um item que falhou.
  • Exclusão em massa — remove vários itens da fila de uma vez, com filtros.

No topo da aba, os indicadores de Saúde da Instância mostram, em tempo real: teto diário utilizado, mensagens enviadas e falhas nas últimas 24h, tamanho atual da fila pendente e quantos QR Codes foram gerados no período.

Aba Envios

Histórico completo do que já foi enviado

Toda mensagem que sai da fila — com sucesso ou com falha — gera um registro permanente aqui, com data, cliente, status final (enviado ou falhou) e o motivo em caso de falha.

Use os filtros de cliente (nome ou ID) e número da cobrança para localizar rapidamente o histórico de um caso específico, e o botão Remover registro para limpar itens que não precisa mais manter.

Aba Logs

Diagnosticando problemas

Sempre que algo sai do esperado — uma falha de conexão, uma rejeição de segurança, uma mudança relevante de estado — um registro é gravado aqui, com filtro por data e por tipo:

Erro

Falhas técnicas — normalmente exigem alguma correção sua (ex.: token inválido).

Falha

Um envio específico não foi concluído (ex.: número inválido).

Info

Eventos informativos de auditoria (ex.: instância conectada/desconectada, "Administrador enfileirou manualmente…" quando alguém dispara uma notificação pela tela da fatura).

Registros do tipo Info que começam com "Comprovante Asaas não aplicado…" explicam por que o link do comprovante não entrou numa mensagem de fatura paga (integração desativada, API Key não informada ou inválida, cobrança ainda não confirmada no Asaas etc.).

Dica Sempre que uma mensagem esperada não chegar ao destino, comece a investigação por aqui — a maioria dos problemas já vem com uma descrição clara da causa.

Recomendado

Boas práticas para não ser bloqueado pelo WhatsApp

  • Use um número dedicado só para o addon, de preferência já com algum histórico de uso normal antes de começar a enviar em volume.
  • Respeite o teto diário configurado na aba Configurações — evite aumentá-lo bruscamente de uma vez.
  • Mantenha o horário permitido de envio dentro de um período comercial razoável.
  • Só envie lembretes automáticos para quem consentiu receber mensagens — use o campo de opt-in do cliente em Configurações.
?

Ajuda rápida

Dúvidas frequentes

Uma mensagem que deveria ter sido enviada não chegou. O que fazer?
Verifique, nesta ordem: (1) a licença está ativa em Configurações; (2) o WhatsApp está conectado em QR Code; (3) o modelo correspondente está "Ativo" em Templates (e, se for um lembrete de dias, também em Automações); (4) existe algum item com erro na Fila de Envios ou um registro explicativo na aba Logs.
Posso personalizar o texto de qualquer mensagem automática?
Sim — todo o texto de cada modelo, na aba Templates, é livremente editável, incluindo quais variáveis usar e em que ordem.
O que acontece se eu desativar um modelo na aba Templates?
Nenhuma mensagem daquele tipo é enviada, mesmo que o evento correspondente aconteça no WHMCS. Ele pode ser reativado a qualquer momento.
Meus clientes não gostam do sistema de fila. Dá para enviar tudo na hora?
Sim. Em Configurações → Sistema de Fila de Envios, desligue "Usar a fila de envios". As mensagens transacionais (fatura criada/paga, ticket, serviço, boas-vindas, disparos manuais) passam a sair imediatamente, no momento do evento, e a aba "Fila de Envios" some. Os lembretes automáticos (vencimento de fatura, aniversário, alertas de serviço) continuam saindo na execução do cron diário do WHMCS e continuam respeitando a janela de horário, o "não enviar aos domingos/feriados", o teto diário e o intervalo entre envios. Mensagens que falharem no envio imediato voltam para a fila e são reprocessadas.
Quero enviar lembrete no WhatsApp quando uso "Enviar Lembrete" na lista de faturas do WHMCS.
Em Configurações → Lembrete Manual de Faturas, ligue a opção. A partir daí, sempre que um administrador seleciona faturas na tela de Faturas e clica em "Enviar Lembrete", além do e-mail o addon envia o template Lembrete de Fatura no WhatsApp para cada fatura. O modelo "Lembrete de Fatura" precisa estar Ativo na aba Templates. Os lembretes automáticos do cron não são afetados.
Como envio o link do comprovante de pagamento do Asaas na mensagem de fatura paga?
(1) Na aba Integrações → Asaas, ative a integração, cole a API Key do Asaas (no Asaas: Integrações → Chaves de API), escolha o Ambiente da chave (Produção ou Sandbox) e salve. (2) Na aba Templates, inclua a variável %comprovante_pagamento% no modelo Fatura Paga — instalações novas já vêm com ela no texto padrão. O link é buscado no Asaas no momento do envio. Ele só existe quando a cobrança foi paga de fato no Asaas: se a fatura for apenas marcada como paga manualmente no WHMCS, a variável sai em branco. Se o link não aparecer, procure na aba Logs o registro "Comprovante Asaas não aplicado…", que traz o motivo (ex.: "A chave de API fornecida é inválida" indica chave errada ou ambiente trocado).
Onde consigo suporte?
Entre em contato com quem forneceu a licença do addon, informando sua Chave de Licença para agilizar o atendimento.