TAS:description

From twidunode wiki
Jump to: navigation, search

TAS Townet Alerting System

TAS è un sistema messo a punto da Townet che permette l'invio di messaggi di alerting verso un BOT Telegram. Il sistema è suddiviso in due parti: Il BOT Telegram Il gateway di inoltro verso Telegram

L'invio dei messaggi è subordinato alla creazione di una lista di distribuzione a cui un utente può associarsi. Le liste di distribuzione vengono create da Townet e assegnate ai propri clienti. Scrivere a support@townet.it per richiedere una lista di distribuzione.

Telegram

Telegram


Telegram è un sistema di messaggistica molto simile a Whatsapp che permette di instaurare delle chat con dei sistemi informativi oltre che con persone fisiche. E' liberamente installabile su qualsiasi smarthphone o PC. questo il sito ufficiale: https://telegram.org/

Gateway Inoltro

E' il sistema con cui i devices possono inviare messaggi al BOT e quindi vedere recapitati gli stessi a tutti i componenti della lista. Il gateway utilizza un approccio molto semplice con una API REST. La API richiede pochi parametri che possono essere inviati indifferentemente via POST o GET.

Indirizzo API: https://iot.mywaver.it/townetalert/message/


Parametro Desrizione
list Nome della lista a cui inviare il messaggio. Viene fornita da Townet
message Contenuto del messaggio da inviare. Per messaggi inviati via GET si consigli di effettuare url encode.
severity Livello di severity del messaggio. default = 3
btn Permette di allegare al messaggio una sequenza di pulsanti. Parametro opzionale.


Esempio: https://iot.mywaver.it/townetalert/message/?message=HelloWorld&list=testtownet

Manda il messaggio "HelloWorld" a tutti i membri della lista testtownet con severity impostata a 3 (error)

Invio di pulsanti Inline

Questa funzionalità introdotta con la nuova versione del BOT (giugno 2019) permette di poter inviare un'ulteriore parametro specificando una sequenza di bottoni Inline associati al messaggio. Ogni bottone verrà poi ricondotto ad un URL di callback che deve essere specificato nel messaggio. Il parametro "btn" richiede quindi l'invio di una struttura dati json con una sequenza di informazioni per ciascun bottone da creare.

Ecco un esempio operativo

{
"buttons":[
	{
		"caption":"Send me more informations",
		"id":"1",
		"reply":0,
		"callback":"https://[your_callback_url]/",
		"method":"POST",			
		"parameters":[
			{"key":"nome_campo_1", "value":"1"},
			{"key":"nome_campo_2", "value":"2"}
            ]
    },
	{
		"caption":"Try to reboot device",
		"id":"2",
		"reply":1,
		"callback":"https://[your_callback_url]/",
		"method":"POST",			
		"parameters":[
			{"key":"nome_campo_1", "value":"1"},
			{"key":"nome_campo_2", "value":"2"}
            ]
	}    
    ]
}


Parametro Desrizione
caption Testo che compare nel pulsante
id Identificativo univoco del pulsante. Può essere un numero qualsiasi purchè univoco nella lista.
reply Se impostato a 1 invia un messaggio come risposta altrimenti no.
callback URL della pagina che deve essere chiamata dal BOT per eseguire l'azione richiesta
method Metodo usato per l'invio. Può essere GET o POST. Si consiglia l'uso di POST.
parameters E' un array di oggetti key:vale che rappresentano i parametro che verranno inviati all URL di callback.


ATTENZIONE! Fare grande attenzione alla corretta struttura del codice JSON per evitare malfunzionamenti.

Telegram BOT Inline Buttons

BOT Telegram

Il bot risponde ad una serie di comandi che verranno utilizzati dall'utente per definire le liste a cui è associato. L'utente potrà quindi procedere a registrarsi nella lista, stoppare il servizio, farlo ripartire etc.. Il BOT è unidirezionale e serve solo per ricevere messaggi dalla rete e non ha funzionalità interattive con i devices. Per poter utilizzare il bot basta semplicemente cercare "townetalert_bot" dentro l'applicazione e comparirà l'iconcina. Selezionare e premere il bottone "Start" che automaticamente appare in basso alla schermata della chat.

Al primo accesso viene richiesta la registrazione con una mail valida che dovrà poi essere confermata via mail oppure inserendo il codice di verifica arrivato via e-mail.

Di seguiro un esempio del primo accesso.

Telegram BOT Telegram BOT Telegram BOT



Ricordati che un BOT è un sistema di messaggistica quindi risponde a comandi testuali. Non si tratta di una APP da installare ma è un meccanismo automatico di dialogo via chat.