SMS API, SMPP API MS Scheduler API
Kasutusjuhend
SMS API, SMPP API MS Scheduler API
| Muudetud: | 6 |
| Versioon: | 1.7 |
| Autor: | Kenny Colander Norden, KCN |
See dokument on mõeldud ainult määratud adressaadile ja võib sisaldada privilegeeritud, omandiõigusega kaitstud või muul viisil privaatset teavet. Kui saite selle ekslikult, teavitage kohe saatjat ja kustutage originaal. Igasugune muu dokumendi kasutamine teie poolt on keelatud.
Muudatuste ajalugu
| Rev | Kuupäev | By | Muudatused võrreldes eelmise versiooniga |
| 1.0 | 2010-03-16 | KCN | Loodud |
| 1. | 2019-06-11 | TPE | Uuendatud LINK logod |
| 1. | 2019-09-27 | PNI | Lisatud viide SMPP 3.4 spetsifikatsioonile |
| 1. | 2019-10-31 | EP | Tähelepanu kehtivusaja kohta tag |
| 1. | 2020-08-28 | KCN | Lisatud teave toetatud TLS-i versioonide kohta |
| 2. | 2022-01-10 | KCN | Lisatud lisateavet kohaletoimetamise aruannete kohta TLS 1.3 kohta käiva teabe värskendamine |
| 2. | 2025-06-03 | GM | Lisatud tulemuse kood 2108 |
| 2. | 2025-06-24 | AK | Lisatud kvoot |
Sissejuhatus
LINK Mobility on olnud SMS-ide levitaja alates 2001. aastast ning omab palju kogemusi nii operaatorite kui ka ühenduste koondajatega töötamisel. See platvorm on loodud suurte liiklusmahtude haldamiseks, kõrge kättesaadavuse säilitamiseks ja liikluse suunamiseks mitme ühenduse kaudu.
See dokument kirjeldab SMPP liidest SMSC-platvormiga ning milliseid parameetreid ja käske on vaja ja milliseid parameetreid toetatakse.
See dokument ei käsitle spetsiifilisi kasutusjuhtumeid, nagu liitsõnumid, WAPpush, Flash SMS jne. Lisateavet nende juhtumite kohta saate toega ühendust võttes.
Toetatud käsud
LINK Mobility serverit tuleks käsitleda kui SMPP 3.4. Ametliku spetsifikatsiooni leiate aadressilt https://smpp.org/SMPP_v3_4_Issue1_2.pdf.
Kõiki meetodeid ei toetata ja kõik erinevused on toodud allpool.
4.1 Seo
Toetatud on järgmised sidumiskäsud.
- Saatja
- transciver
- Vastuvõtja
Nõutavad parameetrid:
- system_id – saadud toest
- parool – saadud tugiteenusest
Valikulised parameetrid:
- addr_ton – vaikeväärtus, kui TON on esitamise ajal seatud väärtusele Tundmatu.
- addr_npi – vaikeväärtus, kui NPI on esitamise ajal seatud väärtusele Tundmatu.
Toetamata parameetrid:
- aadressi_vahemik
4.2 Vabasta sidumine
Unbind käsk on toetatud.
4.3 Päringu link
Käsk päring link on toetatud ja seda tuleks kutsuda iga 60 sekundi järel.
4.4 Esitage
Sõnumite edastamiseks tuleks kasutada saatmismeetodit.
Nõutavad parameetrid:
- source_addr_ton
- source_addr_npi
- allika_adr
- siht_adr_ton
- dest_addr_npi
- siht_adr
- esm_class
- data_coding
- sm_pikkus
- lühike_sõnum
Toetamata parameetrid:
- teenuse_tüüp
- protokolli_id
- prioriteedi_lipp
- ajakava_tarneaeg
- asenda_kui_esine_lipp
- sm_default_msg_id
Märkus et kasulik koormus tag ei toetata ja ühe kõne kohta võidakse edastada ainult üks SMS ning on soovitatav, et validity_period tag mille väärtus on vähemalt 15 minutit pikk.
4.4.1 Soovitatav TON ja NPI
Sõnumite saatmisel käsuga Esita tuleks kasutada järgmisi TON-i ja NPI-sid.
4.4.1.1 Allikas
Lähteaadressi jaoks toetatakse järgmisi TON-i ja NPI kombinatsioone. Kõiki teisi kombinatsioone käsitletakse kehtetutena. Vaikimisi TON-i sidumiskäsklusest kasutatakse, kui TON on seatud väärtusele Tundmatu (0). Vaikimisi NPI-d sidumiskäsklusest kasutatakse, kui NPI on seatud väärtusele Tundmatu (0).
| TON | NPI | Kirjeldus |
| Tähtnumbriline (5) | Tundmatu (0) ISDN (1) |
Käsitletakse kui tähtnumbrilist saatja teksti |
| Rahvusvaheline (1) | Tundmatu (0) ISDN (1) |
Käsitletakse kui MSISDN |
| Riiklik (2) Võrguspetsiifiline (3) Abonendinumber (4) Lühendatud (6) |
Tundmatu (0) ISDN (1) Riiklik (8) |
Seda käsitletakse riigipõhise lühinumbrina. |
4.4.1.2 Sihtkoht
Sihtkoha aadressi jaoks toetatakse järgmisi TON ja NPI kombinatsioone. Kõik muud kombinatsioonid loetakse kehtetuks. Kui TON on seatud väärtusele Tundmatu (0), kasutatakse vaikekäsku TON from bind. Kui NPI väärtuseks on määratud Tundmatu (0), kasutatakse vaikimisi käsku NPI from bind.
| TON | NPI | Kirjeldus |
| Rahvusvaheline (1) | Tundmatu (0) ISDN (1) |
Käsitletakse kui MSISDN |
4.4.2 Toetatud kodeeringud
Toetatud on järgmised kodeeringud. X võib sisaldada mis tahes väärtust.
| DCS | Kodeerimine |
| 0xX0 | Vaikimisi GSM-tähestik koos laiendiga |
| 0xX2 | 8-bitine binaarfail |
| 0xX8 | UCS2 (ISO-10646-UCS-2) |
Kvoot
5.1 Kvoot ületatudview
Kvoot määrab SMS-sõnumite maksimaalse arvu, mida saab saata kindla ajavahemiku jooksul (näiteks päevas, nädalas, kuus või määramata aja jooksul). Iga kvooti identifitseerib unikaalselt kvoot ID (UUID) ja see lähtestatakse vastavalt kliendi ajavööndile. Kvoote saab määrata riigi, piirkonna või vaiketasemel Quota Pro kaudu.fileKvooti saab dünaamiliselt määrata ka kvootide kaardistamise abil. See seob vanema kvootide ID (UUID) ja unikaalse kvootide võtme (nt saatja või kasutaja) konkreetse kvootide ID-ga.
Kvoot määratakse vastavalt teie kohalikule toele, teie määratud kontohaldurile või vaikimisi, kui midagi pole täpsustatud.
5.2 Staatus 106 – Kvoot ületatud
SMS-sõnum võidakse blokeerida olekukoodiga 106 („kvoot ületatud“), kui:
- Sõnum ületab vastava kvoota ID jaoks määratletud limiidi praeguses intervallis.
- Sihtriigile või -regioonile pole kvooti määratud (st see on selgesõnaliselt blokeeritud nullkvoodi kaardiga rakenduses).file).
- Vastavat kvooti ja vaikekvooti pole määratletud, mille tulemuseks on tagasilükkamine.
Sellistel juhtudel takistab süsteem edasist sõnumite töötlemist, et jõustada kliendi- või sihtkohapõhiseid piiranguid ja vältida väärkasutust.
Kättetoimetamise aruanne
Toetatud on ainult eduka/ebaõnnestunud tulemusega või lõplik tarnimine.
Tarnearuande vorming: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx valmimiskuupäev: yyMMddHHmm stat:
Olekus saadaolevad väärtused:
- DELIVRD
- AEGUNUD
- VÄLJA LÜKATUD
- EDASTA TAGASI
- KUSTUTATUD
6.1 Laiendatud tarnearuande formaat
Tarnearuannetes sisalduvat laiendatud teavet võite küsida oma müügiesindajaga ühendust võttes.
Kohaletoimetamise aruande vorming: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx sub:000 dlvrd:000 esitamise kuupäev:
aaKKPPPPmm valmimiskuupäev: aaKKPPPPmm statistika: viga: tekst:
Olekus saadaolevad väärtused:
- DELIVRD
- AEGUNUD
- VÄLJA LÜKATUD
- EDASTA TAGASI
- KUSTUTATUD
Väljad "sub" ja "dlvrd" seatakse alati väärtusele 000 ja väli "tekst" on alati tühi.
Välja "err" väärtuste kohta vaadake peatükki Veakoodid.
Toetatud TLS-i versioonid
TLS 1.2 või TLS 1.3 on nõutav kõigi TLS-ühenduste jaoks SMPP kaudu.
TLS 1.0 ja 1.1 tugi on lõpetatud alates 2020-11-15. TLS-i versioonid 1.0 ja 1.1 on vanemad protokollid, mis on aegunud ja mida Interneti kogukonnas peetakse turvariskideks.
LINK soovitab tungivalt kasutada TLS-i, kui tänapäeval kasutatakse krüptimata SMPP-ühendusi. Krüptimata SMPP-ühendused on alates 2020-09-01 poolt LINK katkestatud ja need eemaldatakse tulevikus. Krüptimata ühenduste eemaldamise kuupäev pole veel otsustatud.
Ühendused SMPP-serveriga TLS-i jaoks on pordis 3601, mitte krüptimata pordis 3600.
Võite endiselt kasutada TLS-i, isegi kui teie SMPP-rakendus ei toeta stunneli kasutavat TLS-i, vt https://www.stunnel.org/
Veakoodid
Kui väli on lubatud, võidakse veaväljale vastata järgmistele veakoodidele.
| Veakood | Kirjeldus |
| 0 | Tundmatu viga |
| 1 | Ajutine marsruutimisviga |
| 2 | Püsiv marsruutimisviga |
| 3 | Maksimaalne drossel on ületatud |
| 4 | Aegumine |
| 5 | Operaator tundmatu viga |
| 6 | Operaatori viga |
| 100 | Teenust ei leitud |
| 101 | Kasutajat ei leitud |
| 102 | kontot ei leitud |
| 103 | Vale parool |
| 104 | Konfiguratsiooniviga |
| 105 | Sisemine viga |
| 106 | Kvoot ületatud |
| 200 | OK |
| 1000 | Saadetud |
| 1001 | Tarnitud |
| 1002 | Aegunud |
| 1003 | Kustutatud |
| 1004 | Mobiil täis |
| 1005 | Järjekorras |
| 1006 | Ei tarnitud |
| 1007 | Tarnitud, tasumine viibib |
| 1008 | Laetud, sõnumit ei saadetud |
| 1009 | Laetud, sõnumit ei edastatud |
| 1010 | Aegunud, operaatori tarnearuanne puudub |
| 1011 | Tasu võetud, sõnum saadetud (operaatorile) |
| 1012 | Kaugelt järjekorras |
| 1013 | Sõnum saadeti operaatorile, laadimine viibib |
| 2000 | Vale allikanumber |
| 2001 | Lühinumbrit ei toetata allikana |
| 2002 | Alfa ei ole allikana toetatud |
| 2003 | MSISDN-i allikanumbrina ei toetata |
| 2100 | Lühinumbrit sihtkohana ei toetata |
| 2101 | Alfat sihtkohana ei toetata |
| 2102 | MSISDN-i sihtkohana ei toetata |
| 2103 | Toiming blokeeritud |
| 2104 | Tundmatu tellija |
| 2105 | Sihtkoht blokeeritud |
| 2106 | Numbri viga |
| 2107 | Sihtkoht ajutiselt blokeeritud |
| 2108 | Kehtetu sihtkoht |
| 2200 | Laadimisviga |
| 2201 | Abonendi saldo on madal |
|
2202 |
Tellija blokeeriti ülemakstud summa eest (tasuline teenus)
sõnumid |
|
2203 |
Tellija on selle konkreetse jaoks liiga noor
sisu) |
| 2204 | Ettemaksuga abonent pole lubatud |
| 2205 | Tellija lükkas teenuse tagasi |
| 2206 | Tellija pole maksesüsteemis registreeritud |
| 2207 | Tellija on saavutanud maksimaalse saldo |
| 2208 | Vajalik on lõppkasutaja kinnitus |
| 2300 | Tagastatud |
|
2301 |
Tagasimakset ei õnnestunud ebaseadusliku või puuduva kauba tõttu
MSISDN |
| 2302 | Puuduva sõnumi ID tõttu ei saanud raha tagasi maksta |
| 2303 | Tagastamise järjekorras |
| 2304 | Tagasimakse ajalõpp |
| 2305 | Tagasimakse ebaõnnestumine |
| 3000 | GSM-kodeeringut ei toetata |
| 3001 | UCS2 kodeeringut ei toetata |
| 3002 | Binaarset kodeeringut ei toetata |
| 4000 | Tarnearuannet ei toetata |
| 4001 | Kehtetu sõnumi sisu |
| 4002 | Kehtetu tariif |
| 4003 | Kehtetud kasutajaandmed |
| 4004 | Kehtetu kasutajaandmete päis |
| 4005 | Vale andmete kodeering |
| 4006 | Kehtetu käibemaks |
| 4007 | Sihtkoha jaoks toetamata sisu |
Dokumendid / Ressursid
 |
link mobiilsuse SMS API, SMPP API MS Scheduler API [pdfKasutusjuhend SMS API SMPP API MS Scheduler API, SMS API SMPP API, MS Scheduler API, Scheduler API, API |