Integrace RichPear Home

Clickatell

Clickatell přidává odesílání SMS oznámení přes cloudovou SMS platformu Clickatell.

Začít nastavení Zpět na integrace

Doména: clickatell
Kategorie: oznámení
Komunikace: cloudové odesílání
Nastavení: ruční konfigurace
Vyžaduje: Clickatell API klíč

Ukázka v RichPear Home

Screenshoty ukazují české rozhraní RichPear Home při vyhledání integrace a při prvním bezpečném kroku nastavení.

Vyhledání Clickatell v RichPear Home — Vyhledání Clickatell v katalogu integrací.

Ruční konfigurace Clickatell v RichPear Home — RichPear Home u Clickatell ukazuje ruční konfiguraci v souboru configuration.yaml.

Co integrace přidá

Integrace vytvoří oznamovací službu, která posílá SMS na zadané telefonní číslo přes Clickatell. Zprávy se odesílají jako jednosměrná oznámení.

Při odeslání se používá API klíč, telefonní číslo příjemce a text zprávy. Telefonní číslo zadávejte ve formátu požadovaném nastavením Clickatell integrace, typicky v mezinárodním formátu bez znaménka plus.

Clickatell je placená nebo účtovaná cloudová služba podle nastavení účtu. Nepoužívejte cizí API klíče ani testovací údaje z veřejných zdrojů.

Kontrolní témata

Vlastní účet v Clickatell SMS Platform Portal.
SMS integrace typu HTTP.
API klíč a cílové telefonní číslo.

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

V Clickatell SMS Platform Portal vytvořte novou SMS integraci. Nastavte ji pro produkční použití, jako typ API zvolte HTTP a pro messaging typ vyberte one way messaging.

Po dokončení zkopírujte vygenerovaný API klíč. Současně si ověřte, jak má být v účtu nastavený mezinárodní formát telefonních čísel, protože to ovlivní hodnotu příjemce v konfiguraci.

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 test použijte jen vlastní Clickatell účet a vlastní telefonní číslo. Náhodné veřejné klíče nebo údaje cizích osob do konfigurace nepatří.

Nastavení v RichPear Home

Tato integrace se nastavuje ručně v konfiguraci. Po úpravě souboru konfiguraci uložte, restartujte RichPear Home a potom odešlete testovací oznámení.

notify:
  - platform: clickatell
    name: sms_clickatell
    api_key: VAS_CLICKATELL_API_KLIC
    recipient: "420777123456"

Položka name určuje název oznamovací služby. V automatizacích ji potom použijete jako notify.sms_clickatell.

Kontrola odesílání

Po restartu odešlete krátkou testovací SMS přes vytvořenou oznamovací službu. Ověřte doručení, správné telefonní číslo a případné účtování ve svém Clickatell účtu.

Pokud SMS nedorazí, zkontrolujte API klíč, formát čísla, stav Clickatell integrace, dostupný kredit a logy v RichPear Home.

Po nastavení

Pošlete jednu krátkou testovací SMS.
Ověřte cenu nebo kredit za odeslání.
Do automatizací přidejte omezení proti opakovanému spamování.
API klíč ukládejte mimo veřejně sdílené ukázky.

Použití v automatizacích

SMS používejte pro důležitá oznámení, která mají dorazit i mimo běžné push notifikace, například alarm, výpadek napájení nebo servisní stav.

Každou automatizaci doplňte o podmínky, časové omezení nebo pomocný přepínač, aby chyba čidla neposlala desítky placených SMS.

Provoz a údržba

Pravidelně kontrolujte platnost API klíče, dostupný kredit, historii odeslaných zpráv a telefonní číslo příjemce. Po změně API klíče nebo příjemce upravte konfiguraci a restartujte RichPear Home.

Při sdílení konfigurace odstraňte skutečný API klíč a telefonní číslo. Citlivé údaje nikdy nevkládejte do veřejných ukázek.

Řešení problémů

Když se SMS neodešle, ověřte API klíč, příjemce, formát čísla, kredit, typ Clickatell integrace HTTP a jednosměrné zasílání. Potom otevřete Nastavení → Systém → Logy a hledejte chyby podle domény clickatell.

Chyby odesílání mohou souviset i s odpovědí Clickatell API. Pokud log obsahuje stavový kód nebo text chyby, porovnejte jej s nastavením svého účtu a SMS integrace.