Integrace RichPear Home

Cisco Webex Teams

Cisco Webex Teams posílá oznámení z RichPear Home do prostoru v Cisco Webex. Používá Webex bot token a ID prostoru, do kterého má bot přístup.

Začít nastavení Zpět na integrace

Doména: cisco_webex_teams
Kategorie: oznámení
Komunikace: cloudové odesílání
Nastavení: ruční konfigurace v YAML
Výstup: notifikační služba do Webex prostoru

Co integrace přidá

Integrace vytvoří notifikační službu, kterou můžete volat z automatizací a skriptů. Zprávy se posílají do konkrétního Webex prostoru podle hodnoty room_id.

Pro provoz potřebujete Webex bota, jeho bot token a prostor, ve kterém je bot přidaný jako účastník. Bot token nepoužívejte z cizích ukázek a nesdílejte ho v dokumentaci ani v dashboardech.

Webex zprávy mohou obsahovat omezenou sadu HTML značek pro formátování, například tučný text, seznamy, odkazy, kód, odstavce a vybrané typy blokových zvýraznění.

Kontrolní témata

Vyžaduje Webex účet a vytvořeného bota.
Potřebuje bot token a room_id cílového prostoru.
Bot musí být v cílovém prostoru přidaný jako účastník.
Nastavuje se ručně v konfiguraci RichPear Home.

Příprava před přidáním

Před přidáním si připravte Webex bot token a room_id prostoru, do kterého chcete posílat zprávy. Bot musí být v prostoru přidaný jako účastník, jinak kontrola tokenu a prostoru neprojde.

RichPear Home se v domácí síti běžně otevírá na http://rphome.local:8123. Pokud tato adresa v dané síti neodpoví, použijte http://IP-ADRESA:8123.

Pro testování lze použít vlastní Webex účet, nově vytvořený testovací prostor a vlastního bota. Pro pokročilé scénáře Webex nabízí také vývojářský sandbox; pro běžné odesílání zpráv do prostoru ale obvykle stačí standardní bot.

Nastavení v RichPear Home

Tato integrace se nastavuje ručně v konfiguraci. Doplňte položku do sekce notify, restartujte RichPear Home a potom ověřte notifikační službu ruční testovací zprávou.

notify:
  - name: webex_domacnost
    platform: cisco_webex_teams
    token: YOUR_BOT_TOKEN
    room_id: CISCO_WEBEX_TEAMS_ROOMID

Hodnota name určuje název akce pro odeslání oznámení. V uvedeném příkladu vznikne akce notify.webex_domacnost.

room_id získáte z Webex prostoru. Ve webovém klientu otevřete prostor a zkopírujte ID z adresy, nebo v desktopové aplikaci použijte zkratku pro zkopírování informací o prostoru: Control+Shift+K na Windows nebo Command+Shift+K na macOS.

Kontrola entit a funkcí

Po restartu odešlete testovací zprávu přes akci notifikační služby. Pokud zpráva do prostoru dorazí, token, room_id i členství bota jsou nastavené správně.

Pokud zpráva nedorazí, nejdřív ověřte, že bot je účastníkem cílového prostoru a že používáte bot token, ne dočasný osobní token.

Po nastavení

Pošlete krátkou testovací zprávu do testovacího prostoru.
Zkontrolujte, pod jakým jménem se zpráva ve Webexu zobrazí.
Ověřte formátování jen na bezpečné ukázkové zprávě.
Teprve potom oznámení použijte v produkčních automatizacích.

Použití v automatizacích

V automatizacích používejte akci notify.NAZEV podle hodnoty name v konfiguraci. Do dat posílejte alespoň message; volitelně lze použít i title.

actions:
  - action: notify.webex_domacnost
    data:
      title: "<strong>Upozornění</strong>"
      message: "<blockquote class=warning>V technické místnosti je vyšší teplota.</blockquote>"

Podporované formátování držte jednoduché. Bezpečně používejte například <strong>, <i>, <code>, <pre>, <p>, seznamy, odkazy a <blockquote> s třídami danger, warning, info, primary nebo secondary.

Provoz a údržba

Po změně bot tokenu, odstranění bota z prostoru nebo změně cílového prostoru upravte konfiguraci a restartujte RichPear Home. Potom odešlete testovací zprávu.

Token ukládejte jen do konfigurace nebo do správy tajných hodnot. Neposílejte ho do logů, screenshotů, chatu ani sdílených dokumentů.

Řešení problémů

Když oznámení neodchází, ověřte bot token, room_id, členství bota v prostoru, syntaxi konfigurace a dostupnost Webex služby z instance RichPear Home. Potom otevřete Nastavení → Systém → Logy a hledejte chyby podle domény cisco_webex_teams.

Pokud konfigurace po restartu nevytvoří notifikační službu, chyba bývá v tokenu, cílovém prostoru nebo v odsazení YAML. Pokud služba existuje, ale zpráva nedorazí, zkontrolujte oprávnění bota v daném prostoru.