OUTBOUND GET CAMPAIGN RESULT
Esta API permite acceder al detalle avanzado de tus campañas de salida (Outbound). Con esta, obtienes una visibilidad completa sobre el ciclo de vida de cada contacto, incluyendo el desglose de los eventos de envío y recepción. Esta API funciona para la versión 1 del módulo de campaña.
GET |
{{ly_endpoint}}/api/LynnReporting/ExecuteReport/{{ly_tenant}}/60D12322-2D25-40DE-BFD4-D4DAE7241C43 |
| Request (Body JSON) |
|
| Response |
|
cURL
curl --location '{{ly_endpoint}}/api/LynnReporting/ExecuteReport/{{ly_tenant}}/60D12322-2D25-40DE-BFD4-D4DAE7241C43' \
--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 ejecutar60D12322-2D25-40DE-BFD4-D4DAE7241C43 |
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 |
campaingId |
string |
✅ | ID de la campaña para filtrar resultados |
lastDocument |
string |
Opcional | Identificador del último documento recibido en una consulta anterior, usado para paginar resultados. Se envía vacío o se omite en la primera consulta. |
Parámetros de result de Salida
| Campo | Tipo | Descripción |
|---|---|---|
requestId |
string |
Identificador único de la solicitud de campaña. |
campaignId |
string |
Identificador de la campaña |
campaingName |
string |
Nombre descriptivo de la campaña. |
validUntil |
string (date-time) |
Fecha y hora límite de validez del registro. |
validForHours |
integer |
Cantidad de horas de validez asignadas al registro. |
contactChannelId |
integer |
ID numérico del canal de contacto utilizado. |
contactChannelName |
string |
Nombre del canal de contacto (ej. WhatsApp). |
contactName |
string |
Nombre del contacto asociado. |
contactId |
string |
Identificador único del contacto en el sistema. |
status |
string |
Estado actual del registro. |
requestDate |
string (date-time) |
Fecha y hora en que se realizó la solicitud. |
creationDate |
string (date-time) |
Fecha y hora de creación del registro. |
events |
array |
Lista de eventos históricos asociados al registro (status, message, date). |
data |
object |
Objeto con información adicional personalizada (MessageType indica la naturaleza del mensaje: síncrono o asíncrono.). |
channelMessageId |
string |
ID del mensaje generado por el canal de comunicación. |
loadDescription |
string |
Descripción de la división que generó el registro. |
reactionSession |
string/null |
ID de la sesión de reacción del usuario, si existe. |
expectedReaction |
string |
Reacción esperada por parte del usuario. |
reaction |
string/null |
Reacción real recibida por parte del usuario. |
reactedAsExpected |
string/null |
Indica si la reacción del usuario coincidió con la esperada. |
reactionOutofValiduntil |
string/null |
Indica si la reacción ocurrió fuera de la fecha de validez límite. |
reactionOutofValidforhours |
string/null |
Indica si la reacción ocurrió fuera del rango de horas de validez. |