Comunicaciones
Campaña - Piezas
GET/campanias/:tkCampania/piezas
Obtiene las piezas configuradas para una campaña.
Parámetros
| Nombre | Tipo | Validación | Descripción |
|---|
tkCampania | String | Requerido | Código token de la campaña. |
tkEtiqueta | String | | Código token de la etiqueta de la campaña. |
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. |
tkPieza | String | Código token de la pieza. |
tkCampania | String | Código token de la campaña. |
condicion | String | Condición configurada para la pieza. |
tieneAdjuntos | Integer | Indica si la pieza tiene archivos adjuntos. |
tipoCorreo | Integer | Tipo de canal de la pieza. |
adjuntos | Array<Object> | Archivos adjuntos de la pieza. |
enviar_tiempo | Integer | Tiempo configurado para el envío. |
estado | Integer | Estado de la pieza. |
asunto | String | Asunto del mensaje. |
cuerpo | String | Contenido del mensaje. |
orden | Integer | Orden de la pieza dentro de la campaña. |
enviados | Integer | Cantidad de envíos realizados. |
errores | Integer | Cantidad de envíos con error. |
totalCorreos | Integer | Cantidad total de contactos a los que aplica. |
faltantes | Integer | Cantidad de contactos pendientes. |
nombre | String | Nombre de la pieza. |
config | String | Configuración adicional de la pieza. |
totalPiezas | Integer | Cantidad total de piezas de la campaña. |
Solicitud
curl --request GET 'https://api.upnify.com/campanias/CAM-00000000-0000-4000-8000-000000000010/piezas?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/piezas?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/piezas?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/piezas?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/piezas?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/piezas?pagina=1&cantidadRegistros=50");
Console.WriteLine(await response.Content.ReadAsStringAsync());
Respuesta
[
{
"indice": 1,
"tkPieza": "00000000-0000-4000-8000-000000000012",
"tkCampania": "CAM-00000000-0000-4000-8000-000000000010",
"condicion": "",
"tieneAdjuntos": 0,
"tipoCorreo": 1,
"adjuntos": [],
"enviar_tiempo": 0,
"estado": 1,
"asunto": "Asunto de pieza",
"cuerpo": "Contenido de pieza.",
"orden": 1,
"enviados": 0,
"errores": 0,
"totalCorreos": 1,
"faltantes": 1,
"nombre": "",
"config": "",
"totalPiezas": 1
}
]
