SMS¶

Služba zasílání zpráv může odesílat SMS upozornění pomocí SMSBrána SMS Connect.

Používejte SMS, když musí oznámení LogMan.io dorazit na telefonní číslo mimo e-mail nebo chatovací nástroje, například pro vysoce prioritní operační upozornění.

Služba vykreslí nakonfigurovanou SMS šablonu, normalizuje text zprávy a odešle ji do nakonfigurovaného SMS API.

Předpoklady¶

Než začnete nastavovat SMS, ujistěte se, že:

účet SMSBrána s povolenou službou SMS Connect je k dispozici
jsou k dispozici přihlašovací údaje a heslo k SMSBrána
server LogMan.io může přes HTTPS dosáhnout SMS API
účet SMSBrána má dostatek kreditu pro odesílání zpráv
je známé telefonní číslo příjemce, buď z požadavku na oznámení, nebo konfigurace nájemce
SMSBrána umožňuje požadavky z IP adresy serveru LogMan.io, pokud jsou povolena IP omezení
je k dispozici bezpečné místo pro ukládání hesla SMSBrána

Požadovaná konfigurační pole¶

Pole	Popis
`login`	Přihlášení do SMSBrány.
`password`	Heslo SMSBrána.
`api_url`	URL API SMS Connect SMSBrána.

Vzor konfigurace¶

Upravte soubor model.yaml pro konfiguraci služby asab-iris:

/Site/model.yaml

define:
  type: rc/model

services:
  asab-iris:
    instances:
      - node1
    asab:
      config:
        sms:
          login: "{{SMSBRANA_LOGIN}}"
          password: "{{SMSBRANA_PASSWORD}}"
          api_url: "https://api.smsbrana.cz/smsconnect/http.php"

secrets:
  SMSBRANA_LOGIN: {}
  SMSBRANA_PASSWORD: {}

Nastavení SMSBrány¶

Otevřete administraci SMSBrána.
Povolit SMS Connect pro účet, který bude služba používat.
Zkopírujte přihlašovací údaje SMSBrána do sms.login.
Uložte heslo SMSBrána do Vaultu nebo do úložiště tajemství používaného instalací LogMan.io.
Potvrďte URL API SMS Connect. Výchozí je https://api.smsbrana.cz/smsconnect/http.php.
Pokud SMSBrána omezuje API volání podle IP adresy, povolte IP adresu serveru LogMan.io.
Potvrďte, že účet má dostatek kreditu.
Aktualizujte /Site/model.yaml.
Použijte model z Knihovny, nebo spusťte příkaz pro aplikaci nasazení používaný instalací.
Odešlete testovací SMS notifikaci.

Ověřte konfiguraci¶

Konfigurace je připravena, když:

služba startuje bez chyb konfigurace SMS
SMSBrána přijímá API požadavek
testovací SMS je doručena na očekávané telefonní číslo
logy služby neobsahují chyby autentizace ani doručení SMSBrána
dlouhé zprávy jsou doručovány jako číslované části SMS, pokud zpráva přesáhne délku jednoho SMS segmentu

Šablony SMS¶

Šablony SMS musí být uloženy ve složce /Templates/SMS/ v Knihovně.

Vzorový šablona:

/Templates/SMS/alert.md

{{ severity }}: {{ message }}

Držte šablony SMS krátké a používejte pouze text ASCII. Služba odmítá SMS zprávy, které obsahují znaky mimo ASCII.

Příklad webového požadavku¶

{
  "phone": "+420123456789",
  "body": {
    "template": "/Templates/SMS/alert.md",
    "params": {
      "severity": "High",
      "message": "New security notification"
    }
  }
}

Příklad oznámení Kafka¶

Při odesílání přes Kafka nastavte type na sms.

{
  "type": "sms",
  "phone": "+420123456789",
  "body": {
    "template": "/Templates/SMS/alert.md",
    "params": {
      "severity": "High",
      "message": "New security notification"
    }
  }
}

Délka zprávy¶

Služba rozděluje dlouhé SMS zprávy na části:

první část může obsahovat až 160 znaků
následující části mohou obsahovat až 153 znaků
každá část je opatřena číslováním, například 1/2

SMSBrána odmítá zprávy, které jsou delší než její povolené limity. Udržujte text upozornění krátký a výstižný.