Table of Contents

Get Campaign Results v2

Esta API permite consultar el detalle avanzado de las campañas de salida (Outbound) ejecutadas en la plataforma. A través de una sola solicitud, se obtiene el listado de contactos asociados a una campaña, junto con el estado de cada envío, la traza completa de eventos del ciclo de envío (events), los datos personalizados enviados en la campaña (data), y —cuando aplica— la reacción registrada por el destinatario. Esto entrega visibilidad completa y detallada sobre el recorrido de cada contacto dentro de la campaña, desde el envío inicial hasta la interacción final.

Note

Esta API corresponde a la versión 2 del módulo de campañas, con una estructura de respuesta más detallada que la v1 (incluye eventos históricos y datos personalizados por contacto).

POST {{ly_endpoint}}/api/LynnReporting/ExecuteReport/{{ly_tenant}}/64A004A6-FF90-4908-AB2D-F8103ECA0CEC
Request
(Body JSON)
{
        "startDate": "2026-05-01 00:00:00",
        "endDate": "2026-05-30 00:00:00",
        "size": 1000,
        "campaingId": "0X1645XX-0EXX-49XX-BXX3-47C6CXXXXXXX"
}
Response
{
    "isValid": true,
    "executionTime": 109.5701,
    "idReport": "64A004A6-FF90-4908-AB2D-F8103ECA0CEC",
    "nameVisualization": "Get Campaing Result Proactive",
    "totalDocument": 1,
    "pageCount": 0,
    "lastDocument": "MQ==",
    "requestCharge": 0,
    "result": [
        {
            "requestId": "000000c8-a3d6-4d0c-9000-20c600000000",
            "campaignId": "5000049-142a-xxxx-912e-3a0fbaxxxxxx",
            "campaingName": "Campaña de Prueba v2",
            "validUntil": "2026-11-08T01:00:00+00:00",
            "validForHours": 20000,
            "contactChannelId": 1,
            "contactChannelName": "WhatsApp",
            "contactName": "LDA2",
            "contactId": "3dxxxxx1-835b-4xx9-xxxx-30718xxxxxxb",
            "status": "Sent",
            "requestDate": "2026-06-18T10:40:33.267+00:00",
            "creationDate": "2026-06-18T10:40:27.2+00:00",
            "events": [
                {
                    "status": "Sent",
                    "message": "{ 'status' : '200', 'detail' : '{\"status\":\"submitted\",\"messageId\":\"e0000000-0000-0000-XXXX-XXXXXXXXXXXXX\"}' }",
                    "date": "2026-06-18T10:40:34.457+00:00"
                },
                {
                    "status": "In Progress",
                    "message": "{ 'status' : '200' }",
                    "date": "2026-06-18T10:40:33.28+00:00"
                }
            ],
            "data": {
                "nombre": "LDA2",
                "telefono": "56955555555"
            },
            "channelMessageId": "e2xxxxxx-431d-4459-0000-9f6c27xxxxxx",
            "loadDescription": "18062026104027_Soporte_db000000-91dc-4644-xxxx-189585b4xxxxxxx",
            "reactionSession": null,
            "expectedReaction": "",
            "reaction": null,
            "reactedAsExpected": null,
            "reactionOutofValiduntil": null,
            "reactionOutofValidforhours": null
        }
    ],
    "errors": []
}

cURL

curl --location '{{ly_endpoint}}/api/LynnReporting/ExecuteReport/{{ly_tenant}}/64A004A6-FF90-4908-AB2D-F8103ECA0CEC' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{var_token}}' \
--data '{
    "startDate" : "{{startDate}}",
    "endDate" : "{{endDate}}",
    "campaingId": "{{campaignId}}",
    "lastDocument": ""
}'

Parámetros de Ruta (Path Parameters)

Parámetro Descripción
ly_endpoint Url base, de acuerdo al ambiente:
Testing: premium-testing.lynn.cx
Production: premium-production.lynn.cx
ly_tenant Identificador del tenant
ly_reportId ID del reporte a ejecutar
64A004A6-FF90-4908-AB2D-F8103ECA0CEC

Parámetros de Entrada

Campo Tipo Requerido Descripción
startDate string (date-time) Fecha y hora de inicio en formato yyyy-MM-dd HH:mm:ss
endDate string (date-time) Fecha y hora de término en el mismo formato
size integer Cantidad máxima de registros a retornar por página
campaingId string Identificador de la campaña a consultar
lastDocument string Opcional Número de documentos por página (tamaño de lote)

Parámetros de result de Salida

Campo Tipo Descripción
REQUEST_ID string Identificador único de la solicitud de campaña
CAMPAIGN_ID string Identificador de la campaña
CAMPAING_NAME string Nombre descriptivo de la campaña
VALID_UNTIL string Fecha y hora límite de validez del registro
VALID_FOR_HOURS string Cantidad de horas de validez asignadas al registro (numérico, entregado como texto)
CONTACT_CHANNEL_ID string ID numérico del canal de contacto utilizado (entregado como texto)
CONTACT_CHANNEL_NAME string Nombre del canal de contacto (ej. Skype, Telegram, Teams)
CONTACT_NAME string Nombre del contacto asociado
CONTACT_ID string Identificador único del contacto en el sistema
STATUS string Estado actual del registro (ej. Sent, Reacted)
REQUEST_DATE string Fecha y hora en que se realizó la solicitud
LAST_RESULT_DATE string Fecha y hora del último resultado/actualización del registro
DETAIL string Detalle de la respuesta del canal; es un texto con estructura tipo JSON (no parseable directamente) que incluye status y detail del proveedor
LOAD_DESCRIPTION string Descripción de la carga/división que generó el registro
REACTION_SESSION string / null ID de la sesión de reacción del usuario, si existe
EXPECTED_REACTION string Reacción esperada por parte del usuario
REACTION string / null Reacción real recibida por parte del usuario
REACTED_AS_EXPECTED string / null Indica si la reacción coincidió con la esperada ("true" / "false")
REACTION_OUTOF_VALIDUNTIL string / null Indica si la reacción ocurrió fuera de la fecha de validez límite ("true" / "false")
REACTION_OUTOF_VALIDFORHOURS string / null Indica si la reacción ocurrió fuera del rango de horas de validez ("true" / "false")