Saltar al contenido principal

Guía técnica: Ejemplos de envíos activos mediante la API de ActiveCampaign

  • Actualización
  1. Resumen
  2. Catálogo de solicitudes por tipo de plantilla
    1. Plantilla básica de texto (sin ninguna variable)
    2. Plantilla de texto con variables dinámicas
    3. Plantilla con medios en el encabezado (imagen, video o documento PDF)
    4. Plantilla con botón de URL dinámica (CTA / Call-To-Action)
    5. Plantilla con carrusel (Carousel)
    6. Envío con variables de contexto (contextVariables) y datos adicionales del contacto

 

Resumen

Este artículo presenta ejemplos prácticos de solicitudes para realizar envíos activos mediante la API de ActiveCampaign en Blip, detallando la estructura exacta requerida para cada tipo de plantilla.

Antes de comenzar

  • Tener acceso y credenciales válidas para consumir las API de Blip/ActiveCampaign.

  • Tener plantillas debidamente aprobadas en Meta.

  • Contar con los nombres, ID o parámetros del flujo (flowId, stateId, masterState y messageTemplate).

 

Catálogo de solicitudes por tipo de plantilla

1. Plantilla básica de texto (sin ninguna variable)

  • Cuándo usarla: Plantillas 100 % estáticas (p. ej., avisos genéricos, saludos fijos).

  • Qué cambia en el JSON: El bloque messageParams de la audiencia queda vacío o sin claves, y el arreglo messageParams dentro de message debe enviarse completamente vacío ([]).

{
  "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. Plantilla de texto con variables dinámicas

  • Cuándo usarla: Plantillas con variables en el cuerpo del texto (p. ej., Olá {{1}}, seu agendamento é dia {{2}}).

  • Qué cambia en el JSON: Se utilizan claves numéricas de tipo string ("1", "2") en messageParams de la audiencia y la lista de los números correspondientes en messageParams del mensaje.

{
  "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. Plantilla con medios en el encabezado (imagen, video o documento PDF)

  • Cuándo usarla: Plantillas registradas en Meta con Header de medios.

  • Qué cambia en el JSON: La URL pública del medio debe ir OBLIGATORIAMENTE en la posición "1" de messageParams. Las variables de texto del cuerpo ocupan las posiciones siguientes ("2", "3", etc.).

Consejo para documentos PDF: No existe la propiedad filename en /campaign/full. WhatsApp define el nombre del archivo que se muestra en la pantalla del celular a partir del final de la URL (p. ej., .../Contrato_de_Adesao.pdf) o mediante el encabezado Content-Disposition del 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. Plantilla con botón de URL dinámica (CTA / Call-To-Action)

  • Cuándo usarla: Plantillas con el botón "Acceder al sitio" configurado con una variable al final del enlace.

  • Qué cambia en el JSON: El parámetro correspondiente al botón debe contener únicamente el sufijo/complemento de la URL, en texto sin formato (sin [https://www.dominio.com/](https://www.dominio.com/) y sin codificación %3F o %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. Plantilla con carrusel (Carousel)

  • Cuándo usarla: Plantillas con tarjetas horizontales navegables en WhatsApp.

  • Qué cambia en el JSON: Las variables dinámicas de cada tarjeta (imágenes y textos de los botones) utilizan claves de identificación en los 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. Envío con variables de contexto (contextVariables) y datos adicionales del contacto

  • Cuándo usarlo: Cuando necesitas enviar datos del cliente que no aparecen en el texto del mensaje de WhatsApp, pero deben guardarse en el contacto dentro de Blip Builder para usarlos en scripts o condiciones de salida del bot.

  • Qué cambia en el JSON: Se agrega el bloque contextVariables (accesible en Builder mediante {{context.nombreVar}}) o claves alfanuméricas personalizadas en messageParams, que se guardan automáticamente en 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"
    }
  }
}

 

Resumen rápido para ayudar en la toma de decisiones:

Modelo de plantilla Posición en audience.messageParams Posición en message.messageParams Observaciones
Texto sin variable Vacío {} [] No enviar parámetros adicionales para evitar el error #132000.
Texto con variable "1": "Valor" ["1"] La cantidad de parámetros debe coincidir exactamente con la plantilla del mensaje.
Medios en el encabezado "1": "[https://link.com/file.png](https://link.com/file.png)" ["1"] La URL es SIEMPRE el parámetro "1". El nombre del PDF proviene de la URL.
Botón de URL dinámica "2": "sufixo?id=123" ["1", "2"] Enviar únicamente el sufijo en texto sin formato, sin %3F / %3D.
Variables de contexto Objeto separado contextVariables N/A (no va en la plantilla) Úsalo para enviar datos al Builder sin exponerlos en el texto del mensaje del usuario. 


 

¿Necesitas más ayuda? Explora nuestros contenidos en Blip Academy o Blip Community, mira tutoriales en nuestro canal de YouTube o resuelve tus dudas en nuestro canal de atención 😃

Artículos relacionados