SMS odosielanie (sms-brana.sk)

Odoslanie SMS správy na mobilný telefón cez API, kompatibilné s pôvodným API servera sms-brana.sk / sms-brana.org.

Na prihlasovanie je možné použiť SMS účet používaný prihlasovanie do sms-brana.sk - v tomto prípade sa pri odosielaní správy použije identifikácia odosielateľa priradená k tomuto účtu. Je tiež možné použiť prihlasovanie cez účet používaný na prístup do mojoperator.sk - v tomto prípade je nutné tiež uviesť číslo zmluvy, ku ktorej sa budú poplatky účtovať, a identifikáciu odosielateľa. Pozor, tento spôsob prihlasovania nemusí byť v budúcnosti podporovaný a neodporúčame ho využívať.

Nakoľko súčasná SMS brána zatiaľ nepodporuje kreditový systém ani zisťovanie stavu odosialných SMS správ, tieto návratové hodnoty nie sú používané. Do budúcnosti plánujeme kompatibilitu s pôvodným API zdokonaliť a doplniť v súčasnosti nepodporované vlastnosti (podpora kreditov, zisťovanie stavu odoslaných správ, a podobne).

Prístup k API

Parametre

  • LOGIN - do tohto poľa je potrebné uviesť prihlasovacie meno k SMS účtu (používa sa na prihlásenie do sms-brana.sk). Dočasne je možné použiť na prihlasovanie aj účet do portálu mojoperator.sk, v tom prípade však musí byť v tomto poli uvedená trojica parametrov oddelených znakom |, a to:
    • prihlasovacie meno do mojoperator.sk
    • číslo zmluvy, na ktorú bude SMS účtovaná, napr. 770987654
    • identifkácia odosielateľa - textový reťazec, max. 11 znakov (identifikácia číslom v príprave)
  • PASSWORD - heslo k účtu do sms-brana.sk alebo mojoperator.sk (podľa použitého LOGIN-u)
  • TO - telefónne číslo adresáta. Podporovaný je tvar 09xx xxx xxx, 00421 9xx xxx xxx, 421 9xx xxx xxx. Ak budú v čísle uvedené aj znaky ako medzera, pomĺčka, lomítko, plus a podobné, budú z čísla na strane servera odstránené.
  • TEXT - text správy - dlhý text bude rozdelený do viacerých SMS správ.

Odpoveď - formát plain-text

Odpoveď na požiadavky je kvôli kompatibilite s pôvodným API sms-brana.sk / sms-brana.org posielaná v rovnakom formáte, hoci niektoré polia v odpovedi momentálne nemajú význam. Kvôli existujúcim aplikáciám je odpoveď poskytovaná v tvare bez diakritiky. Odpoveď je v podobe textového reťazca, ktorého časti sú oddelené dvojbodkou, napríklad:

OK:Sprava bola odoslana:0d39b9cd0e0ef5e4df8f5a877eafb81c:0.8:8.4

Jednotlivé časti reťazca majú nasledovný význam:
  • Stav [OK|ERR]
  • Bližší textový popis stavu (textová hláška v slovenskom jazyku)
  • Pridelený identifkkátor správy na strane servera (momentálne sa nepoužíva - bude doplnené neskôr)
  • Zaúčtovaný debet v kreditoch (momentálne sa nepoužíva - obsahuje vždy hodnotu 0 - bude doplnené neskôr)
  • Zostávajúci kredit (momentálne sa nepoužíva - obsahuje 999 ak je možné správu odoslať, alebo -1 ak je prekročený finančný limit k zmluve a odoslanie nie je možné)

Príklad použitia - program wget


/usr/bin/wget --no-check-certificate "https://api.sms-brana.org/https/send_sms.php?login=smsbrana_username&password=smsbrana_password&to=42190x123456&sms_text=testing+api"
/usr/bin/wget --no-check-certificate "https://api.sms-brana.org/https/send_sms.php?login=mojoperator_username|770987654|MojaFirma&password=mojoperator_password&to=42190x123456&sms_text=testing+api"

Toto volanie spôsobí odosielanie správy cez prihlasovacie meno my_username a heslo my_password. Správa bude mať odosielateľa MojaFirma a bude zaslaná na číslo +421 90x 123 456, s textom "testing api". Odoslanie správy bude účtované na zmluvu 770987654, ktorá patrí pod konto my_username.