Comunicaciones
Campaña - Contactos
GET/campanias/:tkCampania/contactos
Obtiene los contactos asociados a una campaña.
Parámetros
| Nombre | Tipo | Validación | Descripción |
|---|
tkCampania | String | Requerido | Código token de la campaña. |
situacionCorreo | Integer | | Filtra por la situación del correo. |
pagina | Integer | | Número de página que se desea consultar. |
cantidadRegistros | Integer | | Cantidad máxima de registros por página. |
Respuesta
| Nombre | Tipo | Descripción |
|---|
indice | Integer | Posición del registro dentro de la página. |
tkProspecto | String | Código token del contacto. |
nombre | String | Nombre del contacto. |
apellidos | String | Apellidos del contacto. |
correo | String | Correo electrónico del contacto. |
correoValido | Integer | Indica si el correo es válido. |
recibirCorreos | Integer | Indica si el contacto puede recibir correos. |
puesto | String | Puesto del contacto. |
empresa | String | Empresa asociada al contacto. |
iniciales | String | Iniciales del responsable. |
nombreEjecutivo | String | Nombre del responsable. |
tkCampania | String | Código token de la campaña. |
secuencia | Integer | Tipo de secuencia del contacto. |
tipoCampania | Integer | Tipo de campaña. |
etiquetas | Array<Object> | Etiquetas asociadas al contacto. |
pausado | Integer | Indica si el contacto está pausado. |
click | Integer | Indica si el contacto hizo clic. |
abierto | Integer | Indica si el contacto abrió el mensaje. |
Solicitud
curl --request GET 'https://api.upnify.com/campanias/CAM-00000000-0000-4000-8000-000000000010/contactos?situacionCorreo=-1&pagina=1&cantidadRegistros=50' \
--header 'token: 00000000-0000-4000-8000-000000000001'const response = await fetch("https://api.upnify.com/campanias/CAM-00000000-0000-4000-8000-000000000010/contactos?situacionCorreo=-1&pagina=1&cantidadRegistros=50", { method: "GET", headers: { token: "00000000-0000-4000-8000-000000000001" } });
console.log(await response.json());// Node.js 18 o posterior
const response = await fetch("https://api.upnify.com/campanias/CAM-00000000-0000-4000-8000-000000000010/contactos?situacionCorreo=-1&pagina=1&cantidadRegistros=50", { method: "GET", headers: { token: "00000000-0000-4000-8000-000000000001" } });
console.log(await response.json());import requests
response = requests.request("GET", "https://api.upnify.com/campanias/CAM-00000000-0000-4000-8000-000000000010/contactos?situacionCorreo=-1&pagina=1&cantidadRegistros=50", headers={"token": "00000000-0000-4000-8000-000000000001"})
print(response.json())package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.upnify.com/campanias/CAM-00000000-0000-4000-8000-000000000010/contactos?situacionCorreo=-1&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 var client = new HttpClient();
client.DefaultRequestHeaders.Add("token", "00000000-0000-4000-8000-000000000001");
var response = await client.GetAsync("https://api.upnify.com/campanias/CAM-00000000-0000-4000-8000-000000000010/contactos?situacionCorreo=-1&pagina=1&cantidadRegistros=50");
Console.WriteLine(await response.Content.ReadAsStringAsync());
Respuesta
[
{
"indice": 1,
"tkProspecto": "00000000-0000-4000-8000-000000000011",
"nombre": "Contacto",
"apellidos": "De ejemplo",
"correo": "integracion@example.test",
"correoValido": 1,
"recibirCorreos": 1,
"puesto": "Puesto de ejemplo",
"empresa": "Empresa de ejemplo",
"iniciales": "UE",
"nombreEjecutivo": "Usuario de ejemplo",
"tkCampania": "CAM-00000000-0000-4000-8000-000000000010",
"secuencia": 1,
"tipoCampania": 2,
"etiquetas": [],
"pausado": 0,
"click": 0,
"abierto": 0
}
]
