Ir para o conteúdo principal

Utilizando envios automáticos

Abaixo

Envio seráde explicadoMensagens avia lógicaAPI Oficial do WhatsApp (Automação de Campanhas)

Este documento descreve o processo de configuração e envio de uma mensagemmensagens através de automação de campanhacampanhas usandoutilizando umaprimariamente APIum canal oficial do WhatsApp (Meta).

Pré-requisitos

Antes de whatsappiniciar, oficial.é necessário que:

  • EstamosO assumindo que a configuração do canal de whatsappWhatsApp já esteja concluído.devidamente configurado no sistema.

  • O template de mensagem esteja aprovado pela Meta.

⚠️ Importante

PelaA API oficial da Meta,Meta não épermite possívelo enviarenvio qualquerde mensagem.mensagens livres.
Somente é possívelpermitido enviaro envio de templates pré-previamente aprovados pela moderação da meta.
OBS.:Meta
.

Além disso:

A criação do template deve obrigatoriamente ser feita através do sistema da tallk.Tallk.me é obrigatório. .
Não criarcrie diretotemplates diretamente pela Meta ou BSPpor parceiro.BSPs parceiros.


1. Criação do Template

Logo oO primeiro passo é criar oum template:
IMAGEMtemplate TELAde DEmensagem CRIAÇÃOdentro DEda TEMPLATEplataforma.

Comimage.png

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


2. Criação da Campanha

Após a criação do template, é necessário criar auma campanha:
IMAGEMcampanha TELAde DE CRIAÇÕA DE CAMPANHAenvio.

Seimage.png

foram

Caso utilizadaso template utilize variáveis, no template, éserá necessário atribuirinformar osa valorescorrelaçã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.

Uma vez com a campanha e posteriormente os valores devem ser passados no payload da URI apropriada.


3. Envio das Mensagens

Depois que o template devidamentee a campanha estiverem configurados, temosexistem aduas opçformas de adicionar contatos para envio:

  • Importação de importar a lista de contatos parapela interface

  • Envio automático através da API

Neste documento vamos tratar somente os envios,dois oumétodos enviardisponí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 automaçrequisição comHTTP a nossa API. 
Temos dois métodos atualmente disponívels para fazer isso:GET
.

1 - Opção

Exemplo de templatesURI

sem
variáveis.
Se
você
não
usa
variáveis
em
seu
template,
adicionar
o
contato destino na campanha pode ser feito através da montagem de uma URL com um simples GET. Exemplo:

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

Desta

forma,
todos
os
parâ

Parâmetros da URL

colocadosnaURL.
acao=insere_whats_simples->Simplesmenteidentifica ->Identificao deenvio).
&token=XJS83HAUQORDIGHA82->
ParâmetroDescrição
acao Identifica internamente a ão internamente.
id_cliente=123a ->ser executada (insere_whats_simples)
id_clienteIdentificador do cliente (pode ser obtidodisponível no canto superior direito da tela).
id_wpp=12plataforma)
id_wppIdentificador do canal de whatsappWhatsApp (podedisponível serna obtidotela node canto superior direito da tela, em Números de whatsappenvio)
tokenToken de autorização do cliente para acesso à API
num_destNúmero de telefone que receberá a mensagem
txtmsgTexto da mensagem. Em caso de API (podeoficial este campo é ignorado, pois a mensagem enviada será o template
id_campanhaIdentificador 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 obtidoutilizada uma requisição HTTP POST.

Endpoint

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

ParâmetroDescrição
acaoIdentifica internamente a ação a ser executada (envio_simples_whats_v2)
id_clienteIdentificador do cliente (disponível no canto superior direito da tela).plataforma)
id_wppIdentificador do canal de WhatsApp (disponível na tela de números de envio)

Exemplo de Payload da Requisição


num_dest=11988887777->
Número
a
qual
receberá
a
mensagem.
txtmsg=TEXTO->
{
   "txtmsg":"Texto da mensagemmensagem",
   a"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

oficial,estecampoéé
CampoDescrição
txtmsgTexto da mensagem. Ignorado quando utilizado com API oficial, pois o conteúdo enviado será o template
id_wppIdentificador do canal de WhatsApp
email_destEmail do destinatário (opcional, pode ser enviadausado (Emem casocampanhas de APIemail)
numero_dest Número ignorado,para poiso qual será enviada a mensagem
id_campanhaIdentificador da campanha previamente criada
assuntoAssunto 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.

CampoDescrição
documentoIdentificador do cliente (CPF, CNPJ ou outro identificador único). Caso ausente, pode ser utilizado o template).
id_campanha=12345número ->de Identificatelefone
nomeNome completo do cliente
telefone1Número principal do cliente (geralmente igual ao campo numero_dest)
telefone2Número secundário
telefone3Terceiro número opcional
emailEmail do contato
enderecoEndereço
bairroBairro
cepCEP
cidadeCidade
estadoUF
paisPaís (ex: BR)
geral1 – geral5Campos genéricos que podem ser utilizados como variáveis adicionais

⚠️ Observação:

Caso a campanhavariável PRIMEIRO_NOME seja utilizada no template, o sistema automaticamente extrai o primeiro nome a serpartir utilizadado (criadacampo no passo anterior)nome.