Ir al contenido

API de notificaciones

Las alarmas que se envían a las personas en cuanto se activan y se despejan. Cómo funciona y cómo configurar cada canal: Notificaciones. El equivalente en la CLI es dtvsol notify …. Autenticación y errores: consulte la descripción general de la API.

La configuración, con cada contraseña y token sustituidos por si están configurados o no, y cómo le fue al último mensaje de cada canal.

Ventana de terminal
curl -s "http://ROUTER-IP:8880/notify" -H "X-API-Key: YOUR_API_KEY"
{
"ok": true,
"enabled": true,
"levels": ["critical"],
"changes": true,
"clears": true,
"link": "https://XXX.XXX.XXX.10:8881/",
"email": {"enabled": true, "to": ["noc@your-isp.com"], "host": "smtp.your-isp.com", "port": 587,
"security": "starttls", "user": "alarms@your-isp.com", "password_set": true},
"telegram": {"enabled": true, "chats": ["-1001234567890"], "token_set": true},
"whatsapp": {"enabled": false},
"sms": {"enabled": false},
"status": {
"email": {"at": "2026-09-28 10:31:05", "t": 1790591465, "ok": true, "error": null},
"telegram": {"at": "2026-09-28 10:31:06", "t": 1790591466, "ok": false, "error": "chat -1001234567890: HTTP 403: Forbidden: bot was kicked from the group chat"}
}
}

Cambia la configuración: los campos que se envían cambian, los demás se mantienen.

Nombre En Tipo Notas
enabled body boolean Enviar las alarmas, o no.
levels body array critical, warning y/o info. Por defecto ["critical"].
changes body boolean También cada cambio que falló, sea cual sea su nivel. Por defecto true.
clears body boolean Cuando una alarma se despeja. Por defecto true.
link body string Se agrega al final de cada mensaje (https://…); vacío lo elimina.
email body object enabled, to (un arreglo, o direcciones separadas por comas), add, del (una dirección), host, port, security (starttls, tls, none), user, password, from.
telegram body object enabled, chats (chat ids o @channel), add, del, token.
whatsapp body object enabled, to (números, con + y el código de país), add, del, phone_id, template, lang, token.
sms body object enabled, to, add, del, sid (la cuenta de Twilio), from (el número de Twilio), token.

En un canal, un password o token enviado vacío conserva el guardado, null lo elimina, y "reset": true olvida la configuración del canal. Los secretos se guardan cifrados y nunca se devuelven.

Ventana de terminal
curl -s -X POST "http://ROUTER-IP:8880/notify/set" -H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"enabled": true, "telegram": {"enabled": true, "add": "-1001234567890", "token": "123456:ABC…"}}'

{"ok": true, "message": "notification settings saved"}, o 400 con {"ok": false, "error": …} para un valor que no es válido (no cambia nada).

Envía un mensaje de prueba por un canal en este momento.

Nombre En Tipo Notas
channel body string email, telegram, whatsapp o sms. Obligatorio.

{"ok": true, "message": "sent by telegram to 1 recipient(s)"}, o 502 con {"ok": false, "error": …} y el motivo del proveedor (HTTP 401: Unauthorized…).

Este sitio fue escrito con ayuda de IA y revisado por nuestro equipo.