BW3-Core/docu/docs/plugin/telegram.md
2020-05-01 23:52:38 +02:00

50 lines
1.2 KiB
Markdown

# <center>Telegram</center>
---
## Beschreibung
Mit diesem Plugin ist es moeglich, Telegram-Nachrichten für POCSAG-Alarmierungen zu senden.
Außerdem werden Locations versendet, wenn die Felder `lat` und `lon` im Paket definiert sind. (beispielsweise durch das [Geocoding](../modul/geocoding.md) Modul)
## Unterstütze Alarmtypen
- Fms
- Pocsag
- Zvei
- Msg
## Resource
`telegram`
## Konfiguration
|Feld|Beschreibung|Default|
|----|------------|-------|
|botToken|Der Api-Key des Telegram-Bots||
|chatIds|Liste mit Chat-Ids der Empfängers / der Emfänger-Gruppen||
|message_fms|Format der Nachricht für FMS|`{FMS}`|
|message_pocsag|Format der Nachricht für Pocsag|`{RIC}({SRIC})\n{MSG}`|
|message_zvei|Format der Nachricht für ZVEI|`{TONE}`|
|message_msg|Format der Nachricht für MSG||
**Beispiel:**
```yaml
- type: plugin
name: Telegram Plugin
res: telegram
config:
message_pocsag: "{RIC}({SRIC})\n{MSG}"
botToken: "BOT_TOKEN"
chatIds:
- "CHAT_ID"
```
---
## Modul Abhängigkeiten
Aus dem Modul [Geocoding](../modul/geocoding.md) (optional/nur POCSAG):
- `lat`
- `lon`
---
## Externe Abhängigkeiten
- python-telegram-bot