SMS API, SMPP API MS Scheduler API
Käyttöopas
SMS API, SMPP API MS Scheduler API
| Muokattu: | 6 |
| Versio: | 1.7 |
| Tekijä: | Kenny Colander Norden, KCN |
Tämä asiakirja on tarkoitettu vain nimetylle vastaanottajalle ja voi sisältää luottamuksellisia, omistusoikeudellisia tai muuten yksityisiä tietoja. Jos olet saanut sen erehdyksessä, ilmoita siitä välittömästi lähettäjälle ja poista alkuperäinen. Kaikki muu asiakirjan käyttö on kielletty.
Muutoshistoria
| Rev | Päivämäärä | By | Muutoksia edelliseen julkaisuun |
| 1.0 | 2010-03-16 | KCN | Luotu |
| 1. | 2019-06-11 | TPE | Päivitetyt LINK-logot |
| 1. | 2019-09-27 | PNI | Lisätty viittaus SMPP 3.4 -spesifikaatioon |
| 1. | 2019-10-31 | EP | Havainto voimassaoloajasta tag |
| 1. | 2020-08-28 | KCN | Lisätty tietoja tuetuista TLS-versioista |
| 2. | 2022-01-10 | KCN | Lisätty lisätietoja toimitusraporteista Päivitettyjä tietoja TLS 1.3:sta |
| 2. | 2025-06-03 | GM | Lisätty tuloskoodi 2108 |
| 2. | 2025-06-24 | AK | Lisätty kiintiö |
Johdanto
LINK Mobility on toiminut SMS-jakelijana vuodesta 2001 ja hänellä on pitkä kokemus työskentelystä sekä operaattoreiden että yhteysaggregaattoreiden kanssa. Tämä alusta on suunniteltu käsittelemään suuria liikennemääriä, ylläpitämään korkeaa käytettävyyttä ja helpottamaan liikenteen reitittämistä useiden yhteyksien kautta.
Tämä dokumentti kuvaa SMPP-rajapinnan SMSC-alustaan sekä tarvittavat parametrit ja komennot ja tuetut parametrit.
Tässä dokumentissa ei käsitellä tiettyjä käyttötapauksia, kuten ketjutettuja viestejä, WAPpush-viestejä, Flash SMS -viestejä jne. Lisätietoja näistä tapauksista saat ottamalla yhteyttä tukeen.
Tuetut komennot
LINK Mobilityn palvelinta tulee käsitellä SMPP 3.4:nä. Virallinen erittely löytyy osoitteesta https://smpp.org/SMPP_v3_4_Issue1_2.pdf.
Kaikkia menetelmiä ei tueta, ja kaikki erot on määritelty alla.
4.1 Sido
Seuraavia sidoskomentoja tuetaan.
- Lähetin
- Transciever
- Vastaanotin
Vaaditut parametrit:
- system_id – saatu tuesta
- salasana – saatu tuesta
Valinnaiset parametrit:
- addr_ton – oletusarvo, jos TON on Tuntematon lähetyksen aikana.
- addr_npi – oletusarvo, jos NPI:n arvo on Tuntematon lähetyksen aikana.
Parametrit, joita ei tueta:
- osoiteväli
4.2 Pura sidonta
Unbind-komentoa tuetaan.
4.3 Tiedustelulinkki
Inquire link -komentoa tuetaan ja se tulee kutsua 60 sekunnin välein.
4.4 Lähetä
Viestien toimittamiseen tulee käyttää lähetysmenetelmää.
Vaaditut parametrit:
- source_addr_ton
- source_addr_npi
- lähde_osoite
- dest_addr_ton
- dest_addr_npi
- dest_addr
- esm_class
- data_koodaus
- sm_length
- lyhyt_viesti
Parametrit, joita ei tueta:
- palvelutyyppi
- protokollatunnus
- prioriteetti_lippu
- aikataulu_toimitusaika
- korvaa_jos_nykyinen_lippu
- sm_default_msg_id
Huom että hyötykuorma tag ei tueta, ja vain yksi tekstiviesti voidaan toimittaa per puhelu, ja on suositeltavaa, että validity_period tag sen arvo on vähintään 15 minuuttia pitkä.
4.4.1 Suositeltu TON ja NPI
Seuraavia TON ja NPI tulee käyttää lähetettäessä viestejä Lähetä-komennolla.
4.4.1.1 Lähde
Seuraavia TON- ja NPI-yhdistelmiä tuetaan lähdeosoitteena. Kaikkia muita yhdistelmiä käsitellään virheellisinä. Oletusarvoista TON-arvoa sidontakomennosta käytetään, jos TON on asetettu arvoon Tuntematon (0). Oletusarvoista NPI-arvoa sidontakomennosta käytetään, jos NPI on asetettu arvoon Tuntematon (0).
| TON | NPI | Kuvaus |
| Aakkosnumeerinen (5) | Tuntematon (0) ISDN (1) |
Käsitellään aakkosnumeerisena lähettäjän tekstinä |
| Kansainvälinen (1) | Tuntematon (0) ISDN (1) |
Käsitellään MSISDN:nä |
| Kansallinen (2) Verkkokohtainen (3) Tilaajanumero (4) Lyhennetty (6) |
Tuntematon (0) ISDN (1) Kansallinen (8) |
Käsitellään maakohtaisena lyhytnumerona. |
4.4.1.2 Määränpää
Seuraavia TON- ja NPI-yhdistelmiä tuetaan kohdeosoitteena. Kaikki muut yhdistelmät katsotaan kelpaamattomiksi. Oletusarvoista TON from bind -komentoa käytetään, jos TON on Tuntematon (0). Oletusarvoista NPI from bind -komentoa käytetään, jos NPI-asetukseksi on asetettu Tuntematon (0).
| TON | NPI | Kuvaus |
| Kansainvälinen (1) | Tuntematon (0) ISDN (1) |
Käsitellään MSISDN:nä |
4.4.2 Tuetut koodaukset
Seuraavat koodaukset ovat tuettuja. X voi sisältää minkä tahansa arvon.
| DCS | Koodaus |
| 0xX0 | Oletus-GSM-aakkoset jatkeen |
| 0xX2 | 8-bittinen binaari |
| 0xX8 | UCS2 (ISO-10646-UCS-2) |
Kiintiö
5.1 Kiintiön ylitysview
Kiintiö määrittää lähetettävien tekstiviestien enimmäismäärän tietyllä aikavälillä (kuten päivässä, viikossa, kuukaudessa tai toistaiseksi). Jokainen kiintiö tunnistetaan yksilöllisesti quotaId:llä (UUID), ja se nollataan asiakkaan aikavyöhykkeen mukaan. Kiintiöitä voidaan määrittää maan, alueen tai oletustasolla Quota Pron avulla.fileKiintiö voidaan myös määrittää dynaamisesti käyttämällä kiintiökartoitusta. Tämä yhdistää pää-Kiintiötunnuksen (UUID) ja yksilöllisen kiintiöavaimen (esim. lähettäjä tai käyttäjä) tiettyyn kiintiötunnukseen.
Kiintiö asetetaan paikallisen tuen, määritetyn asiakaspäällikön tai oletusarvoisesti, jos mitään ei ole määritetty.
5.2 Tila 106 – Kiintiö ylitetty
Tekstiviesti voidaan estää tilakoodilla 106 ("kiintiö ylitetty"), kun:
- Viesti ylittää vastaavan quotaId:n määritetyn rajan nykyisellä aikavälillä.
- Kohdemaalle tai -alueelle ei ole määritetty kiintiötä (eli se on nimenomaisesti estetty null-kiintiömäärityksellä tuotteessa).file).
- Vastaavaa kiintiötä ei ole eikä oletuskiintiötä ole määritetty, mikä johtaa hylkäämiseen.
Näissä tapauksissa järjestelmä estää viestien jatkokäsittelyn asiakas- tai kohdekohtaisten rajoitusten valvomiseksi ja väärinkäytösten välttämiseksi.
Toimitusraportti
Vain ei mitään tai lopullista toimitusta onnistuneella/epäonnistuneella tuloksella tuetaan.
Toimitusraportin muoto: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -päivämäärä: yyMMddHHmm stat:
Käytettävissä olevat arvot tilassa:
- DELIVRD
- PÄÄNTYNYT
- hylätty
- EI TOIMITTAA
- POISTETTU
6.1 Laajennettu toimitusraporttimuoto
Laajennetut tiedot toimitusraporteista voidaan pyytää ottamalla yhteyttä myyntiedustajaasi.
Toimitusraportin muoto: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx sub:000 dlvrd:000 lähetyspäivämäärä:
vvkkpphhmm valmistumispäivämäärä: vvkkpphhmm tilasto: virhe: teksti:
Käytettävissä olevat arvot tilassa:
- DELIVRD
- PÄÄNTYNYT
- hylätty
- EI TOIMITTAA
- POISTETTU
"sub"- ja "dlvrd"-kentät asetetaan aina arvoon 000, ja "teksti"-kenttä on aina tyhjä.
Katso ”err”-kentän arvot luvusta Virhekoodit.
Tuetut TLS-versiot
TLS 1.2 tai TLS 1.3 vaaditaan kaikkiin TLS-yhteyksiin SMPP:n kautta.
TLS 1.0:n ja 1.1:n tuki on lopetettu 2020 alkaen. TLS:n versiot 11 ja 15 ovat vanhempia protokollia, jotka on vanhentunut ja joita pidetään tietoturvariskeinä Internet-yhteisössä.
LINK suosittelee vahvasti TLS:n käyttöä, jos nykyään käytetään salaamattomia SMPP-yhteyksiä. LINK on poistanut salaamattomat SMPP-yhteydet käytöstä 2020-09-01 alkaen, ja ne poistetaan tulevaisuudessa. Salaamattomien yhteyksien poistamisen päivämäärää ei ole vielä päätetty.
Yhteydet TLS:n SMPP-palvelimeen ovat portissa 3601 salaamattomien portin 3600 sijaan.
Voit silti käyttää TLS:ää, vaikka SMPP-toteutus ei tuekaan stunnelia käyttävää TLS:ää, katso https://www.stunnel.org/
Virhekoodit
Seuraavat virhekoodit voidaan vastata virhekenttään, jos kenttä on käytössä.
| Virhekoodi | Kuvaus |
| 0 | Tuntematon virhe |
| 1 | Väliaikainen reititysvirhe |
| 2 | Pysyvä reititysvirhe |
| 3 | Suurin kuristus ylitetty |
| 4 | Aikakatkaisu |
| 5 | Käyttäjä tuntematon virhe |
| 6 | Operaattorin virhe |
| 100 | Palvelua ei löydy |
| 101 | Käyttäjää ei löydy |
| 102 | Tiliä ei löydy |
| 103 | Väärä salasana |
| 104 | Määritysvirhe |
| 105 | Sisäinen virhe |
| 106 | Kiintiö ylitetty |
| 200 | OK |
| 1000 | Lähetetty |
| 1001 | Toimitettu |
| 1002 | Vanhentunut |
| 1003 | Poistettu |
| 1004 | Mobiili täynnä |
| 1005 | Jonossa |
| 1006 | Ei toimitettu |
| 1007 | Toimitettu, laskutus myöhässä |
| 1008 | Ladattu, viestiä ei lähetetty |
| 1009 | Ladattu, viestiä ei toimitettu |
| 1010 | Vanhentunut, operaattorin toimitusraportti puuttuu |
| 1011 | Veloitettu, viesti lähetetty (operaattorille) |
| 1012 | Etäjonossa |
| 1013 | Viesti lähetetty operaattorille, lataus viivästyy |
| 2000 | Virheellinen lähdenumero |
| 2001 | Lyhytnumeroa ei tueta lähteenä |
| 2002 | Alfaa ei tueta lähteenä |
| 2003 | MSISDN:ää ei tueta lähdenumerona |
| 2100 | Lyhytnumeroa ei tueta kohteena |
| 2101 | Alfaa ei tueta kohteena |
| 2102 | MSISDN:ää ei tueta kohteena |
| 2103 | Toiminta estetty |
| 2104 | Tuntematon tilaaja |
| 2105 | Kohde estetty |
| 2106 | Numerovirhe |
| 2107 | Kohde väliaikaisesti estetty |
| 2108 | Virheellinen kohde |
| 2200 | Latausvirhe |
| 2201 | Tilaajan saldo on alhainen |
|
2202 |
Tilaaja estetty yliveloituksen vuoksi (premium-liittymä)
viestejä |
|
2203 |
Tilaaja on liian nuori (tähän nimenomaiseen tarkoitukseen)
sisältö) |
| 2204 | Prepaid-tilaaja ei ole sallittu |
| 2205 | Tilaaja hylkäsi palvelun |
| 2206 | Tilaaja ei ole rekisteröitynyt maksujärjestelmään |
| 2207 | Tilaaja on saavuttanut enimmäissaldon |
| 2208 | Loppukäyttäjän vahvistus tarvitaan |
| 2300 | Hyvitetty |
|
2301 |
Hyvitystä ei voitu suorittaa laittoman tai puuttuvan tuotteen vuoksi
MSISDN |
| 2302 | Hyvitystä ei voitu palauttaa, koska viestin tunnus puuttuu |
| 2303 | Jonossa hyvitystä varten |
| 2304 | Hyvityksen aikakatkaisu |
| 2305 | Hyvitys epäonnistui |
| 3000 | GSM-koodausta ei tueta |
| 3001 | UCS2-koodausta ei tueta |
| 3002 | Binaarikoodausta ei tueta |
| 4000 | Toimitusraporttia ei tueta |
| 4001 | Virheellinen viestin sisältö |
| 4002 | Virheellinen tariffi |
| 4003 | Virheelliset käyttäjätiedot |
| 4004 | Virheellinen käyttäjätietojen otsikko |
| 4005 | Virheellinen datakoodaus |
| 4006 | Virheellinen ALV |
| 4007 | Kohdetta ei tueta |
Asiakirjat / Resurssit
 |
linkki liikkuvuus SMS API, SMPP API MS Scheduler API [pdfKäyttöopas SMS API SMPP API MS Scheduler API, SMS API SMPP API, MS Scheduler API, Scheduler API, API |