API de notificações

Os alarmes enviados a pessoas assim que são disparados e encerrados. Como funciona e como configurar cada canal: Notificações. O equivalente na CLI é dtvsol notify …. Autenticação e erros: veja a visão geral da API.

GET /notify

As configurações, com cada senha e cada token substituídos pela indicação de se estão definidos, e como foi a última mensagem de cada canal.

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"}
  }
}

POST /notify/set

Altera as configurações: os campos informados mudam, os outros permanecem.

Nome	Em	Tipo	Observações
enabled	body	boolean	Envia os alarmes, ou não.
levels	body	array	critical, warning e/ou info. Padrão ["critical"].
changes	body	boolean	Também cada alteração que falhou, seja qual for o seu nível. Padrão true.
clears	body	boolean	Quando um alarme é encerrado. Padrão true.
link	body	string	Acrescentado no fim de cada mensagem (https://…); vazio o remove.
email	body	object	enabled, to (um array, ou endereços separados por vírgulas), add, del (um endereço), host, port, security (starttls, tls, none), user, password, from.
telegram	body	object	enabled, chats (chat ids ou @channel), add, del, token.
whatsapp	body	object	enabled, to (números, com + e o código do país), add, del, phone_id, template, lang, token.
sms	body	object	enabled, to, add, del, sid (a conta Twilio), from (o número Twilio), token.

Em um canal, um password ou token informado vazio mantém o armazenado, null o remove, e "reset": true esquece as configurações do canal. Os segredos são armazenados criptografados e nunca são devolvidos.

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"}, ou 400 com {"ok": false, "error": …} para um valor que não é válido (nada foi alterado).

POST /notify/test

Envia uma mensagem de teste em um canal agora.

Nome	Em	Tipo	Observações
channel	body	string	email, telegram, whatsapp ou sms. Obrigatório.

{"ok": true, "message": "sent by telegram to 1 recipient(s)"}, ou 502 com {"ok": false, "error": …} e o motivo do provedor (HTTP 401: Unauthorized…).