BW3-Core/docu/docs/plugin/telegram.md

43 lines
935 B
Markdown
Raw Normal View History

2020-02-18 22:12:53 +01:00
# <center>Telegram</center>
---
## Beschreibung
2020-02-22 22:53:03 +01:00
Mit diesem Plugin ist es moeglich, Telegram-Nachrichten für POCSAG-Alarmierungen zu senden.
Außerdem werden Locations versenden, wenn die Felder `lat` und `lon` im Paket definiert sind. (beispielsweise durch das Geocoding-Modul)
2020-02-24 22:15:28 +01:00
## Externe Abhängigkeiten
- python-telegram-bot
2020-02-18 22:12:53 +01:00
2020-02-22 19:08:53 +01:00
## Unterstütze Alarmtypen
- Pocsag
2020-02-18 22:12:53 +01:00
## Resource
`telegram`
## Konfiguration
|Feld|Beschreibung|Default|
|----|------------|-------|
2020-02-24 21:51:19 +01:00
|message|Format der Nachricht||
2020-02-18 22:12:53 +01:00
|botToken|Der Api-Key des Telegram-Bots||
2020-02-22 19:08:53 +01:00
|chatIds|Liste mit Chat-Ids der Empfängers / der Emfänger-Gruppen||
2020-02-18 22:12:53 +01:00
**Beispiel:**
```yaml
- type: plugin
name: Telegram Plugin
res: telegram
config:
2020-02-24 21:51:19 +01:00
message: "{RIC}({SRIC})\n{MSG}"
2020-02-22 19:08:53 +01:00
botToken: "{{ Telegram Bot Token }}"
chatIds:
- "{{ Telegram Chat Id }}"
2020-02-18 22:12:53 +01:00
```
---
## Abhängigkeiten
2020-02-24 22:35:30 +01:00
- Modul geocoding (Falls in Paket vorhanden):
- `lat`
- `lon`