GET/comm/outbox/:tkEmail
Permite obtener el detalle de un correo enviado en específico.
Parámetros
| Nombre | Tipo | Validación | Descripción |
|---|
tkEmail | varchar | Requerido | Contiene el código token del correo enviado. |
pagina | int | | Número de página que se desea consultar. |
cantidadRegistros | int | | Cantidad máxima de registros que devuelve la consulta. |
Respuesta
| Nombre | Tipo | Descripción |
|---|
indice | Integer | Define la posición del registro respecto a los demás registros. |
tkEmail | UUID | Contiene el código token del correo enviado. |
destinatario | String | Contiene la dirección de correo electrónico destinatario. |
asunto | String | Contiene el encabezado o asunto del correo enviado. |
errores | Integer | Código que indica si el correo pudo ser enviado o ocurrieron errores. |
error | String | Contiene el texto de error en caso de haberlo. |
tipo | Integer | Código que indica el tipo de correo enviado. |
estado | Integer | Código que indica el estado del correo enviado. |
nombre | String | Contiene el nombre del destinatario. El de un colaborador o ejecutivo, o en su caso, el de un prospecto. |
tkUsuario | UUID | Código token de un usuario, el cuál envía el correo. |
ejecutivo | String | Contiene el nombre del usuario o ejecutivo que envía el correo. |
iniciales | String | Contiene las iniciales del nombre de usuario o ejecutivo que envía el correo. |
esProspecto | Integer | Código que indica si el destinatario del correo enviado en un prospecto. |
tkProspecto | UUID | Código token del prospecto destinatario del correo. |
contacto | String | Contiene el nombre del prospecto destinatorio del correo. |
esCliente | Integer | Código que indica si el destinatario del correo enviado en un cliente. |
tkColaborador | UUID | Código token de un usuario o ejecutivo colaborador, asociado al prospecto. |
colaborador | String | Contiene el nombre de un usuario o ejecutivo colaborador, asociado al prospecto. |
inicialesColaborador | String | Contiene las iniciales del nombre del usuario o ejecutivo colaborador. |
empresa | String | Contiene el nombre de la empresa asociada al contacto. |
tkEmpresa | UUID | Código token de la empresa asociada al contacto. |
abierto | Integer | Código que indica si el correo enviado ha sido abierto por el destinatario. |
esCorreo | Integer | Define si la estructura actual del correo es válida, y cumple con lo necesario para su envío. |
fechaApertura | Datetime | Contiene un formato de fecha y hora compuesta que indica la fecha en la que fué abierto el correo. |
fechaHora | Datetime | Contiene un formato de fecha y hora compuesta que indica la fecha en la que se envió el correo. |
tieneAdjuntos | Integer | Define si el correo contiene adjuntos. |
adjuntos | Object | Contiene un arreglo de datos con la información detallada de los archivos adjuntos al correo. |
correoDe | String | Contiene la dirección de correo electrónico del emisor. |
conCopia | Object | Arreglo de datos que contiene los correos a los que se les envía una copia del correo. |
etiquetas | Object | Arreglo de datos que contiene las etiquetas asociadas al prospecto. |
entrante | Integer | Define si el correo es de entrada o salida. |
tkMaestro | UUID | Código token del correo principal en caso de ser parte de una conversacion. |
paraCorreo | Object | Arreglo de datos que contiene las direcciones a las que se les envía el correo. |
conCopiaOculta | Object | Arreglo de datos que contiene los correos a los que se les envía una copia oculta del correo. |
cuerpoCorreo | String | Contiene el conntenido del correo. |
conversacion | Object | Contiene un arreglo de datos con información detallada de otros correos/respuestas relacionadas con el mismo. |
Solicitud
curl --request GET 'https://api.upnify.com/v4/comm/outbox/00000000-0000-4000-8000-000000000010?pagina=1&cantidadRegistros=50' \
--header 'token: 00000000-0000-4000-8000-000000000001'const response = await fetch('https://api.upnify.com/v4/comm/outbox/00000000-0000-4000-8000-000000000010?pagina=1&cantidadRegistros=50', { method: 'GET', headers: { token: '00000000-0000-4000-8000-000000000001' } });
console.log(await response.json());const response = await fetch('https://api.upnify.com/v4/comm/outbox/00000000-0000-4000-8000-000000000010?pagina=1&cantidadRegistros=50', { method: 'GET', headers: { token: '00000000-0000-4000-8000-000000000001' } });
console.log(await response.json());import requests
response = requests.get('https://api.upnify.com/v4/comm/outbox/00000000-0000-4000-8000-000000000010?pagina=1&cantidadRegistros=50', headers={'token':'00000000-0000-4000-8000-000000000001'})
print(response.json())package main
import ("bytes"; "fmt"; "io"; "net/http")
func main() {
req, _ := http.NewRequest("GET", "https://api.upnify.com/v4/comm/outbox/00000000-0000-4000-8000-000000000010?pagina=1&cantidadRegistros=50", nil)
req.Header.Set("token", "00000000-0000-4000-8000-000000000001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
data, _ := io.ReadAll(res.Body)
fmt.Println(string(data))
}using System.Net.Http;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("token", "00000000-0000-4000-8000-000000000001");
var response = await client.GetAsync("https://api.upnify.com/v4/comm/outbox/00000000-0000-4000-8000-000000000010?pagina=1&cantidadRegistros=50");
Console.WriteLine(await response.Content.ReadAsStringAsync());
Respuesta
[
{
"indice": 0,
"tkEmail": "00000000-0000-4000-8000-000000000010",
"destinatario": "valor-destinatario",
"asunto": "valor-asunto",
"errores": 0,
"error": "valor-error",
"tipo": 0,
"estado": 0,
"nombre": "valor-nombre",
"tkUsuario": "00000000-0000-4000-8000-000000000010",
"ejecutivo": "valor-ejecutivo",
"iniciales": "valor-iniciales",
"esProspecto": 0,
"tkProspecto": "00000000-0000-4000-8000-000000000010",
"contacto": "valor-contacto",
"esCliente": 0,
"tkColaborador": "00000000-0000-4000-8000-000000000010",
"colaborador": "valor-colaborador",
"inicialesColaborador": "valor-inicialesColaborador",
"empresa": "valor-empresa",
"tkEmpresa": "00000000-0000-4000-8000-000000000010",
"abierto": 0,
"esCorreo": 0,
"fechaApertura": "2026-01-01T00:00:00.000Z",
"fechaHora": "2026-01-01T00:00:00.000Z",
"tieneAdjuntos": 0,
"adjuntos": [],
"correoDe": "ejemplo@invalid.test",
"conCopia": {},
"etiquetas": {},
"entrante": 0,
"tkMaestro": "00000000-0000-4000-8000-000000000010",
"paraCorreo": {},
"conCopiaOculta": {},
"cuerpoCorreo": "ejemplo@invalid.test",
"conversacion": {}
}
]
