Saltar al contenido principal

Cómo enviar notificaciones de WhatsApp a través de la API de Active Campaign (Crecimiento)

  • Actualización

Índice:

  1. Introducción
  2. Resumen de las solicitudes
  3. Entidades
  4. Envío de una campaña
  5. Campos de la entidad de la campaña
  6. Campaña individual
  7. Campaña masiva con envío único
  8. Campaña masiva escalonada (Beta)
    1. Envío por archivo CSV
    2. Envío de la campaña
  9. Resumen de la campaña
  10. Requisitos
  11. Comandos
    1. Obtener el resumen de las campañas
    2. Obtener el resumen de una campaña específica
  12. Audiencia de la campaña
  13. Campos de la entidad de la audiencia
  14. Campos de la respuesta
  15. Obtener la audiencia de la campaña
  16. Mensaje de la campaña
    1. Campos del template del mensaje
    2. Campos de la Respuesta
    3. Obtener los mensajes de una campaña
  17. Reporte de la campaña
    1. Requisitos
    2. Campos de la Respuesta
    3. Obtener reporte de una campaña específica

 

Introducción

La API de Active Campaign permite la integración y automatización de tus campañas de marketing, gestión de contactos, seguimiento de actividades y mucho más. Con nuestra API, puedes acceder y manipular datos en tiempo real, personalizar flujos de trabajo automatizados y optimizar tus estrategias de marketing digital.

En esta guía, encontrarás documentación completa sobre todos los endpoints, parámetros de solicitud, ejemplos de solicitud y respuestas esperadas. Aprende a explorar recursos y aprovecha todas las funcionalidades disponibles.

 

Resumen de las solicitudes

Crear nueva campaña:

  • /campaign/full
  • /campaign/v2
  • /audiences/v2/{CAMPAIGN_ID}
  • /audiences/v2/{CAMPAIGN_ID}/file
  • /dispatch/v2

Resumen de la campaña

  • /campaigns/summaries
  • /campaigns/{CAMPAIGN_ID}/summaries

Público de la campaña

  • /audiences/{CAMPAIGN_ID}

Mensaje de la campaña

  • /messages/{CAMPAIGN_ID}

Reporte de la campaña

  • /campaigns/{CAMPAIGN_ID}/reports

 

Entidades

Campaña

Una campaña se refiere a una acción de enviar mensajes de forma individual o en masa (CampaignType) a un grupo específico de usuarios. Es una manera de alcanzar y comunicarse con un gran número de usuarios de forma automatizada y eficiente.

 

A través de la plataforma BLiP, los desarrolladores y profesionales de marketing pueden crear campañas que envíen mensajes a WhatsApp y configurar la redirección del cliente a una etapa (StateId) del flujo del bot (FlowId) al responder un mensaje.

 

Las campañas pueden configurarse para enviar mensajes en tiempo real o programados (scheduled) para una hora específica. 

 

Audiencia

La audiencia es el público específico de la campaña de marketing. Está compuesta por una lista de individuos que recibirán el mensaje.

Cada ítem contiene un número de teléfono (recipient) y los parámetros relacionados con él que se agregarán al mensaje (messageParams).

 

Mensaje

La entidad "message" representa el mensaje que se enviará en la campaña de marketing. Tiene el nombre del template (messageTemplate) que contiene el contenido del mensaje y una lista de parámetros que se utilizarán para personalizar el mensaje con los valores específicos de cada destinatario (messageParams).

 

Envío de una campaña

La API de Active Campaign permite la creación de campañas para enviar de forma individual o en lote.

 

Campos de la entidad de la campaña

Campo Descripción Obligatorio
Id Identificador único de la campaña.  
Name El nombre de la campaña. *
CampaignType El tipo de estrategia de envío de la campaña. Individual o masivo. *
Scheduled La fecha para programar la campaña. El formato de fecha esperado es UTF  
MasterState Estado del router hijo para flujo de redireccionamiento. Este parámetro es obligatorio si el bot es del tipo router. (Ejemplo: child@msging.net)  
FlowId Identificación del flujo del bot. Es único por bot y se puede recuperar dentro de las configuraciones del builder. *
StateId El StateId es el identificador del estado específico en el que se encuentra el bot dentro del flujo de conversación. *

 

La información del público objetivo es:

 

Campo Descripción Obligatorio
Recipient

Quién recibirá la campaña.

Debe tener DDI + DDD + número de teléfono. Se aplicará el formato MSISDN al número, en caso contrario.

 *
MessageParams

Parámetros que forman parte de la personalización del mensaje.


Si los hay, añádalos como un diccionario.

  

 

Dado que, si el tipo es Batch, el campo audience se vuelve plural, audiences y debe tener formato de array de objetos.

 

En el campo Audience:MessageParams, todos los valores, excepto el número de teléfono, se guardarán en contact.extras. Esto significa que puede incluir parámetros adicionales y personalizados en el campo MessageParams, y estos valores se almacenarán en contact.extras.

 

Los "datos extra de los contactos" se refieren a información adicional almacenada sobre cada contacto en un sistema de gestión de contactos. Estos datos extra pueden incluir campos personalizados que capturan información específica sobre cada contacto, para permitir una segmentación, personalización y análisis más efectivos de las campañas de marketing.

 

Por ejemplo, además de los datos comunes como nombre y dirección de correo electrónico, puede agregar campos adicionales para almacenar información como edad, ubicación geográfica, preferencias de producto, historial de compras, entre otros.

 

Nota: 

  • En el campo Audience:MessageParams, puede agregar más parámetros que en MessageTemplate. 

 

La información del mensaje es:

 

Campo Descripción Obligatorio
MessageTemplate Nombre del template del mensaje *
MesssageParams

Parámetros que forman parte de la personalización del mensaje. 


Nota: La cantidad de parámetros debe ser la cantidad exacta de parámetros de su modelo de mensaje elegido.


Caracteres totales: 250


Listado en formato de array

  

Campos de respuesta de la solicitud completados automáticamente

 

Campo Descripción
Status El estado de envío de la campaña.
Created La fecha y hora de creación de la campaña.
FailedReason Motivo en caso de fallo en el envío.

 

Campaña individual

Para enviar una campaña a un solo contacto, el campo audiencia debe tener el valor de un objeto.

 

Solicitud

{
    "id": "%commandId",
    "to": "postmaster@activecampaign.msging.net",
    "method": "set",
    "uri": "/campaign/full",
    "type": "application/vnd.iris.activecampaign.full-campaign+json",
    "resource": {
        "campaign": {
            "name": "Campanha individual completo e sem disparo",
            "campaignType": "Individual",
            "flowId": "{flowId}",
            "stateId": "{stateId}"
        },
        "audience": {
            "recipient": "+5531999...",
            "messageParams": {
                "1" : "Repasse do novo Broadcast"
            },
        },
        "message": {
            "messageTemplate": "email_commerce_resposta",
            "messageParams": ["1"]
        }
    }
}

 

Respuesta

{
    "type": "application/vnd.iris.activecampaign.campaign+json",
    "resource": {
        "id": "37162f14-2d45...",
        "name": "Campanha individual completo e disparo",
        "campaignType": "INDIVIDUAL",
        "flowId": "{flowId}",
        "stateId": "{stateId}"
        "status": "processing",
        "created": "2021-10-22T14:14:02.310Z"
    },
    "method": "set",
    "status": "success",
    "id": "...",
    "from": "...",
    "to": "...",
    "metadata": {
        "#command.uri": "..."
    }
}

 

En caso de que sea necesario incluir información adicional en cada contacto, es posible añadir parámetros dentro de audience.messageParams denominados como "extras1", "extras2", y así sucesivamente.

De esta manera:

 

"audience": {
           "recipient": "+55319...",
            "messageParams": {
               "1": "valor",
               "2": "dos",
               "extras1": "datos ocultos",
               "extras2": "que serán almacenados en el contacto"
           }
       },

 

Campaña masiva con envío único

Para enviar una campaña a varios contactos, el campo audience debe tener el valor de un array además de la información definida en campaignType.

 

Endpoint: /campaign/full

Solicitud

{
    "id": "%commandId",
    "to": "postmaster@activecampaign.msging.net",
    "method": "set",
    "uri": "/campaign/full",
    "type": "application/vnd.iris.activecampaign.full-campaign+json",
    "resource": {
        "campaign": {
            "name": "Campanha batch completo e sem disparo",
            "campaignType": "Batch",
            "flowId": "{flowId}",
            "stateId": "{stateId}"
        },
        "audiences": [
 {
            "recipient": "+55319...",
            "messageParams": {
                "1" : "Repasse do novo Broadcast"
            }
        },
        {
            "recipient": "+55319..",
            "messageParams": {
                "1" : "Repasse do novo Broadcast 2"
            },
        }
 ],
        "message": {
            "messageTemplate": "email_commerce_resposta",
            "messageParams": ["1"]
        }
    }
}



Respuesta

{
    "type": "application/vnd.iris.activecampaign.campaign+json",
    "resource": {
        "id": "37162f14-2d45-...",
        "name": "Campanha individual completo e disparo",
        "campaignType": "INDIVIDUAL",
        "flowId": "{flowId}",
        "stateId": "{stateId}"
        "status": "processing",
        "created": "2021-10-22T14:14:02.310Z"
    },
    "method": "set",
    "status": "success",
    "id": "...",
    "from": "...",
    "to": "...",
    "metadata": {
        "#command.uri": "..."
    }
}



Campaña masiva escalonada (Beta)

Esta aproximación implica el uso de múltiples solicitudes para crear la campaña, agregar la audiencia y luego lanzar la campaña. A diferencia de la campaña de envío único en masa, donde todo se realiza en una sola solicitud (/campaign/full), el flujo escalonado ofrece un mayor control y flexibilidad al separar las etapas en diferentes solicitudes.

 

Con el flujo escalonado, puedes tener un control más detallado sobre cada etapa del proceso de la campaña.

Definición de la campaña

Endpoint: /campaign/v2

Solicitud

 

{
    "id": "{{$guid}}",
    "to": "postmaster@activecampaign.msging.net",
    "method": "set",
    "uri": "/campaign/v2",
    "type": "application/vnd.iris.activecampaign.campaign-dynamic+json",
    "resource": {
        "campaign": {
            "name": "Campanha em Massa postman {{$guid}}",
            "campaignType": "Batch",
            "flowId": "{{flowId}}",
            "stateId": "{{stateId}}"
            //only router
            //"masterstate": "masterstate@msging.net"
        },
        "message": {
            "messageTemplate": "{{messageTemplate}}"
        }
    }
}



Respuesta

{
    "type": "application/vnd.iris.activecampaign.campaign+json",
    "resource": {
        "id": "ffc99160-5182...",
        "name": "Campanha em Massa",
        "campaignType": "BATCH",
        "flowId": "f7bfd815-1327...",
        "stateId": "onboarding",
        "status": "new",
        "created": "2024-06-03T17:21:05.577Z"
    },
    "method": "set",
    "status": "success",
    "id": "...",
    "from": "...",
    "to": "...",
    "metadata": {
        "traceparent": "...",
        "#command.uri": "..."
    }
}

 

Agregación de audiencia

La agregación de audiencia puede ser llamada tantas veces como sea necesario, limitado solo por la cantidad de audiencia aceptada en la campaña (agregar enlace a la documentación sobre límite de campaña).

Existen dos formas de envío de audiencia: la primera utilizando una lista de audiencia como en el ejemplo siguiente. Y la segunda por archivo, añadiendo la URL en el mismo payload de la solicitud. 

 

Envío de lista

Endpoint: /audiences/v2/{{id de la campaña creada}}

 

Solicitud

{
    "id": "{{$guid}}",
    "to": "postmaster@activecampaign.msging.net",
    "method": "set",
    "uri": "/audiences/v2/{{resource.id}}",
    "type": "application/vnd.lime.collection+json",
    "resource": {
        "itemType": "application/vnd.iris.activecampaign.audience+json",
        "items": [
            {"recipient": "+5520900000001"},
            {"recipient": "+5520900000002"},
            {"recipient": "+5520900000003"}
        ]
    }
}



Respuesta

{
    "type": "application/vnd.iris.activecampaign.audience-json+json",
    "resource": {
        "": [],
        "TotalValidNumbers": 3,
        "TotalInvalidNumbers": 0,
        "Status": "Success"
    },
    "method": "set",
    "status": "success",
    "id": "...",
    "from": "...",
    "to": "...",
    "metadata": {
        "traceparent": "...",
        "#command.uri": "..."
    }
}



Envío por archivo CSV

Endpoint: /audiences/v2/{{id de la campaña creada}}

 

Solicitud

{
    "id": "{{$guid}}",
    "to": "postmaster@activecampaign.msging.net",
    "method": "set",
    "uri": "/audiences/v2/{{create_campaign}}/file",
    "type": "application/vnd.iris.activecampaign.audience-file+json",
    "resource": {
        "url": "{{create_bach_file}}"
    }
}



Respuesta

{
    "type": "application/vnd.iris.activecampaign.audience-json+json",
    "resource": {
        "": [],
        "TotalValidNumbers": 3,
        "TotalInvalidNumbers": 0,
        "Status": "Success"
    },
    "method": "set",
    "status": "success",
    "id": "e3a955cb-d2bb-42f5-892d-430a7355872a",
    "from": "postmaster@activecampaign.msging.net/#msging-application-activecampaign-c76f85944-526dw",
    "to": "whatsappcloudapihmg@msging.net/!msging-server-l5xk4-mibif7au",
    "metadata": {
        "traceparent": "00-5ad953eb416091184339a794fe08814e-d15f81f9a03b326f-01",
        "#command.uri": "lime://whatsappcloudapihmg@msging.net/audiences/v2/00a54137-b1f4-483b-99aa-f7c854b8146d/file"
    }
}



Envío de la campaña

Endpoint: /dispatch/v2

 

Solicitud

{
    "id": "{{$guid}}",
    "to": "postmaster@activecampaign.msging.net",
    "method": "set",
    "uri": "/dispatch/v2",
    "type": "application/vnd.iris.activecampaign.campaign+json",
    "resource": {
         "id": "{{create_campaign}}"
    }
}



Respuesta

{
    "method": "set",
    "status": "success",
    "id": "...",
    "from": "...",
    "to": "...",
    "metadata": {
        "traceparent": "...",
        "#command.uri": "..."
    }
}



Resumen de la campaña

Obtén un resumen de las campañas del bot, aplicación de origen, remitente de la campaña y campañas creadas, devolviendo el ID, nombre del modelo de mensaje, fecha de envío y estado del público objetivo.

 

El estado del público objetivo se compone de una lista que incluye el estado de procesamiento e identidad del destinatario. Si se proporciona el filtro de creación, se devolverán todas las campañas creadas en la fecha informada o posterior. A través de esta funcionalidad, tendrás acceso a información importante sobre tus campañas, permitiendo un análisis detallado del rendimiento y estado del público objetivo.

 

La solicitud puede recibir los siguientes datos como consulta:

 

Campo Descripción
SourceApplication Origen de la campaña, ejemplo: Portal, Desk o API.
CampaignSender Quién envió las campañas.
Created La fecha que determina qué campañas se incluirán en la respuesta de la solicitud. Solo se considerarán las campañas creadas en esa fecha o posteriormente.

 

En caso de no proporcionarse el filtro de creación, se devolverán todas las campañas creadas en la fecha informada o posterior.

 

La respuesta de la solicitud se compone de: 

Campo Descripción
id Identificador de la campaña
messageTemplate Nombre del modelo de mensaje
name Nombre de la campaña
sendDate Fecha de envío y estado del público objetivo
FlowId Identificación del flujo del bot.
StateId Identificador del bloque enviado
statusAudience El estado de la audiencia se compone de una lista con el estado de procesamiento del destinatario e identidad



Requisitos

É necessário ter pelo menos uma campanha registrada para o bot.

 

Comandos

Obtener el resumen de las campañas

Al utilizar esta solicitud, se devolverán las campañas que cumplen con los criterios de la consulta enviada.

Endpoint: /campaigns/summaries

 

Solicitud

{
    "id": "{commandId}",
    "to": "postmaster@activecampaign.msging.net",
    "method": "get",
    "uri": "/campaigns/summaries?created=2022-06-26T18%3A02%3A40.000Z&SourceApplication=Portal&CampaignSender=user.sender@take.net"
}



Respuesta

{
  "type": "application/vnd.lime.collection+json",
  "resource": {
    "total": 1,
    "itemType": "application/vnd.iris.activecampaign.campaignsummary+json",
    "items": [
      {
        "id": "{id}",
        "messageTemplate": "email_commerce_resposta",
        "sendDate": "2022-06-14T18:02:40.300Z",
        "statusAudience": [
          {
            "RecipientIdentity": "555555555555@wa.gw.msging.net",
            "Status": "FAILED",
            "ReasonCode": 61,
            "ReasonDescription": "An unexpected error occurred while set transaction."
          },
          {
            "RecipientIdentity": "555555555551@wa.gw.msging.net",
            "Status": "READ"
          }
        ]
      }
    ]
  },
  "method": "get",
  "status": "success",
  "id": "...",
  "from": "postmaster@activecampaign.msging.net/#...",
  "to": "whatsapp2@msging.net/...",
  "metadata": {
    "#command.uri": "...",
    "uber-trace-id": "..."
  }
}

Obtener el resumen de una campaña específica

Para obtener el resumen de una campaña específica, puedes usar esta solicitud proporcionando el ID de la campaña. Esto te permitirá obtener información detallada sobre esa campaña específica, como la modelo utilizada, la fecha de envío y el estado del público objetivo.

 

Endpoint:  /campaigns/{Id de la campaña}/summaries

Requisitos

Id de la campaña

Solicitud

 

{
    "id": "%commandId",
    "to": "postmaster@activecampaign.msging.net",
    "method": "get",
    "uri": "/campaigns/{Id de la campaña}/summaries"
}



Respuesta

{
   "type": "application/vnd.lime.collection+json",
   "resource": {
       "total": 1,
       "itemType": "application/vnd.iris.activecampaign.campaignsummary+json",
       "items": [
           {
               "id": "{id}",
               "messageTemplate": "email_commerce_resposta",
               "sendDate": "2022-06-14T18:02:40.300Z",
               "statusAudience": [
                   {
                       "RecipientIdentity": "555555555555@wa.gw.msging.net",
                       "Status": "FAILED",
                       "ReasonCode": 61,
                       "ReasonDescription": "An unexpected error occurred while set transaction."
                   },
                   {
                       "RecipientIdentity": "555555555551@wa.gw.msging.net",
                       "Status": "READ",
                   }
               ]
           }
       ]
   },
   "method": "get",
   "status": "success",
   "id": "...",
   "from": "postmaster@activecampaign.msging.net/...",
   "to": "whatsapp2@msging.net/...",
   "metadata": {
       "#command.uri": "...",
       "uber-trace-id": "..."
   }
}

 

Audiencia de la campaña

La audiencia de una campaña es el público objetivo específico de la campaña de marketing. Está compuesta por un grupo de individuos, cuya selección puede basarse en criterios demográficos, conductuales u otros factores relevantes.

 

Con nuestra API, puede obtener información sobre la audiencia de una campaña.

 

Campos de la entidad de la audiencia

 

Campo Descripción Obligatorio
Recipient El número de teléfono del destinatario del mensaje. Solo se considerarán números de teléfono válidos. *
MessageParams El diccionario con los nombres y valores de los parámetros del modelo de mensaje.  

 

Campos de la respuesta

 

Campo  Descripción
Total Total de la audiencia
Ítems Lista especificando la audiencia

 

Los ítems se componen de:

 

Campo Descripción
CampaignId Id de la campaña
Recipient El destinatario del mensaje
RecipientType El tipo referente a lo que fue enviado en recipient, por ejemplo, si es número de celular
ChannelType El canal en que el público fue alcanzado
MessageParams

Parámetros que fueron enviados en el mensaje.

El límite máximo de caracteres es de 250.
Status El estado del envío
AudienceStatus El estado del envío del público objetivo.
ValidatedAccount La cuenta validada del público objetivo.
Received La fecha y hora en que el mensaje fue recibido.
Read La fecha y hora en que el mensaje fue leído.
Failed La fecha y hora en que el mensaje falló.
ReasonCode El código del motivo de falla.
ReasonDescription La descripción del motivo de falla.

 

Obtener la audiencia de la campaña

Endpoint: /audiences/{Id de la campaña}

 

Podemos usar este endpoint para obtener la audiencia de una campaña específica. Para ello, necesitamos configurar el método como Get y tener la identidad de la campaña.

 

Requisitos

  • El ID de la campaña.

Solicitud

{
    "id": "%commandId",
    "to": "postmaster@activecampaign.msging.net",
    "method": "get",
    "uri": "/audiences/{id de la campaña}",
}

Respuesta

 

{
   "type": "application/vnd.lime.collection+json",
   "resource": {
       "total": 1,
       "itemType": "application/vnd.iris.activecampaign.audience+json",
       "items": [
           {
               "OwnerIdentity": "whatsappcloudapi@msging.net",
               "CampaignId": "....",
               "recipient": "+5531...",
               "recipientType": "PhoneNumber",
               "channelType": "WHATSAPP",
               "messageParams": {
                   "1": "valor",
                   "2": "dois",
                  "extras1": " dados ocultos",
                  “extras2": "que serão ser armazenadas no contato"
               },
               "status": "VALID",
               "validatedAccount": "553197...@wa.gw.msging.net",
               "processed": "2024-05-16T18:54:31.930Z",
               "received": "2024-05-16T18:54:39.290Z",
               "read": "2024-05-16T18:55:40.980Z"
           }
       ]
   },
   "method": "get",
   "status": "success",
   "id": "%commandId",
   "from": "...",
   "to": "...": {
       "traceparent": “...",
       "#command.uri": "..."
   }
}

Mensaje de la campaña 

Campos del template del mensaje

Campo Descripción Obligatorio
ChannelType El tipo de canal (Padrón = "WhatsApp")  
MessageTemplate El nombre del template del mensaje. *
MessageTemplateLanguage El idioma del template del mensaje.  
MessageParams La lista de nombres de parámetros. Este valor se usa para validar el número de parámetros del público objetivo cuando la campaña es individual.  

 

Campos de la Respuesta

La respuesta está compuesta por:

Campo Descripción
Total Total de mensagens
Ítems Lista das mensagens enviadas

 

O campo Items é composto por:

Campo Descripción
ChannelType Tipo de canal
MessageTemplate Nombre del template del mensaje
MessageParams Parámetros que fueron enviados en el mensaje.

 

Obtener los mensajes de una campaña

  • /messages/{campaignId}

Requisitos

Id de la campaña

Solicitud

 

{
    "id": "%commandId",
    "to": "postmaster@activecampaign.msging.net",
    "method": "get",
    "uri": "/messages/{CAMPAIGN_ID}",
}



Respuesta

 

{
  "type": "application/vnd.lime.collection+json",
  "resource": {
    "total": 1,
    "itemType": "application/vnd.iris.activecampaign.message+json",
    "items": [
      {
        "channelType": "WHATSAPP",
        "messageTemplate": "email_commerce_resposta",
        "messageParams": "1"
      }
    ]
  },
  "method": "get",
  "status": "success",
  "id": "%id”,
  "from": "postmaster@activecampaign.msging.net/#note-mc159",
  "to": "whatsapp1@msging.net/default",
  "metadata": {
    "#command.uri": "lime://whatsapp1@msging.net/messages/{CAMPAIGN_ID}"
  }
}

Reporte de la campaña

Para obtener un informe del estado de una campaña, puede usar esta solicitud. El informe incluye información sobre el modelo de mensaje utilizado en la campaña y el destino de redireccionamiento. Esto le permitirá tener una visión completa del rendimiento y los resultados de la campaña, ayudando a tomar decisiones informadas para la optimización futura.

 

Requisitos

Id de la campaña

 

Campos de la Respuesta

La respuesta está compuesta por:

Campo Descripción
Id Id de la campaña
Name Nombre de la campaña
MessageTemplate Modelo de mensaje elegido para la campaña.
MasterState El estado principal de la campaña, si el bot es un enrutador.
FlowId ID del Flujo de la campaña.
StateId ID del Estado de la campaña.
StateName Nombre del Estado de la campaña.
AttendanceRedirect Correo electrónico del asistente a quien se redirigirá la campaña, en caso de que se haya elegido esta opción.
CampaignSender Correo electrónico de quien envió la campaña.
SendDate Fecha en que se envió la campaña.
StatusAudience Estado de los números de la campaña.

 

La propiedad StatusAudience es una lista en la que cada ítem se compone de:

Campo Descripción
RecipientIdentity Número de contacto. Si no hubo ningún error durante el preprocesamiento de este número, se mostrará el número validado proporcionado por Whatsapp. De lo contrario, se mostrará el número proporcionado en el archivo de público objetivo o en la solicitud en el momento de la creación de la campaña.
Status El estado del público objetivo en el momento de la solicitud.
ReasonCode El código de motivo de fallo del público objetivo.
ReasonDescription La descripción del motivo de fallo del público objetivo.
Processed La fecha y hora en que el público objetivo fue enviado al usuario final.
Received La fecha y hora en que el público objetivo fue recibido por el usuario final.
Read La fecha y hora en que el público objetivo fue leído por el usuario final.
Failed La fecha y hora en que falló el público objetivo.
NumberStatus El estado de procesamiento del público objetivo.

Obtener reporte de una campaña específica

Endpoint: /campaigns/{campaignId}/reports

 

Solicitud

{
    "id": "%commandId",
    "to": "postmaster@activecampaign.msging.net",
    "method": "get",
    "uri": "/campaigns/{campaignId}/reports?shouldHaveStateName=true"
}

Resposta:

{
  "type": "application/vnd.iris.activecampaign.campaignsummary+json",
  "resource": {
    "id": "#campaignId",
    "name": "%name",
    "messageTemplate": "berlin_fttr_monitoramento_",
    "flowId": "%flowId",
    "stateName": "welcome",
    "stateId": "%stateId8",
    "sendDate": "2022-11-22T19:58:21.050Z",
    "statusAudience": [
      {
        "recipientIdentity": "%Number of the contact@wa.gw.msging.net",
        "status": "PROCESSED",
        "processed": "2022-11-22T19:58:24.050Z",
        "numberStatus": "VALID"
      },
      {
        "recipientIdentity": "%Number of the contac 2@wa.gw.msging.net",
        "status": "PROCESSED",
        "processed": "2022-11-22T19:58:23.910Z",
        "numberStatus": "VALID"
      },
      {
        "recipientIdentity": "+%Number of the contac 3",
        "status": "FAILED",
        "reasonCode": 1505,
        "reasonDescription": "Invalid recipient for WhatsApp channel.",
        "failed": "2022-11-22T07:57:44.000Z",
        "numberStatus": "INVALID"
      }
    ]
  },
  "method": "get",
  "status": "success",
  "id": "%id",
  "from": "postmaster@activecampaign.msging.net/#hmg-az-iris2",
  "to": "whatsapp2@msging.net/default",
  "metadata": {
    "#command.uri": "lime://whatsapp2@msging.net/campaigns/{campaignId}/reports",
    "uber-trace-id": " %trace-id”
  }
}





Para más información, visite la discusión sobre el tema en nuestra comunidad o los vídeos en nuestro canal.😃

Artículos relacionados