Listar campañas

GET /api/v1/campaigns

Este endpoint permite obtener un listado de las campañas de la plataforma, para lo cual se debe enviar un parámetro obligatorio de canal.

Permite conocer las campañas existentes dentro la plataforma, esto ayudará en posteriores usos acompañados con otros endpoints en donde se requiere la información del mismo.

La respuesta del endpoint incluye un conjunto de datos estructurados que proporciona información relevante de cada campaña, como el ID, nombre, descripción, etc.

A continuación, se describen los parámetros disponibles, ejemplos de solicitud y la estructura detallada de la respuesta esperada.

ℹ Recuerda que:

La URL base para todas las solicitudes es: https://tu-dominio.c3.pe

Importante: reemplaza tu-dominio por el nombre de dominio específico que te haya proporcionado C3.

Solicitud

Cabeceras

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	✅ Sí	Token de autenticación (Bearer Token).

Parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
channel	String	✅ Sí	Canal dentro de la plataforma, se admite: WHATSAPP, TELEPHONY, MESSENGER, EMAIL
agent_username	String	❌ No	Nombre de usuario que el agente utiliza para acceder a la plataforma. Si envia este parámetro se listaran solo las campañas que le pertenezcan.

Ejemplo de solicitud

GET /api/v1/campaigns?channel=TELEPHONY&agent_username=marthaparedes

Respuesta

La API devuelve un json con la siguiente estructura.

Respuesta base 200

 {
  "message": "Campañas obtenidas correctamente",
  "data": [
    {
        "id": 1,
        "name": "RECEPCION",
        "description": null,
        "updated_at": "2025-04-25T14:44:11.000000Z",
        "queue": "30000"
    }
  ]
}

Definición de atributos

Campo	Tipo	Descripción
message	String	Mensaje de respuesta del servidor.
data	Array	Lista de campañas obtenidas.
data.id	Integer	Identificador de la campaña.
data.name	String	Nombre de la campaña.
data.description	String	Descripción de la campaña.
data.updated_at	String	Fecha cuando fue actualizado la campaña por última vez.
data.queue	String	Solo está presente para el canal de TELEPHONY.

Errores generales

Código HTTP	Tipo	Causa común
401	Unauthorized	El token de acceso no fue proporcionado en el encabezado Authorization, es inválido o ha sido revocado. Verifique que el token sea correcto y esté activo.
422	Unprocessable Entity	La solicitud fue entendida, pero contiene errores semánticos que impiden su procesamiento. Esto puede deberse a: 1. Parámetros faltantes o inválidos (ej, from_date no es una fecha válida); 2. Recurso inexistente (wa_number no registrado en el sistema); 3. Violación de reglas de negocio (el rango de fechas excede el límite permitido).
500	Server Error	Error interno del servidor. Intenta nuevamente más tarde o contacta soporte técnico.