SMS API, SMPP API MS Scheduler API
Gebruikersgids
SMS API, SMPP API MS Scheduler API
Gewysig: | 6/24/2025 |
Weergawe: | 1.7 |
Skrywer: | Kenny Colander Norden, KCN |
Hierdie dokument is slegs vir die aangewese ontvanger en kan bevoorregte, eiendoms- of andersins privaat inligting bevat. As jy dit per abuis ontvang het, stel asseblief die sender onmiddellik in kennis en vee die oorspronklike uit. Enige ander gebruik van die dokument deur jou is verbode.
Verander geskiedenis
Ds | Datum | By | Veranderinge vanaf vorige vrystelling |
1.0 | 2010-03-16 | KCN | Geskep |
1. | 2019-06-11 | TPE | Opgedateerde LINK-logo's |
1. | 2019-09-27 | PNI | Bygevoeg verwysing na SMPP 3.4 spesifikasie |
1. | 2019-10-31 | EP | Waarneming oor die geldigheidstydperk tag |
1. | 2020-08-28 | KCN | Bygevoeg inligting oor ondersteunde TLS weergawes |
2. | 2022-01-10 | KCN | Added additional information regarding delivery reports Updated information regarding TLS 1.3 |
2. | 2025-06-03 | GM | Added result code 2108 |
2. | 2025-06-24 | AK | Added quota |
Inleiding
LINK Mobility is sedert 2001 'n SMS-verspreider en het baie ondervinding in die werk met beide operateurs en verbindingsaggregators. Hierdie platform is ontwerp om groot verkeersvolumes te hanteer, 'n hoë beskikbaarheid te handhaaf en dit maklik te maak om verkeer via veelvuldige verbindings te stuur.
Hierdie dokument beskryf die SMPP-koppelvlak na die SMSC-platform en watter parameters en bevele benodig word en watter parameters ondersteun word.
This document will not handle specific use cases as concatenated messages, WAPpush, Flash SMS, etc. More information about those cases can be provided by contacting support.
Ondersteunde opdragte
LINK Mobility se bediener moet as SMPP 3.4 hanteer word. Die amptelike spesifikasie kan gevind word by https://smpp.org/SMPP_v3_4_Issue1_2.pdf.
Alle metodes word nie ondersteun nie, en alle verskille word hieronder gespesifiseer.
4.1 Bind
Die volgende bindopdragte word ondersteun.
- Sender
- Transciever
- Ontvanger
Vereiste parameters:
- system_id – verkry vanaf ondersteuning
- wagwoord – verkry vanaf ondersteuning
Opsionele parameters:
- addr_ton – verstekwaarde as TON op Onbekend gestel is tydens indiening.
- addr_npi – verstekwaarde as NPI op Onbekend gestel is tydens indiening.
Onondersteunde parameters:
- adres_reeks
4.2 Ontbind
Die ontbind-opdrag word ondersteun.
4.3 Navrae skakel
Die navraagskakelopdrag word ondersteun en moet elke 60 sekondes geroep word.
4.4 Dien in
Die indieningsmetode moet gebruik word om boodskappe af te lewer.
Vereiste parameters:
- source_addr_ton
- source_addr_npi
- bron_addr
- dest_addr_ton
- dest_addr_npi
- dest_addr
- esm_klas
- data_kodering
- sm_lengte
- kort_boodskap
Onondersteunde parameters:
- diens_tipe
- protokol_id
- prioriteit_vlag
- skedule_afleweringstyd
- vervang_as_teenwoordig_vlag
- sm_default_msg_id
Let wel dat die loonvrag tag word nie ondersteun nie en slegs een SMS mag per oproep afgelewer word en dit word aanbeveel dat die validity_period tag het 'n waarde van ten minste 15 minute lank.
4.4.1 Aanbevole TON en NPI
Die volgende TON en NPI moet gebruik word wanneer boodskappe gestuur word deur middel van submit command.
4.4.1.1 Bron
The following TON and NPI combinations are supported for source address. All other combinations will be treated as invalid. The default TON from bind command will be used if TON is set to Unknown (0). The default NPI from bind command will be used if NPI is set to Unknown (0).
TON | NPI | Beskrywing |
Alfanumeries (5) | Onbekend (0) ISDN (1) |
Sal as alfanumeriese senderteks hanteer word |
Internasionaal (1) | Onbekend (0) ISDN (1) |
Sal as MSISDN behandel word |
Nasionaal (2) Network specific (3) Subscriber number (4) Abbreviated (6) |
Onbekend (0) ISDN (1) Nasionaal (8) |
Sal as landspesifieke kortnommer hanteer word. |
4.4.1.2 Bestemming
Die volgende TON- en NPI-kombinasies word vir bestemmingsadres ondersteun. Alle ander kombinasies sal as ongeldig hanteer word. Die verstek TON vanaf bind-opdrag sal gebruik word as TON op Onbekend (0) gestel is. Die verstek NPI vanaf bind-opdrag sal gebruik word as NPI op Onbekend (0) gestel is.
TON | NPI | Beskrywing |
Internasionaal (1) | Onbekend (0) ISDN (1) |
Sal as MSISDN behandel word |
4.4.2 Ondersteunde enkoderings
Die volgende enkoderings word ondersteun. X kan enige waarde bevat.
DKD | Enkodering |
0xX0 | Standaard GSM-alfabet met uitbreiding |
0xX2 | 8-bis binêre |
0xX8 | UCS2 (ISO-10646-UCS-2) |
Kwota
5.1 Kwota Oorview
A quota defines the maximum number of SMS messages that can be sent within a specified time interval (such as per day, week, month, or indefinitely). Each quota is uniquely identified by a quotaId (UUID) and is reset according to the customer’s time zone. Quotas can be assigned at the country, region, or default level through a Quota Profile. Quota can also be dynamically assigned using Quota Mapping. This maps a parent QuotaId (UUID) and a unique quota Key (e.g., sender or user) to a specific quotaId.
'n Kwota word vasgestel in ooreenstemming met u plaaslike ondersteuning, u toegewyse rekeningbestuurder of by verstek indien niks gespesifiseer is nie.
5.2 Status 106 – Quota Exceeded
An SMS message may be blocked with status code 106 (“quota exceeded”) when:
- The message exceeds the defined limit for its corresponding quotaId within the current interval.
- The destination country or region has no quota assigned (i.e., is explicitly blocked with a null quota mapping in the profile).
- There is no matching quota and no default quota is defined, resulting in rejection.
In hierdie gevalle verhoed die stelsel verdere boodskapverwerking om kliënt- of bestemmingsgebaseerde limiete af te dwing en misbruik te vermy.
Afleweringsverslag
Slegs geen of finale aflewering met 'n suksesvolle/mislukkende resultaat word ondersteun nie.
Formaat op afleweringsverslag: ID: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx gedaan datum: jjMMddHHmm stat:
Beskikbare waardes in status:
- AFLEWER
- VERVAL
- VERWERP
- ONTLEEF
- GESKEE
6.1 Uitgebreide afleweringsverslagformaat
Uitgebreide inligting in afleweringsverslae kan in kontak met u verkoopsverteenwoordiger aangevra word.
Format on delivery report: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx sub:000 dlvrd:000 submit date:
yyMMddHHmm done date: yyMMddHHmm stat: <status> err: <error code> text:
Beskikbare waardes in status:
- AFLEWER
- VERVAL
- VERWERP
- ONTLEEF
- GESKEE
"sub" en "dlvrd" velde sal altyd op 000 gestel word, en "text" veld sal altyd leeg wees.
Sien hoofstuk Foutkodes vir waardes vir die "fout"-veld.
Ondersteunde TLS-weergawes
TLS 1.2 of TLS 1.3 word vereis vir alle TLS-verbindings oor SMPP.
Ondersteuning vir TLS 1.0 en 1.1 word gestaak sedert 2020-11-15. Weergawes 1.0 en 1.1 van TLS is ouer protokolle wat afgekeur is en word as sekuriteitsrisiko's in die internetgemeenskap beskou.
LINK beveel sterk aan om TLS te gebruik as ongeënkripteerde SMPP-verbindings vandag gebruik word. Ongeënkripteerde SMPP-verbindings word vanaf 2020-09-01 deur LINK opgeskort en sal in die toekoms verwyder word. Datum vir verwydering van ongeënkripteerde verbindings is nog nie besluit nie.
Verbindings na die SMPP-bediener vir TLS is by poort 3601 in plaas van ongeënkripteer by poort 3600.
Jy kan steeds TLS gebruik, selfs al ondersteun jou SMPP-implementering nie TLS met behulp van stunnel nie, sien https://www.stunnel.org/
Foutkodes
Die volgende foutkodes kan in die foutveld beantwoord word as die veld geaktiveer is.
Foutkode | Beskrywing |
0 | Onbekende fout |
1 | Tydelike roeteerfout |
2 | Permanente roeteerfout |
3 | Maksimum versnelling oorskry |
4 | Uitteltyd |
5 | Operator onbekende fout |
6 | Operateursfout |
100 | Diens nie gevind nie |
101 | Gebruiker nie gevind nie |
102 | Rekening nie gevind nie |
103 | Ongeldige Wagwoord |
104 | Konfigurasiefout |
105 | Interne fout |
106 | Quota exceeded |
200 | OK |
1000 | Gestuur |
1001 | Afgelewer |
1002 | Verval |
1003 | Geskrap |
1004 | Selfoon vol |
1005 | In die ry |
1006 | Nie afgelewer nie |
1007 | Afgelewer, heffing vertraag |
1008 | Gelaai, boodskap nie gestuur nie |
1009 | Gelaai, boodskap nie afgelewer nie |
1010 | Verval, afwesigheid van operateur afleweringsverslag |
1011 | Gehef, boodskap gestuur (aan operateur) |
1012 | Op afstand in die ry |
1013 | Boodskap gestuur aan operateur, laai vertraag |
2000 | Ongeldige bronnommer |
2001 | Kort nommer word nie as bron ondersteun nie |
2002 | Alfa word nie as bron ondersteun nie |
2003 | MSISDN word nie as bronnommer ondersteun nie |
2100 | Kort nommer word nie as bestemming ondersteun nie |
2101 | Alfa word nie as bestemming ondersteun nie |
2102 | MSISDN word nie as bestemming ondersteun nie |
2103 | Operasie geblokkeer |
2104 | Onbekende intekenaar |
2105 | Bestemming geblokkeer |
2106 | Nommerfout |
2107 | Bestemming tydelik geblokkeer |
2108 | Invalid destination |
2200 | Laaifout |
2201 | Intekenaar het 'n lae balans |
2202 |
Subscriber barred for overcharged (premium)
boodskappe |
2203 |
Subscriber too young (for this particular
inhoud) |
2204 | Voorafbetaalde intekenaar word nie toegelaat nie |
2205 | Diens verwerp deur intekenaar |
2206 | Intekenaar nie geregistreer in die betaalstelsel nie |
2207 | Intekenaar het maksimum saldo bereik |
2208 | Eindgebruiker bevestiging nodig |
2300 | Terugbetaal |
2301 |
Could not refund due to illegal or missing
MSISDN |
2302 | Kon nie terugbetaal nie weens ontbrekende boodskap-ID |
2303 | In die ry vir terugbetaling |
2304 | Terugbetaling uitteltyd |
2305 | Terugbetaling mislukking |
3000 | GSM-kodering word nie ondersteun nie |
3001 | UCS2-kodering word nie ondersteun nie |
3002 | Binêre enkodering word nie ondersteun nie |
4000 | Afleweringsverslag word nie ondersteun nie |
4001 | Ongeldige boodskapinhoud |
4002 | Ongeldige tarief |
4003 | Ongeldige gebruikerdata |
4004 | Ongeldige gebruikerdata-opskrif |
4005 | Ongeldige datakodering |
4006 | Ongeldige BTW |
4007 | Ongesteunde inhoud vir bestemming |
Dokumente / Hulpbronne
![]() |
skakel mobiliteit SMS API, SMPP API MS Scheduler API [pdf] Gebruikersgids SMS API SMPP API MS Scheduler API, SMS API SMPP API, MS Scheduler API, Scheduler API, API |