Monitoreo y Admin

Endpoints para consultar estadísticas y gestionar la cola de mensajes de tus instancias.

Estadísticas globales

json
GET /admin/stats

// Respuesta 200
{
  "instances": 2,
  "totals": { "queued": 5, "sent": 1250, "failed": 3 },
  "perInstance": [
    {
      "instanceName": "acme__soporte__main",
      "queue":    { "urgent": 0, "normal": 5, "bulk": 2, "total": 7 },
      "messages": { "sent": 450, "failed": 1, "pending": 7 }
    }
  ]
}

Vaciar cola de una instancia

Elimina todos los mensajes pendientes de la cola. Útil para emergencias o resets.

json
DELETE /admin/queue/acme__soporte__main

// Respuesta 200
{ "instanceName": "acme__soporte__main", "flushed": 12 }

Health check

No requiere autenticación. Útil para monitores externos y load balancers.

json
GET /health  (no requiere apikey)

// Respuesta 200
{
  "status": "ok",
  "uptime": 3600
}

Códigos de error

StatusSignificadoAcción
400Body inválidoVer campo issues en respuesta
401API key faltante o inválidaVerificar header apikey
403Sin acceso al recursoinstanceName debe empezar con tu tenantId
404Instancia o mensaje no existeVerificar nombre o ID
409Instancia ya existeUsar la existente o elegir otro nombre
502Error en servicio WhatsAppVerificar sesión; reintentar
500Error internoReportar a soporte
json
// Error 400 — validación
{
  "error": "Validation error",
  "issues": [
    { "path": ["instanceName"], "message": "Must follow {tenant}__{client}__{label} format" }
  ]
}

// Otros errores
{ "error": "Instance not found" }