Upnify Documentación API
CRM · /clientes/:tkProspecto/seguimientos/:tkSeguimiento

Clientes

Detalle de seguimiento

GET/clientes/:tkProspecto/seguimientos/:tkSeguimiento

Consulta un seguimiento del cliente. La respuesta exitosa conserva el formato de arreglo. No incluye seguimientos asociados a oportunidades. Requiere el encabezado token de una sesión válida.

El filtro sistema acepta 0 o 1; su valor predeterminado es null, que devuelve todos los valores de sistema y conserva los demás filtros. En la URL, omite sistema para consultar todos; no envíes la cadena null. El filtro se aplica tanto a los resultados como al total del encabezado Row-Count.

La respuesta es un arreglo de seguimientos; puede estar vacío si no hay coincidencias. Row-Count contiene el total antes de paginar para los filtros de sistema, actividad, categoría y búsqueda; no se limita por tkSeguimiento. Si se proporciona un tkSeguimiento inexistente, se devuelve HTTP 404.

Parámetros

NombreTipoValidaciónDescripción
tkProspectovarcharIdentificador del cliente en la URL. El nombre del parámetro es tkProspecto. Máximo 64 caracteres.
actividadintGrupo de actividad en la consulta. 0 no restringe el grupo. Los grupos 1 a 12 incluyen, respectivamente, los tipos (0, 9, 20), (8), (1, 2, 13), (3, 4, 5), (6), (10), (12), (7), (14), (15), (19) y (16). El grupo 12 también incluye ciertos seguimientos automáticos de integración.
paginaintNúmero de página en la consulta; inicia en 1. Con 0 se devuelven hasta 1000 registros desde el inicio.
cantidadRegistrosintCantidad de registros por página en la consulta. Usa un entero mayor que 0. Si pagina es 0, el límite es 1000 y este valor no se utiliza.
buscarvarcharTexto que se busca dentro del comentario del seguimiento. Máximo 256 caracteres. Omítelo o envía una cadena vacía para no limitar por texto.
tkTipoSeguimientovarcharIdentificador de la categoría por la que se filtra en la consulta. Máximo 64 caracteres. Si se omite, está vacío o no corresponde a una categoría, no limita por categoría.
tkSeguimientovarcharIdentificador del seguimiento en la URL. Máximo 64 caracteres.
sistemabitConsulta opcional: 0 selecciona seguimientos que no son del sistema y 1 los del sistema. El valor predeterminado null incluye todos, también los registros sin indicador. Para todos, omite el parámetro en la URL; no envíes el texto null.
tokenStringRequeridoToken de sesión enviado en el encabezado HTTP token. No lo registres ni lo expongas.

Respuesta

NombreTipoDescripción
indiceIntegerPosición del seguimiento en el listado, considerando la página solicitada.
tkSeguimientoStringIdentificador del seguimiento.
tipoSeguimientoIntegerCódigo del tipo de seguimiento. Puede ser null si no está definido.
fechaHoraStringFecha y hora del seguimiento ajustadas a la configuración del usuario autenticado.
tkSeguimientoCategoriaStringIdentificador de la categoría del seguimiento; null si no tiene categoría.
categoriaStringNombre de la categoría; null si no tiene categoría.
seguimientoStringComentario del seguimiento, sin espacios al inicio ni al final.
tkProspectoStringIdentificador del contacto al que pertenece el seguimiento.
tkUsuarioStringIdentificador del ejecutivo que registró el seguimiento.
ejecutivoNombreStringNombre completo del ejecutivo que registró el seguimiento.
inicialesStringIniciales del ejecutivo; puede ser null.
avatarStringURL del avatar del ejecutivo; puede ser null.
latitudString|NumberLatitud registrada; puede recibirse como texto o número. Es null si no está disponible.
longitudString|NumberLongitud registrada; puede recibirse como texto o número. Es null si no está disponible.
tkEmailStringIdentificador del correo asociado; null si no está disponible.
entranteIntegerPara correos: 1 si es entrante y 0 si es saliente. Es null para otros seguimientos.
fechaAperturaStringFecha y hora de apertura del correo; null si no se ha abierto o no aplica.
estadoIntegerCódigo de estado del correo; null cuando el seguimiento no es un correo.
leidoIntegerPara correos: 1 si se ha leído y 0 en caso contrario. Es null para otros seguimientos.
erroresIntegerCódigo de errores del correo; null si no está disponible o no aplica.
tipoIntegerCódigo del tipo de correo; null si no está disponible o no aplica.
duracionIntegerDuración registrada para el seguimiento.
sistemaIntegerIndicador numérico: 1 para un seguimiento del sistema y 0 para uno que no es del sistema. Puede ser null si no está definido.
tkTareaStringIdentificador de la tarea asociada; null si no aplica.
grabacionStringReferencia a la grabación asociada; puede ser null.
tkConversacionStringIdentificador de la conversación asociada; null si no aplica.
tkSmsStringIdentificador del SMS asociado; null si no aplica.
tkFlowTareaStringIdentificador de la tarea de Flow asociada; null si no aplica.
tkIntegracionStringToken de la integración asociada; null si no aplica. No lo registres ni lo expongas.
tkHistoricoStringIdentificador del evento de integración asociado; null si no aplica.

Solicitud

Consultar un seguimiento

curl --request GET 'https://api.upnify.com/v4/clientes/00000000-0000-4000-8000-000000000010/seguimientos/00000000-0000-4000-8000-000000000020?pagina=1&cantidadRegistros=50' \
  --header 'token: 00000000-0000-4000-8000-000000000001'

Respuesta

HTTP 200: ejemplo de seguimiento con sistema=0

JSON
[
  {
    "indice": 1,
    "tkSeguimiento": "00000000-0000-4000-8000-000000000020",
    "tipoSeguimiento": 0,
    "fechaHora": "2026-09-22 10:30:00.000",
    "tkSeguimientoCategoria": null,
    "categoria": null,
    "seguimiento": "Se registró una nota de seguimiento.",
    "tkProspecto": "00000000-0000-4000-8000-000000000010",
    "tkUsuario": "00000000-0000-4000-8000-000000000030",
    "ejecutivoNombre": "Ejecutivo de ejemplo",
    "iniciales": "EE",
    "avatar": null,
    "latitud": null,
    "longitud": null,
    "tkEmail": null,
    "entrante": null,
    "fechaApertura": null,
    "estado": null,
    "leido": null,
    "errores": null,
    "tipo": null,
    "duracion": 0,
    "sistema": 0,
    "tkTarea": null,
    "grabacion": null,
    "tkConversacion": null,
    "tkSms": null,
    "tkFlowTarea": null,
    "tkIntegracion": null,
    "tkHistorico": null
  }
]

HTTP 404: tkSeguimiento inexistente

JSON
[
  {
    "code": 404,
    "msg": "El recurso no ha sido encontrado."
  }
]