Ir para o conteúdo principal

Utilizando envios automáticos

Envio de Mensagens via API Oficial do WhatsApp (Automação de Campanhas)

Este documento descreve o processo de configuração e envio de mensagens através de automação de campanhas utilizando primariamente um canal oficial do WhatsApp (Meta).

Pré-requisitos

Antes de iniciar, é necessário que:

  • O canal de WhatsApp já esteja devidamente configurado no sistema.

  • O template de mensagem esteja aprovado pela Meta.

⚠️ Importante

A API oficial da Meta não permite o envio de mensagens livres.
Somente é permitido o envio de templates previamente aprovados pela moderação da Meta.

Além disso:

A criação do template deve obrigatoriamente ser feita através do sistema da Tallk.me.
Não crie templates diretamente pela Meta ou por BSPs parceiros.


1. Criação do Template

O primeiro passo é criar um template de mensagem dentro da plataforma.

image.png

Após a criação, o template será enviado para aprovação da Meta.


2. Criação da Campanha

Após a criação do template, é necessário criar uma campanha de envio.

image.png

Caso o template utilize variáveis, será necessário informar a correlação entre a ordem da variável (1ª,2ª,3ª...) e o valor que ela deve assumir (dentre as opções disponíveis) no momento da criação da campanha e posteriormente os valores devem ser passados no payload da URI apropriada.


3. Envio das Mensagens

Depois que o template e a campanha estiverem configurados, existem duas formas de adicionar contatos para envio:

  • Importação de lista de contatos pela interface

  • Envio automático através da API

Neste documento vamos tratar somente os dois métodos disponíveis na API.

Localização na plataforma de informações importantes:

image.png


Método 1 — Template sem Variáveis

Caso o template não utilize variáveis, é possível inserir o contato na campanha através de uma requisição HTTP GET.

Exemplo de URI

https://api.tallk.me/dbdial_webapi.php?acao=insere_whats_simples&id_cliente=123&id_wpp=123&token=XJS83HAUQORDIGHA82&num_dest=11988887777&txtmsg=teste&id_campanha=12345

Parâmetros da URL

Parâmetro Descrição
acao Identifica internamente a ação a ser executada (insere_whats_simples)
id_cliente Identificador do cliente (disponível no canto superior direito da plataforma)
id_wpp Identificador do canal de WhatsApp (disponível na tela de números de envio)
token Token de autorização do cliente para acesso à API
num_dest Número de telefone que receberá a mensagem
txtmsg Texto da mensagem. Em caso de API oficial este campo é ignorado, pois a mensagem enviada será o template
id_campanha Identificador da campanha previamente criada

Método 2 — Template com Variáveis

Caso o template utilize variáveis, é necessário enviar os valores dessas variáveis no payload da requisição.

Neste caso deve ser utilizada uma requisição HTTP POST.

Endpoint

https://api.tallk.me/dbdial_webapi.php?acao=envio_whats_simples_v2&id_cliente=123&token=XJS83HAUQORDIGHA82

Parâmetro Descrição
acao Identifica internamente a ação a ser executada (envio_simples_whats_v2)
id_cliente Identificador do cliente (disponível no canto superior direito da plataforma)
id_wpp Identificador do canal de WhatsApp (disponível na tela de números de envio)

Exemplo de Payload da Requisição


{
   "txtmsg":"Texto da mensagem",
   "id_wpp":1234,
   "email_dest":"email@email.com.br",
   "numero_dest":"1133332222",
   "id_campanha":123456,
   "assunto":"Alerta",
   "info_contato":{
      "documento":"01234567890",
      "nome":"Fulano de tal",
      "telefone1":"1133332222",
      "telefone2":"",
      "telefone3":"",
      "email":"email@email.com.br",
      "endereco":"Rua A",
      "bairro":"Centro",
      "cep":"11200000",
      "cidade":"Cidade",
      "estado":"UF",
      "pais":"BR",
      "geral1":"Informação Genérica 1",
      "geral2":"Informação Genérica 2",
      "geral3":"Informação Genérica 3",
      "geral4":"Informação Genérica 4",
      "geral5":"Informação Genérica 5"
   }
}

Descrição dos Campos

Campos Principais

Campo Descrição
txtmsg Texto da mensagem. Ignorado quando utilizado com API oficial, pois o conteúdo enviado será o template
id_wpp Identificador do canal de WhatsApp
email_dest Email do destinatário (opcional, pode ser usado em campanhas de email)
numero_dest Número para o qual será enviada a mensagem
id_campanha Identificador da campanha previamente criada
assunto Assunto do email (opcional, usado em campanhas de email)

Variáveis do Contato (info_contato)

As variáveis utilizadas nos templates são enviadas dentro do objeto info_contato.

Campo Descrição
documento Identificador do cliente (CPF, CNPJ ou outro identificador único). Caso ausente, pode ser utilizado o número de telefone
nome Nome completo do cliente
telefone1 Número principal do cliente (geralmente igual ao campo numero_dest)
telefone2 Número secundário
telefone3 Terceiro número opcional
email Email do contato
endereco Endereço
bairro Bairro
cep CEP
cidade Cidade
estado UF
pais País (ex: BR)
geral1 – geral5 Campos genéricos que podem ser utilizados como variáveis adicionais

⚠️ Observação:

Caso a variável PRIMEIRO_NOME seja utilizada no template, o sistema automaticamente extrai o primeiro nome a partir do campo nome.