Upnify Documentación API
CRM · /campanias/:tkCampania/resumen

Comunicaciones

Campaña - Resumen

GET/campanias/:tkCampania/resumen

Obtiene el resumen de resultados y métricas de una campaña.

Parámetros

NombreTipoValidaciónDescripción
tkCampaniaStringRequeridoCódigo token de la campaña.

Respuesta

NombreTipoDescripción
tkCampaniaStringCódigo token de la campaña.
tipoIntegerTipo de campaña.
nombreStringNombre de la campaña.
situacionIntegerSituación actual de la campaña.
fechaInicioDateTimeFecha y hora de inicio.
fechaFinDateTimeFecha y hora de finalización.
asignadosIntegerCantidad de contactos asignados.
asuntoStringAsunto del mensaje.
cuerpoStringContenido del mensaje.
rptContactosIntegerCantidad total de contactos.
rptEnviadosIntegerCantidad de mensajes enviados.
rptNoenviadosIntegerCantidad de mensajes no enviados.
rptErroresIntegerCantidad de errores de envío.
rptAbiertosIntegerCantidad de mensajes abiertos.
rptRebotadosIntegerCantidad de mensajes rebotados.
rptClicksIntegerCantidad de clics registrados.
rptDesuscritosIntegerCantidad de contactos que cancelaron su suscripción.
rptQuejasIntegerCantidad de quejas registradas.
tipoRemitenteIntegerTipo de remitente utilizado.
enviadoPorStringCódigo token del remitente.
anexosArray<Object>Archivos anexos asociados.
pctEnviadosNumberPorcentaje de contactos con envío realizado.
pctNoEnviadosNumberPorcentaje de contactos sin envío.
pctErroresNumberPorcentaje de envíos con error.
pctAbiertosNumberPorcentaje de contactos que abrieron el mensaje.
pctClicksNumberPorcentaje de clics sobre mensajes abiertos.
pctDesuscritosNumberPorcentaje de contactos desuscritos.
pctRebotadosNumberPorcentaje de mensajes rebotados.
pctQuejasNumberPorcentaje de quejas.

Solicitud

Ejemplo de solicitud

curl --request GET 'https://api.upnify.com/campanias/CAM-00000000-0000-4000-8000-000000000010/resumen' \
  --header 'token: 00000000-0000-4000-8000-000000000001'

Respuesta

Ejemplo de respuesta

JSON
[
  {
    "tkCampania": "CAM-00000000-0000-4000-8000-000000000010",
    "tipo": 2,
    "nombre": "Campaña de ejemplo",
    "situacion": 1,
    "fechaInicio": "2026-09-20T09:00:00",
    "fechaFin": "2026-09-30T18:00:00",
    "asignados": 1,
    "asunto": "Asunto de ejemplo",
    "cuerpo": "Contenido de ejemplo.",
    "rptContactos": 1,
    "rptEnviados": 1,
    "rptNoenviados": 0,
    "rptErrores": 0,
    "rptAbiertos": 1,
    "rptRebotados": 0,
    "rptClicks": 0,
    "rptDesuscritos": 0,
    "rptQuejas": 0,
    "tipoRemitente": 1,
    "enviadoPor": null,
    "anexos": [],
    "pctEnviados": 1,
    "pctNoEnviados": 0,
    "pctErrores": 0,
    "pctAbiertos": 1,
    "pctClicks": 0,
    "pctDesuscritos": 0,
    "pctRebotados": 0,
    "pctQuejas": 0
  }
]