Com as APIs de Campanha da OmniChat, é possível criar integrações e gerenciar pacotes de disparos em massa de forma automática e programada.
Criar uma campanha completa leva quatro passos, cada um com seu próprio endpoint:
Neste guia vamos falar um pouco a mais sobre cada um desses passos!
Envio da base de audiência
O primeiro passo é fazer o upload da sua base de audiência. Este é o arquivo que contêm os números e informações dos seus contatos, a lista que irá receber as mensagens de sua campanha.
Para a API, você deverá informar um arquivo em formato CSV. É necessário que a primeira coluna seja o número de telefone do contato e esteja identificada como fullNumber.
Um exemplo de base é a seguinte:
Então basta enviar sua audiência no endpoint: https://developers.omni.chat/reference/post_audiences
O endpoint irá processar sua audiência e retornar um ID próprio, que pode ser utilizado em qualquer campanha futura!
Criação da Campanha
A criação da campanha é muito simples. Basta informar um nome amigável (por exemplo: "Campanha Dia dos Pais") e informar o ID da audiência que deseja utilizar.
Este endpoint irá retornar o ID da campanha criada. É com ele que iremos configurar o disparo e montar nosso agendamento.
Você pode sempre consultar as suas campanhas em https://developers.omni.chat/reference/get_campaigns.
Configurações do canal de saída.
Com seu ID de campanha, vamos configurar como os disparos deverão ser feitos criando um Canal de Saída: https://developers.omni.chat/reference/post_campaigns-campaignid-channels
Você deverá informar o ID da integração do número de saída (o remetente da mensagem). Esse ID está disponível na sua plataforma Omni.
Entre em Integrações > Apps / Chats, e selecione o número que deseja utilizar.
Na aba Configurações, copie o ID informado:
PS. No momento apenas campanhas via Whatsapp são aceitas pela API de Campanhas, portanto o campo platform.type será sempre "WAB".
Nessa etapa você também irá informar o seu ID de Template, que foi informado pela nossa equipe, e os tokens utilizados.
Os tokens devem ser informados na ordem do template e devem ser os nomes das colunas da sua audiência.
Agendamento da campanha.
Finalmente, basta informar o horário que você deseja que os disparos se iniciem.
Tudo feito! No horário agendado, seus contatos receberão as mensagens em poucos minutos.
Bônus: Acompanhando os resultados!
Após os disparos, confira as estatísticas pela API de Listagem: https://developers.omni.chat/reference/get_campaigns
Com ela é possível saber quantos contatos havia em sua base, sua taxa de entrega e de leitura!