Deseja automatizar campanhas de WhatsApp conectando o seu CRM com a AiSensy?
Neste documento, mostraremos as etapas que você precisa seguir para automatizar as mensagens de WhatsApp com as Campanhas de API da AiSensy.
Passo 1- Crie uma Campanha de API na AiSensy.
1. Na plataforma AiSensy, vá para “Campanhas”, clique em “+ Lançar” e selecione “Campanha de API”
2. Adicione um nome de campanha, selecione o modelo pré-aprovado (Template) e coloque a campanha de API no ar
Observação: certifique-se de que seu Template seja aprovado previamente pelo WhatsApp antes de criar a campanha API. Para referência, confira como criar Templates de WhatsApp na AiSensy.
Passo 2: Integrando AiSensy com o seu CRM
Para esta etapa, você precisa que a sua equipe de desenvolvimento o ajude no processo de integração.
1. Conecte o ponto de gatilho (trigger point) do seu CRM/site/software de terceiros usando o formato de chave JSON e a URL do endpoint fornecido abaixo
Solicitação HTTP
{
"apiKey": string,
"campaignName": string,
"destination": string,
"userName": string,
"source": string,
"media": {
"url": string,
"filename": string
},
"templateParams": [
string
],
"tags": [
string
],
"attributes": {
"attribute_name": string
}
}
Envie mensagens aos usuários por meio da API:
NOTA: No caso de um novo usuário (ou seja, o usuário não existe na sua lista de contatos na Plataforma AiSensy), um novo contato será criado com os detalhes recebidos.
Preencha as strings da chave Jason em cada atributo de acordo com a tabela abaixo:
Campos | Descrição |
apiKey | string
Obrigatório. Chave de API gerada no painel.
Vá para gerenciar> Chave de API> Copiar a chave
|
campaignName | string
Obrigatório. Nome da campanha que deve ser enviada ao usuário. O status da campanha deve ser ‘Ao vivo’.
Vá para campanhas> Copie o nome da campanha API criada
|
destination | string Obrigatório. Número de celular dos usuários com código internacional do país para o qual a campanha deve ser enviada. por exemplo – +554198526285 (Brasil)
É recomendado fornecê-lo no formato +(código do país)(número de telefone). Se um número de telefone não puder ser resolvido para nenhum país, por padrão será considerado da Índia (+91).
|
userName | string Obrigatório. Nome do usuário para quem a campanha deve ser enviada. |
source | string Opcional. Fonte do lead. Para segmentar baseado na origem do lead. Por exemplo, 'Formulário do Facebook', 'Lead do site', 'Lead do YouTube'
|
media | Object
Opcional. URL e nome do arquivo da mídia que deve ser enviada com a mensagem Template. |
location | string
Obrigatório. Latitude, longitude, nome e endereço do local que deve ser enviado com a mensagem Template.
|
templateParams[] | string
Opcional. Uma matriz de valores de parâmetros para preencher uma mensagem Template se houver algum valor dinâmico incluído. Vários valores são separados por vírgula.
|
tags[] | string Opcional. Uma matriz de nomes de tags a serem atribuídos ao usuário.
|
attributes | Objeto com pares de key-value. String única é permitida como valor da chave.
Opcional. O objeto deve conter chaves já adicionadas como atributos assistentes emparelhados com valores que você deseja definir como atributos do usuário.
|
Exemplo de Solicitação no Postman
Passo 1 - Configure o tipo de solicitação como "POST"
Passo 2 - URL de configuração
Passo 3 - Escolha tipo de corpo “raw”
Passo 4 - Selecione o tipo "JSON"
Passo 5 - Defina o conteúdo da solicitação
Encontre mais exemplos aqui: abrir no Postman
NOTAS:
A URL da mídia deve estar disponível publicamente. Caso contrário, a solicitação será rejeitada.
O comprimento da matriz de parâmetros do template deve ser igual ao número de parâmetros necessários na campanha cujo nome é fornecido no campo CampaignName. Caso contrário, o pedido será rejeitado.
As Tags devem ser criadas na AiSensy previamente. Se uma Tag não existir no projeto, ela será ignorada.
Qualquer pessoa com acesso de gerente pode criar Tags.
Os Atributos devem ser criadas na AiSensy previamente. Se um atributo não existir no projeto, ele será ignorado.
Qualquer pessoa com acesso de gerente pode criar Atributos.
Response Body
Se for bem-sucedido, o corpo da resposta (response body) retornará um status de 200.
Pré-requisitos
Você verificou a API do WhatsApp Business.
Você tem mensagens Templates aprovadas.
Você já criou uma campanha de API.