Upnify API Docs
CRM · /comm/inbox

Comunicaciones

Correos - Lista

GET/comm/inbox

Permite obtener la lista de los correos recibidos del usuario de la cuenta.

Parámetros

NombreTipoValidaciónDescripción
tkInboxvarchar
tkTabvarchar
textovarchar
paginaint
cantidadRegistrosint

Respuesta

NombreTipoDescripción
ejecutivoStringNombre apellido e iniciales del ejecutivo al que pertenece el correo.
tkColaboradorUUIDContiene un token que identifica a un usuario dentro un grupo de usuarios.
guardaSeguimientoIntegerCódigo que indica si se aplica un seguimiento al prospecto.
tkEmailUUIDCódigo token que identifica de forma única a un inbox.
tkTabUUIDCódigo token que identifica de forma a una pestaña de inbox.
tkSeguimientoUUIDCódigo token que identifica de forma única a un seguimiento.
abiertoIntegerCódigo que indica si el correo acualmente se encuentra leído.
tipoEmisorIntegerCódigo que indica el tipo de emisor externo utilizado para el envío de correos.
nombreStringContiene el nombre de la sucursal o emisor responsable del envío del correo.
correoDeStringIndica la direción de correo desde la que fue enviado.
conCopiaStringContiene una dirección de correo alternativo que servirá para enviar con copia.
paraStringContiene la dirección del destinatario que recibirá el correo.
paraCorreoObjectContiene un arreglo de datos que contiene la información detallada del receptor del correo.
asuntoStringContiene el asunto del correo electrónico.
cuerpoCorreoStringContiene el conntenido del correo.
tieneAdjuntosIntegerCódigo que indica si el correo recibido contiene archivos adjuntos.
adjuntosObjectContiene un arreglo de datos con la información detallada de los archivos adjuntos al correo.
contactoStringContiene el nombre del contacto que envió el correo.
empresaStringContiene el nombre de la empresa que envió.
tkProspectoUUIDCódigo token que identifica de forma única a un prospecto en el sistema.
esClienteIntegerCódigo que indica si el correo recibido proviene de un cliente.
etiquetasObjectContiene un arreglo de datos en los que guarda el nombre de las etiquetas asociadas al prospecto.
fechaHoraDatetimeContiene un formato compuesto de fecha y hora que indica cuando se recibió el correo.
conversacionesIntegerIndica la cantidad de correos enviados y recibidos, siguiendo un estilo de hilo de conversación.
proveedorStringContiene el nombre del proveedor del servicio de mensajería o correo.
correoEntranteString@apiSuccess (Respuesta) {UUID} tkEmpresa Código token que identifica de forma única a una empresa en el sistema.
cabecerasObjectContiene un arreglo de datos con la informacion de cada cabecera del sistema.
fijoIntegerNumero que indica si el correo se encuentra fijo en la bandeja.
tkUsuarioUUIDCódigo token que indentifica a un usuario de forma única en el sistema.
inicialesStringContiene las iniciales del ejecutivo responsable de la campaña.
esProspectoIntegerCódigo que indica si el remitente del correo en un prospecto.
esCorreoIntegerDefine si la estructura actual del correo es válida, y cumple con lo necesario para su envío.
colaboradorStringContiene el nombre de un usuario o ejecutivo colaborador, asociado al prospecto.
inicialesColaboradorStringContiene las iniciales del nombre del usuario o ejecutivo colaborador.
estadoIntegerCódigo que indica el estado del correo.
entranteIntegerDefine si el correo es de entrada o salida.
tkMaestroUUIDCódigo token del correo principal en caso de ser parte de una conversacion.
conCopiaOcultaObjectArreglo de datos que contiene los correos a los que se les envía una copia oculta del correo.

Solicitud

Ejemplo de parámetros

{
    "tkTab":"493EDC15-A006-415A-9D6D-084F960E0CE6"
}