SMS API, SMPP API MS Scheduler API
Používateľská príručka
SMS API, SMPP API MS Scheduler API
| Upravené: | 6. 24. 2025 |
| Verzia: | 1.7 |
| autor: | Kenny Colander Norden, KCN |
Tento dokument je určený len pre určeného príjemcu a môže obsahovať privilegované, vlastnícke alebo inak súkromné informácie. Ak ste ho dostali omylom, ihneď o tom informujte odosielateľa a originál vymažte. Akékoľvek iné použitie dokumentu z vašej strany je zakázané.
História zmien
| Rev | Dátum | By | Zmeny oproti predchádzajúcemu vydaniu |
| 1.0 | 2010-03-16 | KCN | Vytvorené |
| 1. | 2019-06-11 | TPE | Aktualizované logá LINK |
| 1. | 2019-09-27 | Pni | Pridaný odkaz na špecifikáciu SMPP 3.4 |
| 1. | 2019-10-31 | EP | Pozorovanie o dobe platnosti tag |
| 1. | 2020-08-28 | KCN | Pridané informácie o podporovaných verziách TLS |
| 2. | 2022-01-10 | KCN | Pridané ďalšie informácie týkajúce sa správ o doručení Aktualizované informácie týkajúce sa TLS 1.3 |
| 2. | 2025-06-03 | GM | Pridaný výsledný kód 2108 |
| 2. | 2025-06-24 | AK | Pridaná kvóta |
Úvod
LINK Mobility je distribútorom SMS od roku 2001 a má bohaté skúsenosti s prácou s operátormi aj s agregátormi pripojení. Táto platforma je navrhnutá tak, aby zvládala veľké objemy premávky, udržala vysokú dostupnosť a uľahčila smerovanie prevádzky prostredníctvom viacerých pripojení.
Tento dokument popisuje rozhranie SMPP k platforme SMSC a ktoré parametre a príkazy sú potrebné a ktoré parametre sú podporované.
Tento dokument sa nebude zaoberať špecifickými prípadmi použitia, ako sú zreťazené správy, WAPpush, Flash SMS atď. Viac informácií o týchto prípadoch vám poskytne podpora.
Podporované príkazy
Server LINK Mobility by sa mal považovať za SMPP 3.4. Oficiálnu špecifikáciu nájdete na https://smpp.org/SMPP_v3_4_Issue1_2.pdf.
Všetky metódy nie sú podporované a všetky rozdiely sú uvedené nižšie.
4.1 Viazať
Podporované sú nasledujúce príkazy väzby.
- Vysielač
- transciever
- Prijímač
Požadované parametre:
- system_id – získané z podpory
- heslo – získané z podpory
Voliteľné parametre:
- addr_ton – predvolená hodnota, ak je TON počas odosielania nastavený na Neznámy.
- addr_npi – predvolená hodnota, ak je NPI počas odosielania nastavené na Neznáme.
Nepodporované parametre:
- rozsah_adresy
4.2 Zrušiť viazanie
Príkaz unbind je podporovaný.
4.3 Odkaz na dopyt
Príkaz dopytovať prepojenie je podporovaný a mal by sa volať každých 60 sekúnd.
4.4 Odoslať
Spôsob odosielania by sa mal používať na doručovanie správ.
Požadované parametre:
- source_addr_ton
- source_addr_npi
- source_addr
- dest_addr_ton
- dest_addr_npi
- dest_addr
- esm_class
- kódovanie údajov
- sm_dĺžka
- krátka správa
Nepodporované parametre:
- service_type
- protocol_id
- priorita_vlajka
- harmonogram_doručovania
- nahradiť_ak_prítomný_príznak
- sm_default_msg_id
Poznámka že užitočné zaťaženie tag nie je podporované a na jeden hovor môže byť doručená iba jedna SMS a odporúča sa, aby bola uvedená doba platnosti tag má hodnotu aspoň 15 minút.
4.4.1 Odporúčané TON a NPI
Nasledujúce TON a NPI by sa mali použiť pri odosielaní správ pomocou príkazu na odoslanie.
4.4.1.1 Zdroj
Pre zdrojovú adresu sú podporované nasledujúce kombinácie TON a NPI. Všetky ostatné kombinácie budú považované za neplatné. Ak je TON nastavený na Neznámy (0), použije sa predvolený príkaz TON z bind. Ak je NPI nastavený na Neznámy (0), použije sa predvolený príkaz NPI z bind.
| TON | NPI | Popis |
| Alfanumerické (5) | Neznáme (0) ISDN (1) |
Bude sa zaobchádzať ako s alfanumerickým textom odosielateľa |
| Medzinárodné (1) | Neznáme (0) ISDN (1) |
Bude spracované ako MSISDN |
| Národné (2) Číslo predplatiteľa (3) špecifické pre sieť (4) Skrátené (6) |
Neznáme (0) ISDN (1) Národné (8) |
Bude považované za krátke číslo špecifické pre danú krajinu. |
4.4.1.2 Miesto určenia
Pre cieľovú adresu sú podporované nasledujúce kombinácie TON a NPI. Všetky ostatné kombinácie budú považované za neplatné. Predvolený príkaz TON z väzby sa použije, ak je TON nastavený na Neznámy (0). Predvolený NPI z príkazu bind sa použije, ak je NPI nastavený na Neznámy (0).
| TON | NPI | Popis |
| Medzinárodné (1) | Neznáme (0) ISDN (1) |
Bude spracované ako MSISDN |
4.4.2 Podporované kódovania
Podporované sú nasledujúce kódovania. X môže obsahovať akúkoľvek hodnotu.
| DCS | Kódovanie |
| 0xX0 | Predvolená GSM abeceda s príponou |
| 0xX2 | 8-bitový binárny |
| 0xX8 | UCS2 (ISO-10646-UCS-2) |
Kvóta
5.1 Prekročenie kvótyview
Kvóta definuje maximálny počet SMS správ, ktoré je možné odoslať v rámci určeného časového intervalu (napríklad za deň, týždeň, mesiac alebo na neurčito). Každá kvóta je jedinečne identifikovaná identifikátorom quotaId (UUID) a resetuje sa podľa časového pásma zákazníka. Kvóty je možné priradiť na úrovni krajiny, regiónu alebo predvolenej úrovne prostredníctvom nástroja Quota Pro.fileKvótu je možné dynamicky priradiť aj pomocou mapovania kvót. Toto mapovanie mapuje nadradené ID kvóty (UUID) a jedinečný kľúč kvóty (napr. odosielateľ alebo používateľ) na konkrétne ID kvóty.
Kvóta sa nastavuje v súlade s vašou miestnou podporou, vaším prideleným správcom účtu alebo štandardne, ak nie je nič uvedené.
5.2 Stav 106 – Prekročená kvóta
SMS správa môže byť zablokovaná so stavovým kódom 106 („kvóta prekročená“), keď:
- Správa prekračuje definovaný limit pre zodpovedajúcu quotaId v rámci aktuálneho intervalu.
- Cieľová krajina alebo región nemá priradenú žiadnu kvótu (t. j. je explicitne blokovaný s mapovaním null kvóty v programefile).
- Neexistuje žiadna zodpovedajúca kvóta a nie je definovaná žiadna predvolená kvóta, čo vedie k zamietnutiu.
V týchto prípadoch systém zabráni ďalšiemu spracovaniu správ, aby vynútil limity založené na zákazníkovi alebo mieste určenia a zabránil zneužitiu.
Správa doručovateľa
Podporované sú iba žiadne alebo konečné doručenie s úspešným/neúspešným výsledkom.
Formát správy o doručení: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx dátum dokončenia: yyMMddHHmm stav:
Dostupné hodnoty v stave:
- DELIVRD
- EXPIROVANÁ
- ZAMIETNUTÉ
- UNDELIV
- VYMAZANÉ
6.1 Rozšírený formát správy o doručení
Rozšírené informácie v správach o doručení si môžete vyžiadať od svojho obchodného zástupcu.
Formát doručovacej správy: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx sub:000 dlvrd:000 dátum odoslania:
rrMMddHHmm dátum dokončenia: rrMMddHHmm štatistika: chyba: text:
Dostupné hodnoty v stave:
- DELIVRD
- EXPIROVANÁ
- ZAMIETNUTÉ
- UNDELIV
- VYMAZANÉ
Polia „sub“ a „dlvrd“ budú vždy nastavené na 000 a pole „text“ bude vždy prázdne.
Hodnoty pre pole „err“ nájdete v kapitole Kódy chýb.
Podporované verzie TLS
Pre všetky pripojenia TLS cez SMPP sa vyžaduje TLS 1.2 alebo TLS 1.3.
Podpora pre TLS 1.0 a 1.1 je ukončená od 2020. 11. 15. Verzie 1.0 a 1.1 TLS sú staršie protokoly, ktoré boli zastarané a v internetovej komunite sú považované za bezpečnostné riziká.
LINK dôrazne odporúča používať TLS, ak sa dnes používajú nešifrované pripojenia SMPP. Nešifrované pripojenia SMPP sú od 2020-09-01 zastarané od LINK a v budúcnosti budú odstránené. Dátum odstránenia nešifrovaných spojení ešte nie je stanovený.
Pripojenie k serveru SMPP pre TLS je na porte 3601 namiesto nešifrovaného na porte 3600.
Stále môžete používať TLS, aj keď vaša implementácia SMPP nepodporuje TLS pomocou stunnelu, pozri https://www.stunnel.org/
Chybové kódy
Nasledujúce chybové kódy môžu byť zodpovedané v poli Err, ak je pole povolené.
| Kód chyby | Popis |
| 0 | Neznáma chyba |
| 1 | Dočasná chyba smerovania |
| 2 | Trvalá chyba smerovania |
| 3 | Prekročené maximálne škrtenie |
| 4 | Časový limit |
| 5 | Neznáma chyba operátora |
| 6 | Chyba operátora |
| 100 | Služba sa nenašla |
| 101 | Používateľ sa nenašiel |
| 102 | účet nebol nájdený |
| 103 | Nesprávne heslo |
| 104 | Chyba konfigurácie |
| 105 | Vnútorná chyba |
| 106 | Kvóta prekročená |
| 200 | OK |
| 1000 | Odoslané |
| 1001 | Doručené |
| 1002 | Platnosť vypršala |
| 1003 | Odstránené |
| 1004 | Mobil je plný |
| 1005 | Vo fronte |
| 1006 | Nedoručené |
| 1007 | Doručené, nabitie oneskorené |
| 1008 | Nabité, správa nebola odoslaná |
| 1009 | Spoplatnené, správa nebola doručená |
| 1010 | Platnosť uplynula, chýba správa o doručení operátora |
| 1011 | Nabité, správa odoslaná (operátorovi) |
| 1012 | Vzdialene vo fronte |
| 1013 | Správa bola odoslaná operátorovi, nabíjanie sa oneskorilo |
| 2000 | Neplatné číslo zdroja |
| 2001 | Krátke číslo nie je podporované ako zdroj |
| 2002 | Alfa nie je podporovaná ako zdroj |
| 2003 | MSISDN nie je podporované ako zdrojové číslo |
| 2100 | Krátke číslo nie je podporované ako cieľ |
| 2101 | Alfa nie je podporovaná ako cieľ |
| 2102 | MSISDN nie je podporovaný ako cieľ |
| 2103 | Operácia zablokovaná |
| 2104 | Neznámy predplatiteľ |
| 2105 | Cieľ je zablokovaný |
| 2106 | Chyba čísla |
| 2107 | Cieľ je dočasne zablokovaný |
| 2108 | Neplatný cieľ |
| 2200 | Chyba nabíjania |
| 2201 | Predplatiteľ má nízky zostatok |
|
2202 |
Predplatiteľovi bol zablokovaný prístup z dôvodu nadmernej ceny (prémiové)
správy |
|
2203 |
Predplatiteľ je príliš mladý (pre tento konkrétny prípad)
obsah) |
| 2204 | Predplatiteľ nie je povolený |
| 2205 | Služba bola odmietnutá predplatiteľom |
| 2206 | Účastník nie je zaregistrovaný v platobnom systéme |
| 2207 | Predplatiteľ dosiahol maximálny zostatok |
| 2208 | Vyžaduje sa potvrdenie koncovým používateľom |
| 2300 | Vrátené |
|
2301 |
Nepodarilo sa vrátiť peniaze z dôvodu nelegálneho alebo chýbajúceho tovaru
MSISDN |
| 2302 | Nepodarilo sa vrátiť peniaze z dôvodu chýbajúceho ID správy |
| 2303 | Čaká na vrátenie peňazí |
| 2304 | Časový limit vrátenia platby vypršal |
| 2305 | Neúspešné vrátenie platby |
| 3000 | Kódovanie GSM nie je podporované |
| 3001 | Kódovanie UCS2 nie je podporované |
| 3002 | Binárne kódovanie nie je podporované |
| 4000 | Správa o doručení nie je podporovaná |
| 4001 | Neplatný obsah správy |
| 4002 | Neplatná tarifa |
| 4003 | Neplatné údaje používateľa |
| 4004 | Neplatná hlavička údajov používateľa |
| 4005 | Neplatné kódovanie údajov |
| 4006 | Neplatná DPH |
| 4007 | Nepodporovaný obsah pre cieľ |
Dokumenty / zdroje
 |
mobilita odkazov SMS API, SMPP API MS Scheduler API [pdf] Používateľská príručka SMS API SMPP API MS Scheduler API, SMS API SMPP API, MS Scheduler API, Scheduler API, API |