WhatsApp¶

O WhatsApp é um aplicativo de mensagens instantâneas e voz sobre IP que permite aos usuários enviar mensagens, fazer chamadas e compartilhar conteúdo. As empresas podem usar o WhatsApp Business para se comunicar com seus clientes por texto, enviar documentos e fornecer suporte.

Com o aplicativo WhatsApp do Odoo, uma empresa pode conectar uma conta do WhatsApp Business (WABA) a uma base de dados Odoo, o que permite o seguinte:

• Receber e responder a mensagens do WhatsApp diretamente de uma base de dados do Odoo

• Criar novos modelos com marcadores de posição/variáveis dinâmicos

• Envie modelos pré-aprovados que usem variáveis dinâmicas, como:

  • Cotações do aplicativo Vendas

  • Recibos e faturas do aplicativo Ponto de Venda

  • Ingressos do aplicativo Eventos

O WhatsApp é um serviço de mensagens operado pela Meta, que é a empresa controladora do Facebook. O WhatsApp é comumente usado como uma ferramenta de comunicação em muitos países e por muitas empresas. Esta documentação abordará a integração de uma conta comercial do WhatsApp com o Odoo. A conta Meta da empresa é configurada no Odoo por meio de uma conexão API.

O conector do WhatsApp oferece suporte a dois fluxos: iniciado pela empresa e iniciado pelo cliente. Uma empresa pode iniciar uma discussão enviando um modelo para uma ou mais pessoas. Depois que o modelo é enviado, o destinatário pode responder para acionar uma discussão entre o remetente e o destinatário (uma janela de chat do app Mensagens será exibida se o cliente responder dentro de 15 dias).

Se a comunicação for iniciada pelo cliente (por exemplo, enviando mensagens para o número público do WhatsApp da empresa), o Odoo abrirá um chat em grupo com todos os operadores responsáveis por esse canal do WhatsApp.

Configuração do WhatsApp na Meta¶

Uma integração do WhatsApp com o Odoo usa uma conexão padrão API e é configurada na Meta nas seguintes etapas:

1. Criar uma conta Meta Business

2. Criar uma conta de desenvolvedor da Meta

3. Configure um app e um produto do WhatsApp no console do desenvolvedor da Meta

4. Teste a conexão da API.

Uma vez conectado, as mensagens são enviadas e recebidas pelo aplicativo Mensagens do Odoo, usando a API do WhatsApp.

Configuração da conta Meta Business¶

Para criar uma conta comercial com a Meta (proprietária do Facebook), navegue até: Facebook Business Manager. Comece clicando em Criar conta e, em seguida, insira o nome da empresa, o nome do administrador e um endereço de e-mail comercial. Em seguida, clique em Próximo e uma janela pop-up será exibida solicitando a confirmação do endereço de e-mail. Após a confirmação, clique em Concluído para fechar a janela.

Em seguida, siga as instruções no e-mail enviado pelo Facebook para confirmar a criação da conta comercial e concluir o processo de configuração.

Importante

Se a conta comercial estiver vinculada a uma conta pessoal do Facebook, o administrador deverá alternar entre a conta pessoal e a conta comercial durante o restante da configuração.

Para alternar para a conta comercial, acesse o Facebook Developer Console e clique no nome da conta no canto superior direito. Sob o título Business Accounts, clique na empresa desejada na qual a configuração do WhatsApp deve ocorrer. Essa será a conta para a qual o Odoo enviará e receberá mensagens do WhatsApp.

Criação de aplicativos¶

No painel do Meta for Developers, faça login com a conta de desenvolvedor da Meta. Se ainda não houver uma conta configurada, vincule uma conta do Facebook para criar uma conta de desenvolvedor da Meta.

Clique em Meus aplicativos no canto superior direito depois de fazer login com êxito na conta de desenvolvedor do Meta. Isso redirecionará o administrador para todos os aplicativos que o desenvolvedor configurou nessa conta de desenvolvedor específica. Clique em Criar aplicativo para iniciar o processo de configuração de um novo aplicativo Meta.

Tipo de aplicativo¶

Na página Criar um app, selecione Outros na seção intitulada Procurando outra coisa? e, em seguida, clique em Próximo para ser direcionado a outra página a fim de selecionar o tipo de aplicativo. Em seguida, clique na primeira opção listada sob o rótulo Selecionar um tipo de aplicativo, intitulada Business. Essa seleção permite a criação e o gerenciamento da API (Interface de Programação de Aplicativos) do WhatsApp.

Agora, clique em Próximo para configurar o aplicativo, conforme desejado. Quando o tipo de aplicativo tiver sido configurado, o administrador passará para a seção detalhes do aplicativo.

Detalhes do aplicativo¶

Na seção Detalhes do processo Criar um aplicativo, digite Odoo no campo abaixo do rótulo Adicionar um nome ao app.

Em seguida, insira o endereço de e-mail do desenvolvedor no campo abaixo do rótulo E-mail de contato do app.

Por fim, defina o campo Conta Business - Opcional para o perfil da conta Meta Business, usando o menu suspenso. Para concluir, clique em Criar app. Essa ação criará o aplicativo e solicitará os contratos Termos da plataforma da Meta e Políticas do Desenvolvedor.

Para aceitar os acordos, digite a senha do Facebook para fins de segurança e clique em Enviar para finalizar a criação do aplicativo. O navegador será direcionado para o painel do Meta for Developers.

Adicionar um produto do WhatsApp ao aplicativo¶

Agora que a estrutura básica do aplicativo foi criada, será necessário adicionar um produto ao aplicativo. Comece acessando o painel do aplicativo Meta navegando até https://developers.facebook.com/apps e clicando no aplicativo que está sendo configurado.

Na próxima página: como o WhatsApp será usado, clique em Configurar ao lado da caixa que contém o WhatsApp, localizada na parte inferior da página.

A página direciona para a página de configuração da API do WhatsApp Business Platform. Use o menu suspenso para selecionar o Meta Business a ser configurado para a opção Selecionar uma conta do Meta Business e, em seguida, clique em Continuar para confirmar a seleção.

Começar a usar a API do WhatsApp¶

Depois de concluir o assistente de produto do WhatsApp anterior e clicar em Continuar, o navegador será direcionado para a página Quickstart do WhatsApp; é nessa página Quickstart que você deve começar a configurar a API do WhatsApp adicionando um número de telefone e enviando uma mensagem de teste inicial.

Configuração da API¶

Depois de clicar em Começar a utilizar a API, a página navega para Configuração da API. Agora que o número de teste foi criado, uma mensagem de teste pode ser enviada para confirmar que o WhatsApp está funcionando corretamente. Para começar, navegue até a seção da página denominada Enviar e receber mensagens e clique no menu suspenso ao lado de Para, em Etapa 1 Selecione números de telefone.

Agora, selecione a única opção disponível: Gerenciar lista de números de telefone. Siga as etapas e adicione até cinco números para enviar as mensagens de teste gratuitas. Depois de inserir o código do país e o número de telefone adeequados, clique em Próximo.

Um código de verificação do WhatsApp Business é então enviado para o número de telefone, que precisa ser inserido na próxima tela para verificar a propriedade do número. Digite o código de verificação e clique em Próximo para verificar o número.

Enviar uma mensagem de teste pelo terminal¶

Em seguida, envie uma mensagem de teste pelo terminal. Na seção denominada Etapa 2 Enviar mensagens com a API, clique em Enviar mensagem. Uma mensagem de teste será enviada para o número de telefone que foi definido na seção anterior.

Após receber com êxito a mensagem no número, passe para a próxima seção para produzir e configurar webhooks.

Configuração do WhatsApp no Odoo¶

As próximas etapas configuradas nesta seção estão todas na base de dados do Odoo. Alguns valores diferentes para um token, número de telefone e IDs de conta precisam ser configurados no Odoo; esses valores são necessários para criar um URL de retorno de chamada e Token de verificação do Webhook, que são usados para configurar os webhooks (para receber mensagens de volta na base de dados).

No Odoo, navegue até o app WhatsApp ‣ Configuração ‣ Contas do WhatsApp Business. Em seguida, clique em Novo para configurar a conta comercial do WhatsApp no Odoo.

Em outra aba do navegador, navegue até https://developers.facebook.com ‣ Meus apps ‣ WhatsApp ‣ Configuração da API e, em seguida, copie os seguintes valores do console do desenvolvedor do Meta para os campos correspondentes no Odoo:

Para recuperar o Segredo do app, navegue até o console do desenvolvedor da Meta, https://developers.facebook.com/apps e selecione o aplicativo no qual o Odoo está sendo configurado. Em seguida, no menu do lado esquerdo, em Configurações do app, selecione Básico.

Em seguida, clique em Mostrar ao lado do campo Segredo do app e digite a senha da conta para verificar a propriedade. Copie o Segredo do app e cole o valor copiado no campo Segredo do app no painel de configuração do Odoo Conta do WhatsApp Business.

Para concluir a configuração da conta WhatsApp Business no Odoo, clique em Testar conexão. Se a configuração estiver definida corretamente, uma mensagem de sucesso em verde aparecerá no canto superior direito do painel..

Configuração de webhooks¶

Para configurar os webhooks para o WhatsApp no Odoo, navegue até https://developers.facebook.com/apps e selecione o aplicativo no qual o Odoo está sendo configurado. Em seguida, no cabeçalho do menu WhatsApp no lado esquerdo da tela, clique no item de menu Configuração de API. Finalmente, vá para a seção marcada como Etapa 3: Configurar webhooks para receber mensagens e clique em Configurar webhooks.

Dica

Outra maneira de configurar Webhooks é navegar até https://developers.facebook.com/apps e selecionar o aplicativo no qual o Odoo está sendo configurado. Em seguida, selecione Webhooks no menu à esquerda.

Na página Configuração do Webhook, clique em Editar, onde os valores URL de callback e Token de verificação do webhook do Odoo serão adicionados.

Em uma janela diferente do navegador, colete os valores necessários no Odoo navegando até o app WhatsApp ‣ Configuração ‣ Contas do WhatsApp Business e selecione a conta que está sendo configurada. Localize os valores na seção denominada Receber mensagens.

Copie e cole o URL de callback do Odoo no campo URL de callback da Meta. Da mesma forma, copie e cole o Token de verificação do webhook também no campo Token de verificação no console do desenvolvedor da Meta.

Por fim, clique em Verificar e salvar para registrar os valores no console do desenvolvedor da Meta.

Campos do webhook¶

Agora, insira campos individuais de webhook no console do desenvolvedor do Meta, na seção campos do Webhook. Clique em Gerenciar e, quando a janela pop-up aparecer, marque as caixas na coluna Assinar para os seguintes nomes de campos:

• account_update

• message_template_quality_update

• message_template_status_update

• mensagens

• template_category_update

Depois de fazer as seleções, clique em Concluído.

A configuração finalizada do Webhooks aparecerá assim no console do desenvolvedor do Meta:

Adicionar número de telefone¶

Para configurar o número de telefone a ser usado pelo WhatsApp no Odoo, volte para o console do desenvolvedor do Meta (https://developers.facebook.com/apps) e selecione novamente o aplicativo no qual o Odoo está sendo configurado. Sob o título do menu WhatsApp no lado esquerdo da tela, clique no item de menu Configurar API. A partir daí, vá para a seção marcada como: Etapa 5: Adicionar número de telefone e clique em Adicionar número de telefone.

Nos campos, insira um Nome da empresa e um Site da empresa ou página de perfil.

Conclua o preenchimento das informações comerciais selecionando em seguida o país em que a empresa faz negócios no menu suspenso na seção País. Adicione um endereço, se desejar; no entanto, essa informação é opcional. Depois de adicionar o local, clique em Próximo para continuar.

A página a seguir contém informações para o perfil do WhatsApp Business. Preencha as seções a seguir de acordo:

• Nome de exibição do perfil do WhatsApp Business

• Fuso horário

• Categoria

• Descrição do negócio (opcional)

Quando essas seções estiverem preenchidas, clique em Próximo. A página é atualizada e solicita que o administrador Adicione um número de telefone para o WhatsApp no respectivo campo. Aqui, insira o número de telefone a ser configurado no WhatsApp.

Em seguida, escolha um método de verificação para o número de telefone. Selecione Mensagem de texto ou Ligação e clique em Próximo para prosseguir.

O número de telefone inserido receberá um texto ou uma chamada telefônica do WhatsApp com um código, dependendo do método de verificação escolhido. Digite esse código de verificação no campo Código de verificação e clique em Próximo para concluir.

Token permanente¶

Após a conclusão da configuração e dos testes, um token permanente deve ser criado para substituir o Token temporário.

Comece navegando até https://business.facebook.com/ e, em seguida, vá para Configurações Business ‣ Usuário ‣ Usuários do sistema. Selecione um usuário do sistema existente ou crie um novo usuário do sistema clicando em Adicionar.

Os ativos agora devem ser adicionados ao usuário do sistema e, em seguida, um token permanente pode ser gerado.

Clique em Adicionar recursos e, quando a janela pop-up aparecer, selecione Aplicativos em Selecionar tipo de recurso. Em seguida, selecione o aplicativo Odoo e alterne as permissões para Ativo na opção Controle total. Defina essa nova configuração de permissão clicando em Salvar alterações, e uma janela de confirmação aparecerá, confirmando a adição do ativo ao usuário do sistema. Conclua clicando em Concluído.

Em seguida, o token permanente será gerado. Clique em Gerar novo token, e uma janela pop-up aparecerá perguntando para qual aplicativo esse token deve ser gerado. Selecione o App para o qual esse token se destina. Em seguida, determine a data de expiração de 60 dias ou Nunca.

Por fim, quando o Meta perguntar quais permissões o usuário do sistema deve conceder, adicione todas as seguintes permissões:

• WhatsApp_business_messaging

• WhatsApp_business_management

Quando as permissões estiverem definidas, clique em Gerar token. Copie o valor do token que aparece na tela a seguir.

Com esse valor de token, atualize o campo Token de acesso na conta do WhatsApp Business no Odoo, navegando até o app WhatsApp ‣ Configuração ‣ Contas do WhatsApp Business.

Entrar em operação com o aplicativo Meta¶

Por fim, para iniciar o aplicativo, o aplicativo Meta deve ser definido como Live no console do desenvolvedor do Meta. Navegue até https://developers.facebook.com/apps e clique no aplicativo que está sendo configurado. No menu superior, alterne o campo App Mode de Development para Live.

Depois que o aplicativo for ativado no console do desenvolvedor da Meta, um e-mail de confirmação será enviado ao administrador.

Modelos do WhatsApp¶

Os modelos do WhatsApp são mensagens salvas que são usadas repetidamente para enviar mensagens pela base de dados. Eles permitem que os usuários enviem comunicações de qualidade, sem precisar compor o mesmo texto mais d euma vez.

A criação de modelos diferentes, adaptados a situações específicas, permite que os usuários escolham a mensagem certa para o público certo. Isso aumenta a qualidade da mensagem e a taxa geral de engajamento do cliente.

Os modelos do WhatsApp podem ser criados nos consoles do Odoo e da Meta. O processo a seguir apresentará uma visão geral do processo de criação de modelos no Odoo e, posteriormente, na Meta.

Criar modelos no Odoo¶

Para acessar e criar modelos do WhatsApp, comece navegando até o painel app WhatsApp ‣ Modelos.

Na parte inferior do formulário de um modelo individual, há três abas: Corpo, Botões e Variáveis; essas três abas combinadas criam o modelo do WhatsApp.

O texto é inserido na guia Body e o conteúdo dinâmico que é chamado na guia Body é especificado na guia Variables. Cada parte do conteúdo dinâmico (por exemplo, marcadores de posição) na mensagem (corpo) é especificamente chamada e especificada na guia Variables.

Os modelos são layouts pré-fabricados que permitem aos usuários enviar mensagens de aparência profissional aos clientes. Esses modelos são capazes de conter dados dinâmicos que serão preenchidos na mensagem final usando variáveis definidas na configuração do modelo. Por exemplo, as mensagens podem conter o nome do usuário final, chamar a atenção para produtos específicos ou fazer referência a um pedido de venda, para citar algumas variáveis convenientes e impactantes.

Para criar um modelo do WhatsApp, vá para o painel do app WhatsApp ‣ Modelos e clique em New. No formulário, insira um Nome para o modelo e selecione um Idioma.

No menu suspenso Conta, selecione a conta do WhatsApp Business no Odoo à qual esse modelo deve se vincular. Em seguida, no campo :guilabel:`É aplicável a `, selecione o modelo ao qual a ação do servidor se aplicará para esse modelo.

Para pesquisar os campos disponíveis, digite o nome do front-end na caixa Pesquisar…. Isso encontrará o resultado de todos os campos disponíveis para o modelo (É aplicável a) para o qual o modelo foi criado.

Altere a Categoria para se adequar a uma categoria de Marketing, Utilitário ou Autenticação. Na maioria dos casos, as duas primeiras opções serão usadas, a menos que o usuário deseje enviar uma redefinição de senha ou algo relacionado à segurança. Defina como Marketing se houver algo promocional sendo enviado e defina como Utilitário se houver mensagens transacionais gerais sendo enviadas (ou seja, pedido de venda, ingresso de evento etc.).

Adicione Usuários que tenham permissão para usar esse modelo. Na coluna do lado direito, um Tipo de cabeçalho também pode ser configurado junto com um mensagem de cabeçalho.

Os Tipos de cabeçalho disponíveis são os seguintes:

• Texto

• Imagem

• Vídeo

• Documento

• Localização (as variáveis precisam ser definidas)

Navegue até a aba Conteúdo para configurar a mensagem principal do modelo.

Quando todas as alterações necessárias forem feitas no modelo, clique no botão Enviar para aprovação no canto superior esquerdo. Isso fará com que o status do modelo seja alterado para Pendente.

O status permanecerá como Pendente até que uma decisão tenha sido tomada pelo Meta, por meio da qual um e-mail de confirmação será enviado indicando que o modelo foi aprovado (ou rejeitado). Os modelos precisarão então ser sincronizados a partir da base de dados do Odoo.

Consulte esta seção para obter mais informações sobre sincronizar modelos.

Botões¶

Os botões podem ser adicionados à mensagem na aba Botões. Digite o Tipo (ou Visitar site, Ligar para o número ou Resposta rápida) e, em seguida, especifique o Texto do botão, Ligar para o número ou URL do site (incluindo Tipo de URL), dependendo do Tipo do botão.

Usar marcadores de posição e variáveis¶

As variáveis dinâmicas fazem referência a determinados campos na base de dados do Odoo para produzir dados exclusivos na mensagem do WhatsApp ao usar um modelo. As variáveis dinâmicas são codificadas para exibir campos de dentro da base de dados, referenciando campos de dentro de um modelo.

As variáveis dinâmicas podem ser adicionadas ao Conteúdo adicionando marcadores de posição no texto. Para adicionar um marcador de posição no corpo da mensagem, digite o seguinte texto {{1}}. Para o segundo marcador de posição, digite {{2}} e aumente gradualmente à medida que mais forem adicionados ao texto.

Esses marcadores de posição devem ser configurados na aba Variáveis do modelo antes de serem enviados para aprovação da Meta. Para editar as variáveis dinâmicas em um modelo, primeiro altere o Tipo para Campo do modelo. Isso permite que o Odoo faça referência a um campo dentro de um modelo para produzir dados exclusivos na mensagem que está sendo enviada.

Em seguida, edite o Campo das variáveis dinâmicas. O campo É aplicável a no modelo deve ser editado antes para garantir que o modelo e o campo corretos sejam referenciados.

Para pesquisar os campos disponíveis, digite o nome de front-end do campo na caixa de pesquisa. Isso encontrará um resultado de todos os campos disponíveis para o modelo (Se aplica a) para o qual o modelo foi criado. Pode haver vários níveis que precisam ser configurados.

Aprovação de modelo da Meta¶

Depois de atualizar as variáveis dinâmicas no modelo, o modelo precisa ser enviado ao Meta para aprovação novamente. Clique em Enviar para aprovação para iniciar o processo de aprovação. Um e-mail será enviado ao administrador da conta do Meta quando o modelo for aprovado.

Após a aprovação da Meta, sincronize os modelos novamente na base de dados do Odoo. Consulte esta documentação: Sincronizar modelos.

Sincronizar modelos¶

Os modelos devem ser sincronizados na base de dados do Odoo depois de serem aprovados pela equipe do Meta. Para fazer isso, comece acessando o aplicativo de WhatsApp ‣ Configurações ‣ Contas do WhatsApp Business e selecione a configuração que deve ser sincronizada. Na seção marcada como Envio de mensagens, na parte inferior, clique em Sincronizar modelos. O Meta atualizará os modelos aprovados para que eles possam ser utilizados com vários aplicativos na base de dados.

Uma mensagem de sucesso em verde é exibida no canto superior direito com o número de modelos atualizados.

Criação de modelos na Meta¶

Primeiro, navegue até o painel de modelos do WhatsApp do Meta e, em seguida, vá para Ferramentas da conta ‣ Modelos de mensagem.

Para criar um modelo do WhatsApp, clique no botão azul Criar modelo e, em seguida, selecione a Categoria. As opções listadas incluem: Marketing, Utilitário e Autenticação. Na maioria dos casos, as duas primeiras opções serão usadas, a menos que o usuário queira enviar uma redefinição de senha ou algo relacionado à segurança.

Digite o Nome do modelo e, em seguida, selecione um Idioma para o modelo.

Depois de fazer as seleções apropriadas, clique em Continue no canto superior direito. A página é redirecionada para a página Editar modelo. Aqui, o Header, Body, Footer e Buttons são configurados. À direita do modelo, há uma visualização de como o modelo será exibido na produção.

Quando todas as alterações necessárias forem feitas no modelo, clique no botão Enviar no canto superior direito. Uma janela de confirmação é exibida para confirmar o idioma - clique em Confirmar para aprovar e, em seguida, outra janela é exibida informando que o modelo será enviado ao Meta para revisão e aprovação.

O Status do modelo permanecerá em Em revisão até que uma decisão tenha sido tomada pela Meta. Depois que um e-mail de confirmação for recebido aprovando o modelo, os modelos precisarão ser sincronizados a partir do base de dados do Odoo.

Notificações¶

As notificações no WhatsApp são tratadas de forma semelhante a uma conversa por mensagem no Odoo. Uma janela pop-up é exibida com a conversa do cliente. Por padrão, as notificações são definidas na configuração da conta do WhatsApp Business no Odoo.

As configurações de notificação podem ser ajustadas acessando o aplicativo de WhatsApp ‣ Configurações ‣ Contas do WhatsApp Business. A partir daí, selecione a conta e role para baixo até a seção Controle onde as notificações são tratadas. Sob o título Notificar usuários, digite no campo quais usuários devem ser notificados para esse canal específico do WhatsApp.

Adicionar usuários ao chat¶

Os usuários podem ser adicionados a um chat do WhatsApp expandindo a janela pop-up do WhatsApp. As conversas do WhatsApp estão localizadas no aplicativo Mensagens. Clique no ícone 👤+ (adicionar usuário) ao lado dele, e uma janela será exibida para convidar usuários para a conversa.

FAQ da API do WhatsApp¶

Verificação¶

A partir de 1º de fevereiro de 2023, se o aplicativo Meta exigir acesso de nível avançado às permissões, talvez seja necessário concluir uma verificação comercial completa. Isso inclui o envio de documentos comerciais para a Meta. Consulte esta documentação.

Erros de modelo¶

A edição de modelos pode causar tracebacks e erros, a menos que seja seguido o exato processo descrito acima aqui: (Modelos do WhatsApp).

Erro de validação de duplicata¶

Ao sincronizar os modelos, pode haver um caso em que existam vários modelos com o mesmo nome no gerenciador de negócios do Meta e no Odoo. Isso causa um erro de validação duplicado. Para corrigir esse problema, renomeie o nome do modelo duplicado no Odoo e sincronize os modelos mais uma vez seguindo as etapas aqui: Sincronizar modelos.

Erros de token¶

Erro do usuário¶

Se o token temporário não for substituído por um token permanente, um erro de usuário será populado no Odoo ao testar a conexão após a falha no envio. Para corrigir esse problema, consulte Token permanente.

Erro 100 de usuário do sistema¶

Se o usuário do sistema for um Funcionário ao configurar o token permanente, será exibido um erro 100 de usuário.

Para corrigir esse erro, crie um usuário Admin seguindo o processo descrito aqui: Token permanente.