Comunicaciones

Campañas - Lista

GET/v4/campanias

Obtiene la lista paginada de campañas accesibles para el usuario.

Parámetros

Nombre	Tipo	Descripción
`orden`	varchar	Criterio de ordenamiento de la lista.
`situacion`	int	Filtra por la situación de la campaña.
`tkProspecto`	varchar	Código token del prospecto relacionado.
`tipo`	int	Filtra por tipo de campaña.
`texto`	varchar	Texto que se busca en el nombre de la campaña.
`tkEtiqueta`	varchar	Código token de la etiqueta asociada.
`fechaInicio`	datetime	Fecha inicial del periodo de creación o modificación.
`fechaFin`	datetime	Fecha final del periodo de creación o modificación.
`periodo`	int	Identificador del periodo de creación.
`periodoModificacion`	int	Identificador del periodo de modificación.
`pagina`	int	Número de página que se desea consultar.
`cantidadRegistros`	int	Cantidad máxima de registros por página.

Respuesta

Nombre	Tipo	Descripción
`indice`	Integer	Posición del registro dentro de la página.
`idCampania`	Integer	Identificador interno de la campaña.
`tkCampania`	String	Código token que identifica la campaña.
`tipo`	Integer	Tipo de campaña.
`nombre`	String	Nombre de la campaña.
`situacion`	Integer	Situación actual de la campaña.
`aplicaProspecto`	Integer	Indica si la campaña aplica a prospectos.
`aplicaOportunidad`	Integer	Indica si la campaña aplica a oportunidades.
`aplicaCliente`	Integer	Indica si la campaña aplica a clientes.
`iniciales`	String	Iniciales del usuario responsable.
`etiqueta`	String	Nombre de la etiqueta asociada.
`color`	String	Color de la etiqueta asociada.
`tkEtiqueta`	String	Código token de la etiqueta asociada.
`nombreEjecutivo`	String	Nombre del ejecutivo responsable.
`piezas`	Integer	Cantidad de piezas configuradas.
`asignados`	Integer	Cantidad de contactos asignados.
`tkUsuario`	String	Código token del usuario responsable.
`tkEmpresa`	String	Código token de la empresa.
`objetivoCantidad`	Integer	Cantidad objetivo configurada.
`objetivoMonto`	Number	Monto objetivo configurado.
`avanceCantidad`	Integer	Cantidad alcanzada.
`avanceMonto`	Number	Monto alcanzado.
`fechaInicio`	DateTime	Fecha y hora de inicio.
`fechaFin`	DateTime	Fecha y hora de finalización.
`asunto`	String	Asunto del mensaje.
`tipoRemitente`	Integer	Tipo de remitente utilizado.
`enviadoPor`	String	Código token del remitente.
`anexos`	Array<Object>	Archivos anexos asociados.
`fechaCreacion`	DateTime	Fecha y hora de creación.
`fechaModificacion`	DateTime	Fecha y hora de la última modificación.
`usaCreditos`	Integer	Indica si la campaña utiliza créditos.

Solicitud

curl --request GET 'https://api.upnify.com/v4/campanias?pagina=1&cantidadRegistros=50' \
  --header 'token: 00000000-0000-4000-8000-000000000001'const response = await fetch("https://api.upnify.com/v4/campanias?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/v4/campanias?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/v4/campanias?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/v4/campanias?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/v4/campanias?pagina=1&cantidadRegistros=50");
Console.WriteLine(await response.Content.ReadAsStringAsync());

Respuesta

[
  {
    "indice": 1,
    "idCampania": 10,
    "tkCampania": "CAM-00000000-0000-4000-8000-000000000010",
    "tipo": 2,
    "nombre": "Campaña de ejemplo",
    "situacion": 1,
    "aplicaProspecto": 1,
    "aplicaOportunidad": 0,
    "aplicaCliente": 0,
    "iniciales": "UE",
    "etiqueta": "Clientes potenciales",
    "color": "#FF2D6A",
    "tkEtiqueta": "00000000-0000-4000-8000-000000000013",
    "nombreEjecutivo": "Usuario de ejemplo",
    "piezas": 1,
    "asignados": 1,
    "tkUsuario": "00000000-0000-4000-8000-000000000014",
    "tkEmpresa": "00000000-0000-4000-8000-000000000015",
    "objetivoCantidad": 0,
    "objetivoMonto": 0,
    "avanceCantidad": 0,
    "avanceMonto": 0,
    "fechaInicio": "2026-09-20T09:00:00",
    "fechaFin": "2026-09-30T18:00:00",
    "asunto": "Asunto de ejemplo",
    "tipoRemitente": 1,
    "enviadoPor": null,
    "anexos": [],
    "fechaCreacion": "2026-09-17T12:00:00",
    "fechaModificacion": "2026-09-17T12:00:00",
    "usaCreditos": 0
  }
]

Campañas - Lista

Parámetros

Respuesta

Solicitud

Ejemplo de solicitud

Respuesta

Ejemplo de respuesta