SMS API, SMPP API MS Scheduler API
Canllaw Defnyddiwr
SMS API, SMPP API MS Scheduler API
| Wedi'i addasu: | 6/24/2025 |
| Fersiwn: | 1.7 |
| Awdur: | Kenny Colander Norden, KCN |
Mae'r ddogfen hon ar gyfer y derbynnydd dynodedig yn unig a gall gynnwys gwybodaeth freintiedig, perchnogol neu breifat fel arall. Os ydych wedi ei dderbyn mewn camgymeriad, rhowch wybod i'r anfonwr ar unwaith a dilëwch y gwreiddiol. Gwaherddir unrhyw ddefnydd arall o'r ddogfen gennych chi.
Newid hanes
| Parch | Dyddiad | By | Newidiadau o'r datganiad blaenorol |
| 1.0 | 2010-03-16 | KCN | Wedi creu |
| 1. | 2019-06-11 | TPE | Logos LINK wedi'u diweddaru |
| 1. | 2019-09-27 | PNI | Cyfeiriad ychwanegol at fanyleb SMPP 3.4 |
| 1. | 2019-10-31 | EP | Sylw ar y cyfnod dilysrwydd tag |
| 1. | 2020-08-28 | KCN | Ychwanegwyd gwybodaeth am fersiynau TLS a gefnogir |
| 2. | 2022-01-10 | KCN | Ychwanegwyd gwybodaeth ychwanegol ynghylch adroddiadau dosbarthu Gwybodaeth wedi'i diweddaru ynghylch TLS 1.3 |
| 2. | 2025-06-03 | GM | Ychwanegwyd cod canlyniad 2108 |
| 2. | 2025-06-24 | AK | Cwota wedi'i ychwanegu |
Rhagymadrodd
Mae LINK Mobility wedi bod yn ddosbarthwr SMS ers 2001 ac mae ganddo lawer o brofiad o weithio gyda gweithredwyr a chydgrynwyr cysylltiadau. Mae'r platfform hwn wedi'i gynllunio i drin niferoedd mawr o draffig, cynnal argaeledd uchel a'i gwneud hi'n hawdd i gyfeirio traffig trwy gysylltiadau lluosog.
Mae'r ddogfen hon yn disgrifio'r rhyngwyneb SMPP i'r platfform SMSC a pha baramedrau a gorchmynion sydd eu hangen a pha baramedrau sy'n cael eu cefnogi.
Ni fydd y ddogfen hon yn ymdrin ag achosion defnydd penodol fel negeseuon cyfun, WAPpush, Flash SMS, ac ati. Gellir darparu rhagor o wybodaeth am yr achosion hynny drwy gysylltu â chymorth.
Gorchmynion a gefnogir
Dylid trin gweinydd LINK Mobility fel SMPP 3.4. Mae'r fanyleb swyddogol i'w gweld yn https://smpp.org/SMPP_v3_4_Issue1_2.pdf.
Ni chefnogir pob dull, a nodir yr holl wahaniaethau isod.
4.1 Rhwymo
Cefnogir y gorchmynion rhwymo canlynol.
- Trosglwyddydd
- Trawsgyweiriwr
- Derbynnydd
Paramedrau gofynnol:
- system_id – a gafwyd o gefnogaeth
- cyfrinair - a gafwyd o gefnogaeth
Paramedrau dewisol:
- addr_ton – gwerth rhagosodedig os yw TON wedi'i osod i Anhysbys yn ystod y cyflwyniad.
- addr_npi – gwerth diofyn os yw'r NPI wedi'i osod i Anhysbys yn ystod y cyflwyniad.
Paramedrau heb eu cefnogi:
- ystod_cyfeiriad
4.2 Rhwym
Cefnogir y gorchymyn dadrwymo.
4.3 Dolen holi
Cefnogir y gorchymyn cyswllt ymholiad a dylid ei alw bob 60 eiliad.
4.4 Cyflwyno
Dylid defnyddio'r dull cyflwyno ar gyfer cyflwyno negeseuon.
Paramedrau gofynnol:
- ffynhonnell_addr_tunnell
- ffynhonnell_addr_npi
- ffynhonnell_addr
- dest_addr_ton
- dest_addr_npi
- dest_addr
- dosbarth_esm
- data_codio
- sm_hyd
- neges_byr
Paramedrau heb eu cefnogi:
- gwasanaeth_math
- protocol_id
- blaenoriaeth_baner
- amserlen_cyflenwi_amser
- disodli_if_presennol_flag
- sm_default_msg_id
Nodyn bod y llwyth cyflog tag Nid yw'n cael ei gefnogi a dim ond un SMS y gellir ei anfon fesul galwad ac argymhellir bod y validity_period tag sydd â gwerth o 15 munud o hyd o leiaf.
4.4.1 TON ac NPI a argymhellir
Dylid defnyddio'r TON a'r NPI canlynol wrth anfon negeseuon gan ddefnyddio gorchymyn cyflwyno.
4.4.1.1 Ffynhonnell
Cefnogir y cyfuniadau TON ac NPI canlynol ar gyfer cyfeiriad ffynhonnell. Bydd pob cyfuniad arall yn cael ei drin fel un annilys. Defnyddir y gorchymyn TON o rwymo diofyn os yw TON wedi'i osod i Anhysbys (0). Defnyddir y gorchymyn NPI o rwymo diofyn os yw NPI wedi'i osod i Anhysbys (0).
| TON | DPC | Disgrifiad |
| alffaniwmerig (5) | Anhysbys (0) ISDN (1) |
Bydd yn cael ei drin fel testun anfonwr Alffaniwmerig |
| Rhyngwladol (1) | Anhysbys (0) ISDN (1) |
Bydd yn cael ei drin fel MSISDN |
| Cenedlaethol (2) Rhif tanysgrifiwr penodol i'r rhwydwaith (3) (4) Byrhau (6) |
Anhysbys (0) ISDN (1) Cenedlaethol (8) |
Bydd yn cael ei drin fel rhif byr gwlad-benodol. |
4.4.1.2 Cyrchfan
Cefnogir y cyfuniadau TON ac NPI canlynol ar gyfer cyfeiriad cyrchfan. Bydd pob cyfuniad arall yn cael ei drin fel un annilys. Bydd y gorchymyn TON rhagosodedig o rwymo yn cael ei ddefnyddio os yw TON wedi'i osod i Anhysbys (0). Bydd y NPI rhagosodedig o orchymyn rhwymo yn cael ei ddefnyddio os yw'r NPI wedi'i osod i Anhysbys (0).
| TON | DPC | Disgrifiad |
| Rhyngwladol (1) | Anhysbys (0) ISDN (1) |
Bydd yn cael ei drin fel MSISDN |
4.4.2 Amgodiadau â chymorth
Cefnogir yr amgodiadau canlynol. Gall X gynnwys unrhyw werth.
| DCS | Amgodio |
| 0xX0 | Yr Wyddor GSM ddiofyn gydag estyniad |
| 0xX2 | Deuaidd 8-did |
| 0xX8 | UCS2 (ISO-10646-UCS-2) |
Cwota
5.1 Cwota Drosview
Mae cwota yn diffinio'r nifer uchaf o negeseuon SMS y gellir eu hanfon o fewn cyfnod penodol o amser (megis y dydd, yr wythnos, y mis, neu am gyfnod amhenodol). Mae pob cwota wedi'i adnabod yn unigryw gan quotaId (UUID) ac mae'n cael ei ailosod yn ôl parth amser y cwsmer. Gellir neilltuo cwota ar lefel y wlad, y rhanbarth, neu'r lefel ddiofyn trwy Quota Pro.fileGellir neilltuo cwota'n ddeinamig hefyd gan ddefnyddio Mapio Cwota. Mae hyn yn mapio CwotaId rhiant (UUID) ac Allwedd cwota unigryw (e.e., anfonwr neu ddefnyddiwr) i quotaId penodol.
Gosodir cwota yn unol â'ch cymorth lleol, eich rheolwr cyfrif a neilltuwyd neu yn ddiofyn os nad oes dim wedi'i nodi.
5.2 Statws 106 – Cwota Wedi'i Drosglwyddo
Gall neges SMS gael ei rhwystro gyda chod statws 106 (“cwota wedi’i ragori”) pan:
- Mae'r neges yn fwy na'r terfyn diffiniedig ar gyfer ei quotaId cyfatebol o fewn y cyfnod cyfredol.
- Nid oes cwota wedi'i aseinio i'r wlad neu'r rhanbarth cyrchfan (h.y., mae wedi'i rwystro'n benodol gyda mapio cwota null yn y profile).
- Nid oes cwota cyfatebol ac nid oes cwota diofyn wedi'i ddiffinio, gan arwain at wrthod.
Yn yr achosion hyn, mae'r system yn atal prosesu negeseuon pellach i orfodi terfynau sy'n seiliedig ar gwsmeriaid neu gyrchfannau ac osgoi camddefnydd.
Adroddiad cyflawni
Dim ond dim neu gyflenwad terfynol gyda chanlyniad llwyddiannus/methiant a gefnogir.
Fformat ar yr adroddiad danfon: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx dyddiad gorffen: yyMMddHHmm stat:
Gwerthoedd sydd ar gael mewn statws:
- DELIVRD
- TERFYNOL
- GWRTHODWYD
- UNDELIV
- DILEU
6.1 Fformat adroddiad cyflwyno estynedig
Efallai y gofynnir am wybodaeth estynedig mewn adroddiadau dosbarthu mewn cysylltiad â'ch cynrychiolydd gwerthu.
Fformat ar adroddiad cyflwyno: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx is-gyfeiriad:000 dlvrd:000 dyddiad cyflwyno:
yyMMddHHmm dyddiad gorffen: yyMMddHHmm ystadegau: gwall: testun:
Gwerthoedd sydd ar gael mewn statws:
- DELIVRD
- TERFYNOL
- GWRTHODWYD
- UNDELIV
- DILEU
Bydd meysydd “is” a “dlvrd” bob amser yn cael eu gosod i 000, a bydd maes “testun” bob amser yn wag.
Gweler y bennod Codau gwall am werthoedd ar gyfer y maes “cyfeiliorni”.
Fersiynau TLS a gefnogir
Mae angen TLS 1.2 neu TLS 1.3 ar gyfer pob cysylltiad TLS dros SMPP.
Mae cefnogaeth ar gyfer TLS 1.0 ac 1.1 wedi dod i ben ers 2020-11-15. Mae fersiynau 1.0 ac 1.1 o TLS yn brotocolau hŷn sydd wedi'u diystyru ac sy'n cael eu hystyried yn risgiau diogelwch yn y gymuned Rhyngrwyd.
Mae LINK yn argymell yn gryf eich bod yn defnyddio TLS os yw cysylltiadau SMPP heb eu hamgryptio yn cael eu defnyddio heddiw. Mae cysylltiadau SMPP heb eu hamgryptio yn cael eu hanrhydeddu o 2020-09-01 gan LINK, a byddant yn cael eu dileu yn y dyfodol. Nid yw dyddiad ar gyfer dileu cysylltiadau heb ei amgryptio wedi'i benderfynu eto.
Mae cysylltiadau tuag at y gweinydd SMPP ar gyfer TLS ym mhorthladd 3601 yn hytrach na heb eu hamgryptio ym mhorthladd 3600.
Efallai y byddwch yn dal i ddefnyddio TLS hyd yn oed os nad yw eich gweithrediad SMPP yn cefnogi TLS gan ddefnyddio stwnnel, gweler https://www.stunnel.org/
Codau gwall
Mae'n bosibl y bydd y codau gwall canlynol yn cael eu hateb yn y maes gwall os yw'r maes wedi'i alluogi.
| Cod gwall | Disgrifiad |
| 0 | Gwall anhysbys |
| 1 | Gwall llwybro dros dro |
| 2 | Gwall llwybro parhaol |
| 3 | Rhagorwyd ar y sbardun mwyaf |
| 4 | Goramser |
| 5 | Gwall anhysbys gweithredwr |
| 6 | Gwall gweithredwr |
| 100 | Gwasanaeth heb ei ganfod |
| 101 | Defnyddiwr heb ei ganfod |
| 102 | Cyfrif heb ei ganfod |
| 103 | Cyfrinair annilys |
| 104 | Gwall ffurfweddu |
| 105 | Gwall mewnol |
| 106 | Cwota wedi'i ragori |
| 200 | OK |
| 1000 | Anfonwyd |
| 1001 | Wedi'i gyflwyno |
| 1002 | Wedi dod i ben |
| 1003 | Wedi'i ddileu |
| 1004 | Symudol yn llawn |
| 1005 | Ciwio |
| 1006 | Heb ei ddanfon |
| 1007 | Wedi'i gyflwyno, tâl wedi'i ohirio |
| 1008 | Codir tâl, ni anfonwyd y neges |
| 1009 | Codir tâl, ni ddanfonwyd y neges |
| 1010 | Wedi dod i ben, absenoldeb adroddiad cyflawni gweithredwr |
| 1011 | Codir tâl, anfonwyd y neges (at y gweithredwr) |
| 1012 | Wedi ciwio o bell |
| 1013 | Anfonwyd y neges at y gweithredwr, gohiriwyd codi tâl |
| 2000 | Rhif ffynhonnell annilys |
| 2001 | Ni chefnogir rhif byr fel ffynhonnell |
| 2002 | Nid yw Alpha yn cael ei gefnogi fel ffynhonnell |
| 2003 | Ni chefnogir MSISDN fel rhif ffynhonnell |
| 2100 | Ni chefnogir rhif byr fel cyrchfan |
| 2101 | Nid yw Alpha yn cael ei gefnogi fel cyrchfan |
| 2102 | Ni chefnogir MSISDN fel cyrchfan |
| 2103 | Gweithrediad wedi'i rwystro |
| 2104 | Tanysgrifiwr anhysbys |
| 2105 | Cyrchfan wedi'i rwystro |
| 2106 | Gwall rhif |
| 2107 | Cyrchfan wedi'i rwystro dros dro |
| 2108 | Cyrchfan annilys |
| 2200 | Gwall codi tâl |
| 2201 | Mae gan y tanysgrifiwr gydbwysedd isel |
|
2202 |
Tanysgrifiwr wedi'i wahardd am godi gormod (premiwm)
negeseuon |
|
2203 |
Tanysgrifiwr yn rhy ifanc (ar gyfer hyn penodol)
cynnwys) |
| 2204 | Ni chaniateir tanysgrifiwr rhagdaledig |
| 2205 | Gwasanaeth wedi'i wrthod gan y tanysgrifiwr |
| 2206 | Tanysgrifiwr heb ei gofrestru yn y system dalu |
| 2207 | Mae'r tanysgrifiwr wedi cyrraedd y balans uchaf |
| 2208 | Angen cadarnhad defnyddiwr terfynol |
| 2300 | Ad-dalwyd |
|
2301 |
Methu ad-dalu oherwydd anghyfreithlon neu goll
MSISDN |
| 2302 | Methu ad-dalu oherwydd negesId sydd ar goll |
| 2303 | Wedi ciwio am ad-daliad |
| 2304 | Goramser ad-daliad |
| 2305 | Methiant ad-daliad |
| 3000 | Ni chefnogir amgodio GSM |
| 3001 | Ni chefnogir amgodio UCS2 |
| 3002 | Ni chefnogir amgodio deuaidd |
| 4000 | Ni chefnogir yr adroddiad cyflawni |
| 4001 | Cynnwys neges annilys |
| 4002 | Tariff annilys |
| 4003 | Data defnyddiwr annilys |
| 4004 | Pennawd data defnyddiwr annilys |
| 4005 | Cod data annilys |
| 4006 | TAW annilys |
| 4007 | Cynnwys heb ei gefnogi ar gyfer cyrchfan |
Dogfennau / Adnoddau
 |
cyswllt symudedd SMS API, SMPP API MS Scheduler API [pdfCanllaw Defnyddiwr SMS API SMPP API MS Scheduler API, SMS API SMPP API, MS Scheduler API, Scheduler API, API |