Pular para o conteúdo principal

Guia técnico: Exemplos de disparos ativos via API da ActiveCampaign

  • Atualizado
  1. Resumo
  2. Catálogo de Requisições por Tipo de Template
    1. Template Básico de Texto (Sem Nenhuma Variável)
    2. Template de Texto com Variáveis Dinâmicas
    3. Template com Mídia no Cabeçalho (Imagem, Vídeo ou Documento PDF)
    4. Template com Botão de URL Dinâmica (CTA / Call-To-Action)
    5. Template com Carrossel (Carousel)
    6. Disparo com Variáveis de Contexto (contextVariables) e Extras do Contato

 

Resumo

Este artigo apresenta exemplos práticos de requisições para realização de disparos ativos via API da ActiveCampaign no Blip, detalhando a estrutura exata exigida para cada tipo de template.

Antes de começar

  • Ter acesso e credenciais válidas para consumo das APIs do Blip/ActiveCampaign.

  • Ter templates devidamente aprovados na Meta.

  • Possuir os nomes, IDs e/ou parâmetros do fluxo (flowId, stateId, masterState e messageTemplate).

 

Catálogo de Requisições por Tipo de Template

1. Template Básico de Texto (Sem Nenhuma Variável)

  • Quando usar: Templates 100% estáticos (ex: avisos genéricos, saudações fixas).

  • O que muda no JSON: O bloco messageParams da audiência fica vazio ou sem chaves, e o array messageParams dentro de message deve ser enviado totalmente vazio ([]).

{
  "id": "{{$guid}}",
  "to": "postmaster@activecampaign.msging.net",
  "method": "set",
  "uri": "/campaign/full",
  "type": "application/vnd.iris.activecampaign.full-campaign+json",
  "resource": {
    "campaign": {
      "name": "Disparo_Texto_Estatico",
      "campaignType": "Individual",
      "flowId": "{{flowId}}",
      "stateId": "welcome",
      "masterState": "IdDoBot@msging.net",
      "channelType": "WhatsApp"
    },
    "audience": {
      "recipient": "55+DDD+Numero"
    },
    "message": {
      "messageTemplate": "nomeDoTemplate",
      "messageTemplateLanguage": "pt_BR",
      "messageParams": [],
      "channelType": "WhatsApp"
    }
  }
}

2. Template de Texto com Variáveis Dinâmicas

  • Quando usar: Templates com variáveis no corpo do texto (ex: Olá {{1}}, seu agendamento é dia {{2}}).

  • O que muda no JSON: Usam-se chaves numéricas string ("1", "2") no messageParams da audiência e a lista dos números correspondentes no messageParams da mensagem.

{
  "id": "{{$guid}}",
  "to": "postmaster@activecampaign.msging.net",
  "method": "set",
  "uri": "/campaign/full",
  "type": "application/vnd.iris.activecampaign.full-campaign+json",
  "resource": {
    "campaign": {
      "name": "Disparo_Texto_Variaveis",
      "campaignType": "Individual",
      "flowId": "{{flowId}}",
      "stateId": "welcome",
      "masterState": "IdDobot@msging.net",
      "channelType": "WhatsApp"
    },
    "audience": {
      "recipient": "55+DDD+Numero",
      "messageParams": {
        "1": "Valor1",
        "2": "Valor2"
      }
    },
    "message": {
      "messageTemplate": "nomeDoTemplate",
      "messageTemplateLanguage": "pt_BR",
      "messageParams": ["1", "2"],
      "channelType": "WhatsApp"
    }
  }
}

3. Template com Mídia no Cabeçalho (Imagem, Vídeo ou Documento PDF)

  • Quando usar: Templates cadastrados na Meta com Header de mídia.

  • O que muda no JSON: A URL pública da mídia entra OBRIGATORIAMENTE na posição "1" do messageParams. As variáveis de texto do corpo assumem as posições seguintes ("2", "3", etc.).

Dica para Documentos PDF: Não existe a propriedade filename no /campaign/full. O WhatsApp define o nome do arquivo exibido na tela do celular a partir do final da URL (ex: .../Contrato_de_Adesao.pdf) ou pelo cabeçalho Content-Disposition no servidor.

{
  "id": "{{$guid}}",
  "to": "postmaster@activecampaign.msging.net",
  "method": "set",
  "uri": "/campaign/full",
  "type": "application/vnd.iris.activecampaign.full-campaign+json",
  "resource": {
    "campaign": {
      "name": "Disparo_Header_Midia",
      "campaignType": "Individual",
      "flowId": "38d2645b-89f3-42a4-a37a-d433771c8633",
      "stateId": "welcome",
      "masterState": "IdDoBot@msging.net",
      "channelType": "WhatsApp"
    },
    "audience": {
      "recipient": "55+DDD+Numero",
      "messageParams": {
        "1": "https://meuservidor.com.br/arquivos/Contrato_de_Adesao.pdf",
        "2": "Paula"
      }
    },
    "message": {
      "messageTemplate": "nomeDoTemplate",
      "messageTemplateLanguage": "pt_BR",
      "messageParams": ["1", "2"],
      "channelType": "WhatsApp"
    }
  }
}

4. Template com Botão de URL Dinâmica (CTA / Call-To-Action)

  • Quando usar: Templates com botão "Acessar Site" configurado com variável no final do link.

  • O que muda no JSON: O parâmetro correspondente ao botão deve conter apenas o sufixo/complemento da URL, em texto puro (sem [https://www.dominio.com/](https://www.dominio.com/) e sem codificação %3F ou %3D).

{
  "id": "{{$guid}}",
  "to": "postmaster@activecampaign.msging.net",
  "method": "set",
  "uri": "/campaign/full",
  "type": "application/vnd.iris.activecampaign.full-campaign+json",
  "resource": {
    "campaign": {
      "name": "Disparo_Botao_URL_Dinamica",
      "campaignType": "Individual",
      "flowId": "{{flowId}}",
      "stateId": "welcome",
      "masterState": "IdDoBot@msging.net",
      "channelType": "WhatsApp"
    },
    "audience": {
      "recipient": "55+DDD+Numero",
      "messageParams": {
        "1": "Paula",
        "2": "watch?v=MNzAf9CQEo4"
      }
    },
    "message": {
      "messageTemplate": "nomeDoTemplate",
      "messageTemplateLanguage": "pt_BR",
      "messageParams": ["1", "2"],
      "channelType": "WhatsApp"
    }
  }
}

5. Template com Carrossel (Carousel)

  • Quando usar: Templates com cartões horizontais navegáveis no WhatsApp.

  • O que muda no JSON: As variáveis dinâmicas de cada card (imagens e textos dos botões) usam chaves de identificação nos parâmetros.

{
  "id": "{{$guid}}",
  "to": "postmaster@activecampaign.msging.net",
  "method": "set",
  "uri": "/campaign/full",
  "type": "application/vnd.iris.activecampaign.full-campaign+json",
  "resource": {
    "campaign": {
      "name": "Disparo_Carrossel",
      "campaignType": "Individual",
      "flowId": "{{flowId}}",
      "stateId": "welcome",
      "masterState": "IdDoBot@msging.net",
      "channelType": "WhatsApp"
    },
    "audience": {
      "recipient": "55+DDD+Numero",
      "messageParams": {
        "url1": "url1",
        "name1": "name1",
        "url2": "url2",
        "name2": "name2"
      }
    },
    "message": {
      "messageTemplate": "nomeDoTemplate",
      "messageTemplateLanguage": "pt_BR",
      "messageParams": ["url1", "name1", "url2", "name2"],
      "channelType": "WhatsApp"
    }
  }
}

6. Disparo com Variáveis de Contexto (contextVariables) e Extras do Contato

  • Quando usar: Quando você precisa enviar dados do cliente que não aparecem no texto da mensagem do WhatsApp, mas precisam ser salvos no contato dentro do Blip Builder para uso em scripts ou condições de saída do bot.

  • O que muda no JSON: Adiciona-se o bloco contextVariables (acessível no Builder via {{context.nomeVar}}) e/ou chaves alfanuméricas customizadas no messageParams que são gravadas automaticamente no contact.extras.

{
  "id": "{{$guid}}",
  "to": "postmaster@activecampaign.msging.net",
  "method": "set",
  "uri": "/campaign/full",
  "type": "application/vnd.iris.activecampaign.full-campaign+json",
  "resource": {
    "campaign": {
      "name": "Disparo_Com_Contexto_Invisivel",
      "campaignType": "Individual",
      "flowId": "{{flowId}}",
      "stateId": "welcome",
      "masterState": "IdDoBot@msging.net",
      "channelType": "WhatsApp"
    },
    "audience": {
      "recipient": "55+DDD+Numero",
      "messageParams": {
        "1": "Paula",
        "extras_carteira": "VIP_GOLD"
      },
      "contextVariables": {
        "cpf": "123456789",
        "protocolo_atendimento": "123456"
      }
    },
    "message": {
      "messageTemplate": "nomeDoTemplate",
      "messageTemplateLanguage": "pt_BR",
      "messageParams": ["1"],
      "channelType": "WhatsApp"
    }
  }
}

 

Resumo rápido para ajuda de tomada de decisão:

Modelo de Template Posição no audience.messageParams Posição no message.messageParams Obs
Texto Sem Variável Vazio {} [] Não passar parâmetros adicionais para evitar Erro #132000.
Texto com Variável "1": "Valor" ["1"] Quantidade de parâmetros deve bater exatamente com o modelo de mensagem.
Mídia no Cabeçalho "1": "[https://link.com/file.png](https://link.com/file.png)" ["1"] A URL é SEMPRE o parâmetro "1". Nome do PDF vem da URL.
Botão URL Dinâmica "2": "sufixo?id=123" ["1", "2"] Enviar apenas o sufixo em texto puro sem %3F / %3D.
Variáveis de Contexto Objeto separado contextVariables N/A (não vai no template) Utilize para trafegar dados ao Builder sem expor no texto da mensagem do usuário. 


 

Precisa de mais ajuda? Explore nossos conteúdos na Blip Academy ou Blip Community, assista a tutoriais no nosso canal do YouTube ou tire suas dúvidas em nosso canal de atendimento 😃

Artigos relacionados