WhatsApp do WHMCS

Documentação para o Módulo de Notificações para WhatsApp com Meta Cloud API, Evolution API ou Baileys API para o WHMCS  automatiza a comunicação com os usuários por WhatsApp.
Módulo de Notificações WhatsApp no WHMCS
WhatsApp Evolution API, Baileys API e Meta Cloud WhatsApp API

Requisitos para instalação e configuração do módulo

O módulo oficial do WhatsApp permite o envio de mensagens por meio de três plataformas principais: WhatsApp Meta Cloud API , Evolution API e Baileys API. Antes de começar a utilizá-lo, é necessário seguir algumas etapas de configuração. A principal vantagem desse módulo é a flexibilidade de escolha entre as três plataformas para o disparo das mensagens, garantindo que a entrega seja realizada de acordo com sua preferência.

WhatsApp Meta Cloud API

A Cloud API do WhatsApp Business é a solução oficial da Meta (Facebook) para permitir que empresas integrem o WhatsApp às suas plataformas, sistemas e aplicativos de forma escalável e segura. Diferente de soluções não oficiais, essa API roda na infraestrutura da Meta, eliminando a necessidade de servidores próprios para manter a comunicação com o WhatsApp.

  1. O módulo de notificação do WHMCS para o WhatsApp precisa de uma conta verificada no Meta (Facebook), atual proprietária da plataforma do WhatsApp. Veja como verificar sua conta no Meta.
  2. É necessário configurar uma conta e um app de desenvolvedor da Meta. Para atender a esses requisitos, acesse o link https://developers.facebook.com/docs/whatsapp/cloud-api/get-started
  3. O número usado no WhatsApp API Cloud deve ser apenas para esse fim.
  4. Criar modelos de mensagens, esses modelos serão as mensagens disparadas, elas precisam ficar definidas dentro da plataforma do WhatsApp, veja como criar.

O que é o Evolution API

A Evolution API é uma solução de terceiros que atua como um intermediário para facilitar a integração e o envio de mensagens via WhatsApp Business API. Ela oferece uma interface simplificada e recursos adicionais, como automação de mensagens, gerenciamento de fluxos de comunicação e suporte para envio de diferentes tipos de conteúdo (texto, imagens, arquivos, etc.).

Essencialmente, ela permite que empresas ou desenvolvedores utilizem a infraestrutura do WhatsApp Business de forma mais acessível e personalizada, sem precisar lidar diretamente com a complexidade da API oficial do Meta. É ideal para quem busca escalabilidade, flexibilidade e facilidade na implementação de sistemas de comunicação empresarial.

Para utilizar o módulo com a Evolution API , é necessário que o serviço esteja rodando em uma infraestrutura como uma VPS, Docker ou similar. Caso precise de um serviço baseado na Evolution API, entre em contato para obter informações sobre valores e condições.

Você pode optar por usar o serviço conosco ou implementá-lo diretamente dentro da sua própria infraestrutura, de acordo com sua preferência.

O que é o Baileys API

O Baileys API é uma biblioteca em Node.js que permite a comunicação direta com o WhatsApp Web por meio de WebSockets, sem depender da API oficial do WhatsApp Business. Desenvolvido como um projeto open-source, o Baileys é amplamente utilizado por desenvolvedores que desejam criar bots, automações e integrações personalizadas para o WhatsApp.

Diferente da API oficial do WhatsApp Business, que requer aprovação do Meta Business e possui diversas restrições, o Baileys funciona simulando uma sessão do WhatsApp Web. Ele permite o envio e recebimento de mensagens, gerenciamento de grupos, manipulação de mídia (como imagens, áudios e vídeos), além de outras funcionalidades avançadas.

Para utilizar o módulo com a Baileys API , é necessário que o serviço esteja rodando em uma infraestrutura como uma VPS, Docker ou similar. Caso precise de um serviço baseado na Baileys API, entre em contato para obter informações sobre valores e condições.

Você pode optar por usar o serviço conosco ou implementá-lo diretamente dentro da sua própria infraestrutura, de acordo com sua preferência.

Qual API usar para o envio de notificações no WHMCS?

Quando se trata de integrar o WhatsApp ao WHMCS para o envio de notificações, é importante escolher a API que melhor atende às necessidades do seu negócio. As três principais opções são:

1. Baileys API (Não Oficial)

  • Vantagens:
    • ✅ Código aberto e gratuito
    • ✅ Permite automações e personalizações avançadas
    • ✅ Suporte a múltiplos números e instâncias
    • ✅ Não exige aprovação da Meta
  • Desvantagens:
    • ❌ Maior risco de banimento do número
    • ❌ Requer infraestrutura própria (servidor)
    • ❌ Pode apresentar instabilidade em atualizações do WhatsApp Web

2. Cloud API do WhatsApp Business (Oficial)

  • Vantagens:
    • ✅ Solução oficial da Meta, evitando bloqueios
    • ✅ Hospedada na nuvem da Meta, sem necessidade de servidores próprios
    • ✅ Conformidade com as políticas do WhatsApp
    • ✅ Melhor escalabilidade e suporte técnico
  • Desvantagens:
    • ❌ Custo por mensagem enviada
    • ❌ Exige aprovação de templates para mensagens proativas
    • ❌ Processo de verificação e conformidade necessário

3. Evolution API (Alternativa Profissional)

  • Vantagens:
    • ✅ Maior estabilidade em comparação com soluções não oficiais
    • ✅ Melhor taxa de entrega e suporte a alto volume de mensagens
    • ✅ Possibilidade de integração com múltiplos números
    • ✅ Suporte a recursos avançados como mensagens interativas
  • Desvantagens:
    • ❌ Não é uma solução oficial da Meta
    • ❌ Possui custos operacionais
    • ❌ Pode exigir configurações avançadas para otimização

A vantagem do módulo WHMCS desenvolvido

Nosso módulo exclusivo para WHMCS resolve esse dilema ao permitir o uso simultâneo de todas essas plataformas. Isso possibilita configurar estratégias híbridas, onde:

  • ✅ O Baileys API pode ser utilizado para mensagens internas e automações personalizadas.
  • ✅ A Cloud API do WhatsApp Business pode ser utilizada para mensagens críticas, como faturas e notificações importantes, garantindo entrega segura.
  • ✅ O Evolution API pode ser usado para atender demandas mais robustas, oferecendo maior estabilidade e suporte a mensagens em larga escala.
  • ✅ Envio de mensagem de acordo com a definição do idioma do usuário definido no perfil do cliente.
  • ✅ Uso de múltiplos números de WhatsApp para disparo de mensagens.

Dessa forma, você tem flexibilidade e redundância, garantindo que as notificações do WHMCS sejam entregues pelo melhor canal disponível, reduzindo custos e riscos de falhas.

Download WhatsApp para WHMCS

Para fazer a sua instalação no sistema WHMCS. O primeiro passo é fazer o Download do módulo de notificação. Após o Download, inicia-se o processo de instalação e configuração do módulo de notificações no WHMCS. A seguir as etapas desse processo:

Passo 1 | Preparando os arquivos

Primeiro, extraia o arquivo .zip do módulo (baixado no seu computador), os arquivos descompactados ficam dentro da pasta whmcs-gateway-preferences, dentro dessa pasta tem um arquivo INSTALL.txt e uma pasta modules. Faça o upload da pasta modules no raiz do sistema WHMCS;

Extrair pasta

Passo 2 | Acessando as opções

Depois, dentro do WHMCS, acesse o item de configurações do menu superior (cujo ícone é uma chave fixa) e clique no subitem Opções;

Menu WHMCS

Passo 3 | Ativando Módulos Addon

Na página seguinte, vá até o campo de pesquisa (na lateral esquerda da tela) e digite o termo “Módulos Addon” (para ativar os módulos complementares). Depois, clique no card que aparecerá com esse mesmo nome.

Pesquisa de módulos WHMCS

Passo 4 | Concluindo a ativação

Na página dos módulos complementares, procure na tabela o módulo Notificação WhatsApp. Depois, clique no botão Ativar.

Módulo de notificação WhatsApp

O banco de dados preferencialmente deve estar definido com a ENGINE InnoDB, a tabela tblclients obrigatoriamente precisa estar em InnoDB, caso contrário não irá conseguir ativar e irá aparecer um erro similar a este: Unable to create database table: PDOException: SQLSTATE[HY000]: General error: 1005 Can’t create table: errno: 150 “Foreign key constraint is incorrectly formed.

Esse foi o passo a passo de instalação do módulo no WHMCS. Agora, veja como configurá-lo para começar a usá-lo:

Passo 5 | Configurando o módulo

Defina primeiro quem terá acesso à página de configuração do módulo. Para isso, clique no botão Configurar e escolha entre: Administrador, Operador de venda e Operador de suporte. Para finalizar essa parte, clique no botão Salvar alterações.

Configurações do módulo de notificação

Passo 6 | Acessando configurações

Em seguida, para entrar na página de configuração do módulo, acesse o item Addons do menu superior e clique no subitem Notificação WhatsApp;

Complementos do módulo de notificações

Passo 7 | Configurando o módulo

A página seguinte é a de configurações gerais. No campo “Licença Link Nacional”, deixe o campo de licença sem preencher. Caso tenha adquirido uma licença conosco insira ela nesse campo. Recomendamos habilitar a opção Depurar (que faz o registro dos logs de erro). O campo opcional Nome padrão, é o nome utilizado quando um cliente não tem nome definido no seu perfil, nossa sugestão é definir como: Cliente. Depois, clique no botão Salvar.

Configurações gerais do módulo

O Addon para WHMCS WhatsApp atualmente esta disponível em 3 idiomas, caso deseje uma nova tradução entre em contato.

WHMCS WhatsApp idioma

Passo 8 | Opções do Whatsapp

Na aba WhatsApp, clique no subitem Configurações.

Configurações WhatsApp

Passo 9 | Preenchendo os campos

Dentro da página das configurações do WhatsApp preencha os campos:
ID do campo personalizado do número do WhatsApp no perfil do cliente;
Token de acesso do usuário: preencha com o seu token de acesso à API do WhatsApp;
ID da conta comercial: preencha este campo com o número identificador da sua conta no WhatsApp Business;
Identificação do número de telefone: preencha com o número de telefone usado na sua conta do WhatsApp Business.

Configurações WhatsApp

Passo 10 | Salvando as configurações

Clique no botão Salvar para concluir a configuração do módulo de notificações via WhatsApp.

Esse foi o passo a passo de configuração do WhatsApp. Agora, veja como configurar as mensagens templates.

Passo 11 | Message templates

Os templates na API WhatsApp Cloud da Meta se referem a formatos de mensagens predefinidos que são usados para enviar mensagens automatizadas, estruturadas e consistentes por meio do WhatsApp. Esses templates são projetados para simplificar a comunicação com usuários, clientes ou clientes, fornecendo uma maneira padronizada de transmitir informações ou atualizações. Veja como criar.

WhatsApp WHMCS message template meta

Passo 12 | Configurando o WHMCS WhatsApp Message template

É chegada a hora de realizar a configuração da notificação utilizando o modelo de mensagem do WhatsApp API. Ao criar o modelo de mensagem no Meta, é possível estabelecer parâmetros que serão substituídos pelos dados do sistema do WHMCS.

Você pode selecionar o idioma que deseja que as notificações sejam enviadas. Cada template pode ser traduzido para diversos idiomas:

WhatsApp WHMCS Notificação
Notificação com Multi-Idiomas no WHMCS
Template Traduzido WHMCS

Passo 13 | Message templates

Após a criação dos modelos de mensagem no Meta, é o momento de vinculá-los ao WHMCS, permitindo que sejam acionados de acordo com as notificações ativadas. Após a instalação das notificações disponíveis para download gratuito no Github, ativá-las é simples: basta clicar no botão ‘Ativar’.

WHMCS WhatsApp ativar message template

Passo 14 | Notificações WHMCS com WhatsApp

Agora é o momento de configurar a notificação utilizando o modelo de mensagem do WhatsApp. Ao criar o modelo de mensagem no Meta, é possível definir parâmetros que serão substituídos pelos dados do sistema do WHMCS. Esses parâmetros podem ser personalizados no cabeçalho, corpo e nos botões da mensagem. Após a configuração com os parâmetros desejados, basta clicar no botão ‘Salvar’.

Configurando as notificações do message template do WhatsApp dentro do WHMCS

Notificações WHMCS com Evolution WhatsApp

Agora é hora de configurar as notificações utilizando a Evolution API . O processo com a Evolution é mais simplificado, mas será necessário fornecer algumas informações essenciais: o URL da API da Evolution, a chave de licença da API e a definição do campo do WhatsApp. Após adicionar as informações, salve-as. Se tudo estiver configurado corretamente, será exibido um QR Code para que você realize a leitura diretamente no seu WhatsApp.

WhatsApp WHMCS notificação Configuração QRCode Evolution API

Mensagens de Notificações WHMCS com Evolution WhatsApp

Para criar as mensagens de disparo, o processo é realizado diretamente no módulo. Acesse a aba Plataforma > WhatsApp Evolution > Notificações .

WhatsApp WHMCS mensagens com Evolution API

Criando ou Editando as Mensagens de Notificações

O primeiro passo é clicar no botão Configurar na lista de notificações. Isso permitirá iniciar a criação, edição ou adição de mensagens em outro idioma.

WhatsApp WHMCS mensagens com Evolution API

Criando uma Nova Mensagem de Notificações

O primeiro passo é clicar no botão Configurar na lista de notificações. Ao criar pela primeira vez, você precisa selecionar o idioma da mensagem.

WhatsApp WHMCS nova mensagem com Evolution API

Após selecionar o idioma, o campo de mensagem será disponibilizado para a criação da notificação. É possível utilizar parâmetros do próprio WHMCS dentro da mensagem. Veja um exemplo na imagem abaixo:

WhatsApp WHMCS nova mensagem com Evolution API

Após preencher a mensagem, clique em Salvar para que ela fique disponível no idioma selecionado anteriormente. A notificação será configurada de acordo com o hook especificado. No exemplo, ela será usada toda vez que um usuário responder a um chamado.

WhatsApp WHMCS nova mensagem com Evolution API

Adicionar Novo Idioma para a Mensagem

Para adicionar um novo idioma, após salvar a mensagem pela primeira vez, será exibida uma opção para incluir outro idioma. Basta clicar no link para criar a mensagem em um idioma diferente para a mesma notificação (Hook).

WhatsApp WHMCS nova mensagem em outro idioma

Clique em Salvar para que o novo idioma seja adicionado como opção da notificação. A notificação será utilizada com base no idioma definido no perfil do cliente. Por exemplo, se o perfil do cliente estiver configurado em inglês e a notificação incluir inglês e português, a mensagem será enviada no idioma inglês.

Passo 15 | Visualizar licença da Link Nacional

A chave de licença da Link Nacional é opcional, caso tenha aquirido ela, acesse a área do cliente, entre no item Serviços do menu superior e clique no subitem Minhas licenças. Ao entrar na página, copie o código da licença e o adicione nas configurações do Addon dentro do administrativo do seu WHMCS.

Adicionar Plugin
WhatsApp modelo mensagem

Requisitos e compatibilidade

  • WhatsApp Cloud API (info)
  • ChatWoot
  • Evolution API
  • Baileys API
  • Número de telefone fixo ou celular
  • Banco de dados em InnoDB
  • PHP 8.1+
  • IonCube 12+
  • WHMCS 8.6+

Changelog | Atualizações e versões do módulo

Versão do gateway 4.1.3
  • Corrigir tratamento de message template

Data de atualização: 21/05/25

Versão do gateway 4.1.2
  • Ajustes na interface;
  • Ajustes na feature de bulk messaging;
  • Reimplementação dos custom attributes do Chatwoot Live Chat.

Data de atualização: 19/05/25

Versão do gateway 4.1.1
  • Remover breakline de parâmetro para compatibilidade com nova regra da API da Meta.

Data de atualização: 02/05/2025

Versão do gateway 4.1.0
  • Correção de bugs de banco de dados.

Data de atualização: 30/04/2025

Versão do gateway 4.0.0
  • Melhoria na visualização das notificações;
  • Configuração unificada de notificações para Meta WhatsApp, Evolution API e Baileys;
  • Melhoria nos relatórios de envio de notificações;
  • Envio em massa de mensagens;
  • Suporte multilíngue para notificações;
  • Facilidade na configuração de notificações personalizadas.

Data de atualização: 29/04/2025

Versão do gateway 3.9.1
  • Corrigir script de criação das tabelas do BD.

Data de atualização: 22/04/2025

Versão do gateway 3.9.0
  •  Integração com Baileys.

Data de atualização: 28/03/2025

Versão do gateway 3.8.1
  • Atualizações no banco de dados.

Data de atualização: 24/03/2025

Versão do gateway 3.8.0
  • Integração com WhatsApp Evolution API.

Data de atualização: 03/03/2025

Versão do gateway 3.7.1
  • Correção referência de idioma.
  • Configuração do campo ID da conta no ChatWoot.

Data de atualização: 21/02/2025

Versão do gateway 3.7.0
  • Adição de multi-idiomas para notificações da implementação do WhatsApp Meta;
  • Adicionar lib FPDI para possibilitar edição de PDFs de faturas;
  • Exibir warning quando ambiente não é compatível com requisitos do módulo.

Data de atualização: 22/01/2025

Versão do gateway 3.6.0
  •  Atualização da versão do Whatsapp API;
  • Menu de configurações atualizado para exibir a versão atual da API utilizada pelo módulo;
  • Adição de compatibilidade com PHP 8.1.

Data de atualização: 21/11/2024

Versão do gateway 3.5.1
  • Correção de erro ao enviar notificações com PDF do Whatasapp.

Data de atualização: 05/11/2024

Versão do gateway 3.5.0
  • Correção de erro ao enviar notificações manuais do Whatasapp.

Data de atualização: 28/10/2024

Versão do gateway 3.4.8
  • Correção de referência para scripts JS.

Data de atualização: 18/09/2024

Versão do gateway 3.4.7
  • Correção de referência dos artefatos carregáveis do módulo para reconhecer quando o WHMCS se encontra em subdiretório.

Data de atualização: 18/09/2024

Versão do gateway 3.4.6
  • Correção de erro de build SQL.

Data de atualização: 12/08/2024

Versão do gateway 3.4.6
  • Correção de erro de build SQL.

Data de atualização: 12/08/2024

Versão do gateway 3.4.5
  • Melhoria de logs e tratamento de erros;
  • Remoção de chave estrangeira para evitar erros de setup no WHMCS;
  • Adição de tratamento para casos de clientes sem custom fiel de número de whatsapp;
  • Melhoria no tratamento de casos de clientes não existentes.

Data de atualização: 09/08/2024

Versão do gateway 3.4.4
  • Correção de problema no banco de dados;
  • Correção de não reconhecimento de templates de idiomas diferentes;
  • Adição de configuração de templates.

Data de atualização: 01/07/2024

Versão do gateway 3.4.3
  • Correção de problemas com criação de tabelas no banco de dados;
  • Correção de problema de página de configurar notificações caso não haja notificações.

Data de atualização: 20/03/2024

Versão do gateway 3.4.2
  • Correção arquivo de instalação de banco de dados.

Data de atualização: 07/03/2024

Versão do gateway 3.4.1
  • Ajustar lógica para envio de nota privada para clientes não cadastrados
  • A nova versão já está disponível para download no Extra.

Data de atualização: 30/01/2024

Versão do gateway 3.4.0
  • Mudança de nomenclatura bate-papo -> integração;
  • Adicionada descrição para a tela de integração com chatwoot;
  • Adicionados links para acesso às informações da instância do chatwoot dinamicamente;
  • Renomeado módulo para WhatsApp e Chatwoot;
  • Implementar configuração por notificação.

 

Data de atualização: 29/01/2024

Versão do gateway 3.3.0
  • Remover exclusão das tabelas do banco ao desativar módulo;
  • Corrigir links para o perfil do cliente colocados no perfil do Chatwoot.

 

Data de atualização: 10/11/2023

Versão do gateway 3.2.1
  • Correções nas traduções;
  • Correções na classe Config quando tabela _config não existe.

Data da atualização: 31/08/2023

Versão do gateway 3.2.0
  • Adicionar suporte a internacionalização do módulo e das notificações;
  • Adicionar suporte ao Live Chat do Chatwoot;
  • Melhorar registro de relatórios de envio de notificações;
  • Ajustar responsividade do módulo em dispositivos mobile;
  • Destacar botões de como baixar e criar a própria notificação.

Data da atualização: 31/08/2023

Versão do gateway: 3.1.1
  • Correções nas verificações envolvendo licença
  • Correção na geração de associação entre notificação e message template

Data da atualização: 04/08/2023

Versão do gateway: 3.1.0
  • Adicionar página inicial com documentações e links úteis do módulo
  • Adicionar suporte a parâmetros do tipo texto no cabeçalho
  • Implementar libphonenumber para validação do telefone do cliente
  • Atualizar lógica de licença para aceitar mais de 3 notificações instaladas no plano gratuito
  • Adicionar modal para exibir relatório de notificações dentro do perfil do cliente

Data da atualização: 04/08/2023

Versão do gateway: 3.0.1
  • Corrigir bugs de primeira instalação

Data da atualização: 27/06/2023

Versão do gateway: 3.0.0
  • Reimplementar e simplificar criação de notificações
  • Suporte a geração de PDF temporário de fatura
  • Melhorar configuração de message template com notificação
  • Adicionar tela de relatórios
  • Simplificar organização do repositório

Data da atualização: 21/06/2023

Versão do gateway: 2.3.3
  • Alterar coluna value para longText, por questões de compatibilidade com versões antigas de bancos
  • Corrigir links para página de logs

Data da atualização: 08/05/2023

Versão do gateway: 2.3.2
  • corrigir erro na página de associação de templete à notificação

Data da atualização: 03/05/2023

Versão do gateway: 2.3.1
  • Correção de erro na tela administrativa de fatura, devido a tabela mod_paghiper não existir.

Data da atualização: 25/04/2023

Versão do gateway: 2.3.0
  • Adicionar notificação AfterModuleSuspend;
  • Migrar configurações para a tela do Chatwoot (Escutar WhatsApp);
  • Corrigir select de message templates, adicionando limit=200.

Data da atualização: 29/03/2023

Versão do gateway: 2.2.1
  • Atualizar lógica para criação de hooks customizados.

O tutorial para criação de hooks customizados pode ser acessado na Wiki do repositório open source do módulo: How to create a customized hook.

No Readme, podem ser encontradas mais informações sobre como configurar o ambiente de desenvolvimento para criação de hooks customizados: README.

Versão do gateway: 2.2.0
  • Implementar verificação de nova versão;
  • Adicionar logo e descrição na listagem de addons;
  • Adicionar botão para acesso aos logs do módulo.

Notificação sobre nova versão aparece no menu das páginas do módulo. Ao lado, o botão de logs.

Versão do gateway: 2.1.0
  • Correções de erros gramaticais;
  • Adicionar configuração para definir nome padrão de clientes que não têm os campos de nome preenchidos;
  • Melhorias no feedback na tela de envio de lembrete de fatura;
  • Correção de bugs no hook de pedido criado.
Versão do gateway: 2.0.0
  • Adição do Composer e dependências;
  • Adição de suporte a criação de hooks customizados;
  • Migração e melhorias na tela de configurações;
  • Melhorias na tela de registro e edição de message template;
  • Adição de uma tela para ajuda de uso.
Versão do gateway: 1.1.0
  • Adicionar arquivos para desenvolvimento com Dev Container;
  • Adicionar hook “OrderCreated” para WhatsApp;
  • Adicionar hook “OrderCreated” para canal do WhatsApp no Chatwoot.
Versão do gateway: 1.0.0
  • Painel admin de visualização de fatura;
  • Enviar lembrete de fatura com apenas texto;
  • Enviar lembrete da fatura com boleto do PagHiper;
  • Caso sucesso, envia mensagem semelhante para o Chatwoot como privada
Precisa de ajuda?

Precisa de ajuda?

Precisa de ajuda com o seu módulo de notificações via WhatsApp API ou com as configurações gerais do sistema WHMCS? Entre em contato conosco. Temos profissionais especialistas nessa plataforma e prontos para resolver a sua demanda.