Última actualización

Versión 2.0 @03**/03/**2023

Automation

El propósito de este documento es proporcionar una guía para el uso correcto del servicio API de Automation, a continuación puede ver ejemplos del cuerpo de la solicitud para iniciar flujos.

Envío de flujos por API

Hay dos pasos para enviar campañas a través de la API:

  1. La primera es la creación del flujo desde la interfaz gráfica.
  2. La segunda es enviar la solicitud del API de inicio del flujo.

Debe ingresar al módulo de creación de Automation y en el nodo de inicio, al seleccionar el método de carga de datos, elegir la opción "API". Al finalizar el flujo y hacer clic en el botón "Activar", se mostrará un identificador (ID) del flujo que debe ser guardado para ser utilizado en el siguiente paso.

Untitled

Métodos HTTP Endpoint
POST https://automation.masivapp.com/api/automation-model/campaign/init-from-api

Iniciar flujo API

Estructura de solicitud de nuevos flujos creados desde la interfaz gráfica de Masiv Web

Parameters

Header Tipo Descripción
Authorization string Basic 64 autenticación token codificado en base 64 username:password
Body Tipo Descripción
dataToReplace array Colección de personas en un array, que entrará en el flujo
flowId string Id que representa el flujo creado desde la interfaz web
Responses Descripción
🟢 200 Solicitud recibida con éxito

Ejemplo:

{
    "status": "ok",
    "pTracking": "5fe25b29c33b9800109bb854"
}
Responses Descripción
🔴 500 El ID del modelo no coincide con el creado para la cuenta autentificada

Ejemplo:

{
    "status": "error",
    "response": "FLOW-SERVICE originalError:(model not found)"
}

Ejemplo de estructura de solicitud

{
    "flowId": "5fe21261c33b980030933335",
    "dataToReplace": [
        {
           "nombre": "Carlos",
            "telefono": "57301234567",
            "email": "[email protected]",            
            "edad": 28,
            "mensaje": "Hola este es un ejemplo"
        }
    ]
}

NOTA: Los números de teléfono móvil deben tener códigos de país para evitar posibles errores en el envío y funcionamiento de las campañas.

Envío de notificaciones externas

Para realizar notificaciones de eventos externos al servicio Masiv Automation se debe consumir el siguiente end-point de tipo application/json.