SMS brána - API

SMS brána má k dispozici vlastní API. Pro API dotazy se využívá URL: https://smsapi.fayn.cz/mex/

API dokumentaci naleznete tu: API.

API práva je možné přidělit jednomu uživateli SMS brány (username, password). Každý API požadavek (zasílání SMS, získání statistik) je nutné autorizovat pomocí tokenu, získáného z požadavku https://smsapi.fayn.cz/mex/login. Příklad (postman):

Zaslání SMS (vložení tokenu jako Bearer Token):

Zaslání SMS (body):

• dotaz POST: https://smsapi.fayn.cz/mex/sms/send
• body:
  • nutné parametry:
    • Odesílatel - na výběr je z více možností, dle nastavení SMS brány:
      • aNumber - pokud je nastaveno v SMS bráně VoIP číslo/čísla, lze v aNumber zadat číslo ve formátu 00420XXXXXXXXX
      • shortcode - vlastní číselný shortcode, např. 8844
      • textId - vlastní textový řetězec (maximálně 11 znaků)
      • "prázdné" - Odesílatel "Info"
    • Příjemce - bNumber ve formátu 00420XXXXXXXXX
    • Typ zprávy / messageType - pouze SMS
    • Text SMS zprávy - text
  • doplňkové parametry:
    • priority
    • sendAt
    • externalId

Další dostupné API dotazy jsou pro získání odeslaných nebo přijatých SMS a statistik.