LINK Mugikortasuna Ezartzeko Gida REST API SMS
LINK Mobility-k mezuak bidaltzeko, mikro ordainketak eta kokapenean oinarritutako zerbitzuak eskaintzen ditu. Plataformak etiketa zuriko edukien eskuratzaile eta transakzio bideratzaile gisa jokatzen du Zerbitzu Hornitzaileen eta Operadoreen artean.
LINK Mobility-k RESTful API bat eskaintzen du, LINK Mobility zerbitzuetara sartzeko, hala nola SMSak bidaltzeko. API hau erabiltzeko erraza eta hizkuntza moderno eta esparru guztiekin bateragarria izateko diseinatuta dago. Aukeratutako hizkuntza erabiliz, zure aplikazioak Link Mobility REST APIa erabil dezake mezularitza eta ordainketa gaitasun indartsuak ezartzeko.
© LINK Mobility, 10eko martxoaren 2021a
Informazio juridikoa
Dokumentu honetan emandako informazioa Netsize-ren jabetza eta copyright bakarra da. Isilpekoa da eta informazio zorrozki erabilerarako pentsatuta dago. Ez da loteslea eta baliteke aldaketak egon daitezkeela jakinarazi gabe. Baimenik gabeko zabalkunde edo erabilera oro legez kanpokotzat joko da.
Netsize™ eta linkmobility™ Frantziako, EEEko eta nazioarteko jabetza intelektualeko legeek babestuta daude.
Aipatutako gainerako marka guztiak dagozkien jabeen jabetzakoak dira.
Hemen jasotako ezer ez da Netsize patentearen, copyrightaren edo marka komertzialen lizentzia edo eskubiderik ematen duenik ulertuko.
NETSIZE
Société anonyme au capital de 5 478 070 euro
Siège social :62, Emile Zola etorbidea92100 Boulogne – Frantzia
418 712 477 RCS Nanterre
http://www.LinkMobility.com
http://www.linkmobility.com
Dokumentuaren esparrua
Dokumentu honek zerbitzu-hornitzaileak LINK Mobility REST APIa SMSetarako nola erabiltzen duen deskribatzen du. Zerbitzu Hornitzailearen zerbitzuak ezartzen dituzten arkitekto eta diseinatzaile teknikoei zuzenduta dago.
1. Oinarrizko Erabilera
Oso erraza da SMS bat bidaltzea. HTTP eskaera bat bidaltzen diozu LINK Mobility-ra, eta hori a erabiliz bete daiteke web arakatzailea.
2. Funtzionala Overview
LINK Mobility sistemak oinarrizko funtzionalitate hauek eskaintzen ditu SMS mezuetarako:
Mugikorretik amaitutako (MT) SMS mezuak bidaltzea, hala nola testu edo bitar (adibidez, WAP Push) premium eta tarifa estandarreko mezuak.
Bidalitako MT mezuen entrega-txostenak jasotzea.
Mugikorretarako Jatorrizko SMS mezuak (MO) jasotzea, tarifa premium eta estandarra.
SMS REST APIa tasa estandarra MT SMS mezuak bidaltzera zuzenduta dago.
APIak SMS mezu guztiak modu asinkronoan bidaltzen ditu, besteak beste, funtzioak gaituz:
"Sua eta ahaztu" - Zerbitzu-hornitzaileak erantzun denbora aurreikusgarriagoak izan nahi ditu eta ez du Operadorearen emaitzaren zain egon nahi.
Saiatu berriro funtzionalitatea - LINK Mobility-k mezua berriro bidaliko du Operatzaileak aldi baterako arazoak baditu.
2.1 SMS mezu bat bidaltzea
Zerbitzu-hornitzailea Netsize Consumer
- Bidali MT mezua
- Itzuli mezuaren IDa
- Bidali SMS mezua
- Bidalketa txostena entregatu
- Bidali entrega-txostena
SMS mezuak bidaltzeko oinarrizko fluxua honela deskribatzen da:
Zerbitzu-hornitzaileak hartzaile bati SMS mezu bat bidaltzeko eskaera egiten du LINK Mobility sistemaren bidez.
Mezuaren ID bat itzultzen zaio Zerbitzu-hornitzaileari. ID hori erabil daiteke, adibidez, mezua entrega-txosten zuzenarekin lotzeko.
LINK Mobility-k bideratzea kudeatzen du eta helbideratutako Kontsumitzaileari SMS mezua bidaltzen dio.
Bidalketa-txosten bat abiarazten da, adibidez, SMS mezua Kontsumitzailearen gailura bidaltzen denean.
Bidalketa-txostena Zerbitzu Hornitzaileari bidaltzen zaio. Txostenak 2. urratsean itzuli den mezu ID bera dauka.
Fluxu alternatiboa: eskaera baliogabea
Eskaeran emandako parametroak edo erabiltzailearen kredentzialak baliogabeak badira, errore bat itzultzen zaio Zerbitzu-hornitzaileari. Erroreak errefusaren arrazoia adierazten du eta fluxua amaitzen da. Ez da mezuen IDrik itzultzen.
3. Amaiera
SMS baliabidera bide hau erabiliz atzitzen da:
/restapi/v1/sms
Example URL
https://europe.ipx.com/restapi/v1/sms
Konexioaren segurtasunerako LINK Mobility REST APIa HTTPS bidez soilik dago eskuragarri.
Link Mobility zerbitzariaren ziurtagiria Thawte Server CAk sinatzen du.
4. Eragiketak
SMS zerbitzuak honako eragiketa hauek eskaintzen ditu:
| Izena | Bidea |
| Bidali | /restapi/v1/sms/send |
4.1 Bidali
Bidalketa eragiketa hartzaile bakar bati SMS bat bidaltzeko erabiltzen da.
Eragiketa hau oinarrizko erabiltzaileei zein aurreratuei zuzenduta dago. Kasurik errazenean, helmuga helbidea eta mezuaren testua soilik beharrezkoak dira SMS bat bidaltzeko. LINK Mobility-k datuen kodetze-eskema detektatuko du eta mezu baten kateaketa automatikoa egingo du, behar izanez gero, hainbat mezu zatitan.
Erabilera aurreratuetarako, zerbitzu-hornitzaileak aukerako parametroak erabil ditzake mezuen formatua erabat kontrolatzeko erabiltzailearen datuen goiburua barne.
Zerbitzu-hornitzaileak kateatutako mezuak bidal ditzake, baina erabiltzailearen datuen eta erabiltzailearen datuen goiburuaren prestaketa Zerbitzu-hornitzaileak egin behar du eta mezua LINK Mobility-ra bidalketa-eskaera anitzen bidez bidali behar du.
5. Autentifikazioa
Erabiltzaile-izena eta pasahitza eskaera guztietan HTTP oinarrizko autentifikazio-eskema erabiliz bidaltzen dira.
https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA
Kredentzialak HTTP eskaerako Baimen goiburu batean bidaltzen dira. Bezeroak goiburuko eremua eraikitzen du hemen deskribatzen den moduan:
https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side
Adibidezample, erabiltzaile-izena john bada eta changeme pasahitza bada, ondoriozko Baimenaren goiburua hau da:
Baimena: Oinarrizko am9objpjaGFuZ2VtZSA=
Erabiltzaile-izena eta pasahitza eskaera-parametro gisa bidal daitezke. Hau oinarrizko autentifikazioa onartzen ez duten bezeroentzat bakarrik gomendatzen da.
6. Eskaera aurkeztea
6.1 Kontsulta-katea
Eskaeraren parametroak izen/balio bikoteak dituen kontsulta-kate gisa bidaltzen dira. Kontsulta-katea ehuneko kodeketa erabiliz kodetzen da (URL kodeketa).
http://www.w3schools.com/tags/ref_urlencode.asp
Adibidezample, Kaixo Mundua! Hello+World%21 gisa kodetuta dago.
6.2 Nahitaezko eskaera-parametroak
| Izena | Gehienezko luzera | Deskribapena |
| helmuga helbidea | 40 | SMS mezua bidali behar zaion MSISDN-a, herrialde-kodetik hasita. Adibamptelefonoa: 46123456789. Zenbait merkatutan (non Consumer MSISDN lausotu behar den) balio hau alias alfanumeriko bat ere izan daiteke, "#"ren aurrizkia. |
| mezuaren testua | 1600 | SMS mezuen edukia. |
6.3 Aukerako eskaera-parametroak (erabilera aurreratuetarako)
| Izena | Gehienezko luzera | Deskribapena |
| jatorrizko helbidea | 16 | Irteerako SMS mezuaren jatorrizko helbidea. Jatorrizko helbide mota originatorTON parametroak definitzen du. Zenbaki laburren gehienezko luzera 16 da. Alfa-zenbakizko bidaltzailea GSM alfabeto lehenetsira mugatuta dago, gehienez 11 karaktere dituena. MSISDN igorlearen gehienezko luzera 15 da (destinationAddress elementuaren formatu bera erabiliz). JatorrizkoHelbidea eta jatorrizkoToN sistemak hautatzen dituenean ezaba daiteke. Funtzio hau merkatuaren eta konfigurazioaren araberakoa da. Portaera alda daiteke operadorearen integrazioekin. |
| sortzaileaTON | 1 | Jatorrizko helbidearen zenbaki mota (TON): 0 – Zenbaki laburra 1 - Zenbaki alfa (gehienezko luzera 11) 2 – MSISDN JatorrizkoHelbidea eta jatorriaTON sistemak hautatuko dituenean utz daiteke. Funtzio hau merkatuaren eta konfigurazioaren araberakoa da. Portaera alda daiteke operadorearen integrazioekin. |
| userDataHeader | 280 | Erabiltzaile-datuen goiburuak Erabiltzaile-datuekin batera 140 zortzikote izan ditzake, hau da, 280 hex-kodetuta daudenean. Parametro hau hex-kodetuta dago beti. |
| DCS | 3 | Datuak kodetzeko eskema. Portaera alda daiteke operadorearen integrazioekin. |
| PID | 3 | Protokoloaren IDa. Portaera alda daiteke operadorearen integrazioekin. |
| Baliozkotasun Relatiboa Denbora | 6 | Baliotasun-denbora erlatiboa segundotan (LINK Mobility-ra bidaltzeko denboraren aldean). Gehienezko balioa 604800 da (7 egun) eta lehenetsia 48 ordu. Portaera alda daiteke operadorearen integrazioekin. |
| entrega denbora | 20 | Denboralenaamp SMS mezua noiz entregatu behar den (atzeratutako entrega-denbora). Ikusi data-ordu formatuaren atala. |
| egoeraReportFlags | 1 | Txosten eskaera entregatu: 0 - Ez dago entrega-txostenik (lehenetsia) 1 – Eskatutako entrega-txostena 9 - Zerbitzariaren entrega-txostena eskatu da (LINK Mobility-k ez dio txostena zerbitzu-hornitzaileari bidaltzen, baina eskuragarri jartzen du txostenetan etab.) |
| campaignName | 50 | LINK Mobility transakzioak dira tagizen honekin ged. Link Mobility txostenetan transakzioak biltzeko erabiltzen da. |
| maxConcatenatedMessages | 1 | 1 eta 10 arteko balio bat, zenbat mezu kateatu onartzen diren definitzen duena. Lehenetsia 3 da. |
| korrelazioId | 100 | Zerbitzu-hornitzaileak emandako IDa, entrega-txostenean oihartzuna izango dena. |
| erabiltzaile-izena | 100 | HTTP oinarrizko autentifikazioaren alternatiba gisa eskaintzen da. |
| pasahitza | 100 | HTTP oinarrizko autentifikazioaren alternatiba gisa eskaintzen da. |
6.4 HTTP eskaera-metodoak
Elkarreragingarritasun handiena lortzeko, APIak HTTP GET eta POST eskaera metodoak onartzen ditu. Ez da onartzen beste HTTP metodorik.
6.4.1 LORTU
Kodetutako kontsulta-katea eransten zaio URL.
LORTU
https://europe.ipx.com/restapi/v1/sms/send?destinationAddress=461234
56789&messageText=Kaixo+Mundua%21
Baimena: Oinarrizko am9objpjaGFuZ2VtZSA=
6.4.2 POST
Kodetutako kontsulta-katea HTTP eskaera-mezuaren gorputzean bidaltzen da. Eduki-mota aplikazioa/x-www-form- daurlkodetuta.
POST https://europe.ipx.com/restapi/v1/sms/send
Ostalaria: europe.ipx.com
Eduki mota: application / x-www-form-urlkodetuta
Baimena: Oinarrizko am9objpjaGFuZ2VtZSA=
Edukia-luzera: 57
destinationAddress=46123456789&messageText=Kaixo+World%21
6.5 Data eta ordua
Data eta ordua adierazten duten REST APIko parametroak UTC ordu-eremuan daude beti (Coordinated Universal Time). Aldizamps kate gisa adierazten dira formatu zehatz honekin:
2017-04-25T23:20:50Z
Honek 20ko apirilaren 50eko 23. ordutik 25 minutu eta 2017 segundora adierazten du UTC-n.
7. Erantzun mezua
Eskaera-mezu bat jaso eta interpretatu ondoren APIak HTTP erantzun-mezu batekin erantzuten du.
7.1 HTTP egoera kodea
REST APIak HTTP egoera kodea 200 OK itzultzen du beti prozesatutako eskaeretarako. Mezuaren gorputzak emaitza zehatza zehazteko erabiltzen den erantzunCode parametro bat dauka.
7.2 Mezuaren gorputza
Mezuaren gorputza eskaeraren emaitza deskribatzen duen JSONz osatuta dago.
http://json.org/
Link Mobility JSON-k Google JSON estilo-gidarekin bat egiten du.
https://google.github.io/styleguide/jsoncstyleguide.xml
7.3 Erantzun-parametroak
| Izena | Gehienezko luzera | Deskribapena |
| erantzunKodea | 3 | 0-k transakzio arrakastatsua adierazten du. |
| erantzunMezua | 255 | Erantzunaren testu-deskribapena, adibidez, errore-testua. |
| aldizamp | 20 | LINK Mobility-k eskaera prozesatu zuen eguna eta ordua. (Ikusi data/orduaren formatua atala). |
| traceId | 36 | Link Mugikortasunaren barne-identifikatzailea. Laguntzarako eta arazoak konpontzeko erabiltzen da. |
| mezu IDak | 10 x 36 | LINK Mobility mezuen ID esklusiboen sorta mezu arrakastatsu bakoitzeko (mezuen ID anitz itzultzen dira mezua kateatzen bada). Porrotaren kasuan baztertua. |
7.4 Adibample erantzunak
Arrakasta
HTTP/1.1 200 Ados
Eduki-mota: aplikazioa/json
Edukia-luzera: 144
Data: 15ko irailaren 2016a, 13:20:31 GMT
{“responseCode”:0,”responseMessage”:”Arrakasta”,”timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Hona hemen irakurgarritasunerako formateatutako JSON bera:
{
“erantzunKodea":0,
“erantzunMezua":"Arrakasta",
“aldizamp“:”2016-0915T13:20:31Z”,
“traceId“:”f678d30879fd4adc25f2”,
“mezu IDak“:[“1-4850879008”] }
Porrota
HTTP/1.1 200 Ados
Eduki-mota: aplikazioa/json
Edukia-luzera: 148
Data: 15ko irailaren 2016a, 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” Saioa hasteko baliogabea edo baimenik gabeko APIaren erabilera”,”timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
Arrakasta
HTTP/1.1 200 Ados
Eduki-mota: aplikazioa/json
Edukia-luzera: 144
Data: 15ko irailaren 2016a, 13:20:31 GMT
{“responseCode”:0,”responseMessage”:”Arrakasta”,”timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Hona hemen irakurgarritasunerako formateatutako JSON bera:
{
“erantzunKodea":0,
“erantzunMezua":"Arrakasta",
“aldizamp“:”2016-0915T13:20:31Z”,
“traceId“:”f678d30879fd4adc25f2”,
“mezu IDak“:[“1-4850879008”] }
Porrota
HTTP/1.1 200 Ados
Eduki-mota: aplikazioa/json
Edukia-luzera: 148
Data: 15ko irailaren 2016a, 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” Saioa hasteko baliogabea edo baimenik gabeko APIaren erabilera”,”timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
7.5 Erantzun kodeak
Bidalitako erantzunean honako erantzun-kode hauek itzul daitezke:
| Kodea | Testua | Deskribapena |
| 0 | Arrakasta | Arrakastaz exekutatu da. |
| 1 | Saio-hasiera baliogabea edo baimenik gabeko APIaren erabilera | Erabiltzaile-izen edo pasahitz okerrak edo zerbitzu-hornitzaileak galarazi ditu LINK Mobility-k. |
| 2 | Link Mobility-k kontsumitzailea blokeatzen du | Kontsumitzailea blokeatzen du LINK Mobility-k. |
| 3 | LINK Mobility-k ez du funtzionamendua hornitzen | Eragiketa blokeatuta dago Zerbitzu-hornitzailearentzat. |
| 4 | Kontsumitzailea ezezaguna da LINK Mobility-rentzat | Kontsumitzailea ezezaguna da LINK Mobility-k. Edo eskaeran alias erabili bazen; ezizena ez da aurkitu. |
| 5 | Consumer-ek zerbitzu hau blokeatu du LINK Mobility-n | Kontsumitzaileak zerbitzu hau blokeatu du LINK Mobility-n. |
| 6 | Jatorrizko helbidea ez da onartzen | Jatorrizko helbidea ez da onartzen. |
| 7 | Kontuak ez du onartzen Alpha jatorriko helbidea | Alfa jatorriko helbidea ez du onartzen kontuak. |
| 8 | MSISDN jatorriko helbidea ez da onartzen | MSISDN jatorriko helbidea ez da onartzen. |
| 9 | GSM hedatua ez da onartzen | GSM hedatua ez da onartzen. |
| 10 | Unicode ez da onartzen | Unicode ez da onartzen. |
| 11 | Ez da onartzen egoera-txostena | Ez da onartzen egoera-txostena. |
| 12 | Beharrezko gaitasuna ez da onartzen | Mezua bidaltzeko beharrezkoa den gaitasuna (aurrekoa ez dena) ez da onartzen. |
| 13 | Eduki-hornitzailearen gehienezko muga-tasa gainditu da | Zerbitzu-hornitzailea azkarregi bidaltzen ari da SMS mezuak LINK Mobility-ra. |
| 14 | Kontuak ez du onartzen protokoloaren IDa | Ez da onartzen protokoloaren IDa. |
| 15 | Mezuak kateatzeko muga gainditu da | Kateatuta dauden mezuen kopuruak eskatutako gehienezko kopurua gainditzen du. |
| 16 | Ezin da mezua bideratu. | LINK Mobility-k ezin izan du mezua bideratu. |
| 17 | Debekatutako denbora-epea | Ezin da mezurik bidaltzeko denbora tartean |
| 18 | Saldo baxuegia zerbitzu-hornitzailearen kontuan | Zerbitzu-hornitzailea blokeatuta dago Balantze baxuegia dela eta |
| 50 | Arrakasta partziala | Arrakasta partziala SMS mezu bat hainbat hartzaileri bidaltzean. |
| 99 | Barne zerbitzariaren errorea | Link Mobility beste errore bat, jarri harremanetan LINK Mobility laguntzarekin informazio gehiago lortzeko. |
| 100 | Helmuga helbidea baliogabea | Helmuga helbidea (MSISDN edo ezizena) baliogabea da. |
| 102 | Erreferentziazko (lotutako) ID baliogabea | Erreferentzia IDa baliogabea da, agian erreferentzia IDa dagoeneko erabiltzen da, zaharregia edo ezezaguna. |
| 103 | Kontuaren izen baliogabea | Kontuaren izenak ez du balio. |
| 105 | Zerbitzu metadatuak baliogabeak | Zerbitzuaren metadatuak baliogabeak dira. |
| 106 | Jatorrizko helbidea baliogabea | Jatorrizko helbidea ez da baliozkoa. |
| 107 | Jatorrizko helbide alfanumeriko baliogabea | Jatorrizko helbidea alfanumerikoa ez da baliozkoa. |
| 108 | Baliozko denbora baliogabea | Baliozko denbora baliogabea da. |
| 109 | Bidalketa denbora baliogabea | Entregatzeko epea baliogabea da. |
| 110 | Mezuaren edukia/erabiltzailearen datu baliogabeak | Erabiltzailearen datuak, hau da, SMS mezua, baliogabeak dira. |
| 111 | Mezuaren luzera baliogabea | SMS mezuaren luzera ez da baliozkoa. |
| 112 | Erabiltzaile-datuen goiburua baliogabea | Erabiltzailearen datuen goiburua baliogabea da. |
| 113 | Datuak kodetzeko eskema baliogabea | DCS baliogabea da. |
| 114 | Protokolo ID baliogabea | PID baliogabea da. |
| 115 | Egoera-txostenen bandera baliogabeak | Egoera-txostenen banderak baliogabeak dira. |
| 116 | TON baliogabea | TON sortzailea baliogabea da. |
| 117 | Baliogabea campaign izena | campaign izena baliogabea da. |
| 120 | Gehienezko mezu kateatuentzako muga baliogabea | Gehienezko mezu kateatuen kopurua baliogabea da. |
| 121 | Msisdn jatorriko helbide baliogabea | MSISDN jatorriko helbidea ez da baliozkoa. |
| 122 | Korrelazio ID baliogabea | Korrelazio IDa baliogabea da. |
8. Aukerako ezaugarriak
8.1 MSISDN zuzenketa
MSISDN zuzenketa aukerako eginbide bat da, eta eskatuz gero LINK Mobility laguntzak gaitu dezake.
Eginbide honek helmuga helbideak zuzenduko ditu eta beharrezko E.164 formatura lerrokatuko ditu. Formatua zuzentzeaz gain, sistemak merkatuko funtzionalitate espezifikoak ere egin ditzake, hala nola, nazioarteko frantses zenbakiak itzultzea DOM-TOM (departements et territoires d'outre-mer) zenbakiak zuzentzeko, hala badagokio.
Jarraian adibide batzuk daudeampzuzenketak:
| Bidalitako Helmuga Helbidea | Helmuga helbidea zuzendua |
| +46(0)702233445 | 46702233445 |
| (0046)72233445 | 46702233445 |
| +460702233445 | 46702233445 |
| 46(0)702233445 | 46702233445 |
| 46070-2233445 | 46702233445 |
| 0046702233445 | 46702233445 |
| +46(0)702233445aaa | 46702233445 |
| 336005199999 | 2626005199999 (Frantziar zenbakia DOM-TOM zenbaki batera itzulita) |
Gainera, aukeratutako merkatu baterako telefono-zenbaki nazionalak baimendu daitezke. Ezaugarri hau gaituta dagoenean, beste merkatu batzuetarako nazioarteko edozein zenbaki hasierako `+' zeinu batekin bidali behar da hautatutako merkatutik bereizteko.
Jarraian hainbat adibideampSuedia (46 herrialde-kodea) zenbaki nazionalen merkatu lehenetsi gisa erabiltzean egindako zuzenketen fitxategiak.
| Bidalitako Helmuga Helbidea | Helmuga helbidea zuzendua |
| 0702233445 | 46702233445 |
| 070-2233 445 | 46702233445 |
| 070.2233.4455 | 46702233445 |
| 460702233445 | 46702233445 |
| +460702233445 | 46702233445 |
| +458022334455 | 458022334455 |
| 45802233445 | Baliogabea '+' ikurra falta baita |
Kontuan izan MSISDN zuzendua LINK Mobility-k erabiliko duela eta entrega-txostenetan itzuliko dela.
Mesedez, jarri harremanetan LINK Mobility laguntzarekin informazio gehiago lortzeko.
8.2 Karaktereen ordezkapena
Karaktereak ordezkatzea aukerako eginbide bat da, eta eskatuz gero LINK Mobility laguntzak gaitu dezake.
Eginbide honek GSM ez diren alfabetoko karaktereak erabiltzailearen datuetan (SMS testua) GSM alfabetoko karaktere baliokideetara itzuliko ditu DCS "GSM" moduan ezartzen denean (17). Adibidezample “Seqüência de teste em Português” itzuliko da “Seqüencia de teste em Portugues”.
9. Entrega-txostenak
Zerbitzu-hornitzaileak, hornituta badago, bidalitako MT mezuetarako SMS mezuak bidaltzeko txostenak edo bidalketa jakinarazpenak eska ditzake. Txosten hauek SMSC operadorean abiarazten dira MT mezua helburuko Kontsumitzaileari bidaltzen zaionean edo ezabatzen denean, adibidez, iraungi edo, arrazoiren batengatik, bideragarria ez denean.
SMS mezuaren azken egoera soilik jakinaraziko zaio Zerbitzu Hornitzaileari, hau da, entregatu edo ezabatu. MT mezu bakoitzeko txosten bakarra sortzen da. Ezabatutako egoerarekin, baliteke arrazoi-kode bat aplikatzea. Arrazoi-kode honek SMS mezua ez bidaltzearen arrazoia zehazten du.
Txostenak LINK Mobility bidez bideratzen dira eta Zerbitzu Hornitzaileari bidaltzen zaizkio HTTP protokoloa erabiliz.
Txostenak jasotzeko, Zerbitzu Hornitzaileak inplementatu behar du adibidezample Java Servlet edo ASP.NET orri bat. Biek HTTP GET edo POST eskaerak jasotzen dituzte.
Parametroak
Eskaerak parametro hauek ditu:
| Parametroa | Mota | M/O/I* | Balio lehenetsia | Gehienezko luzera | Deskribapena |
| Mezu Id | katea | M | – | 22 | Txosten honi dagokion MT mezuaren mezu IDa. |
| Helmuga helbidea | katea | M | – | 40 | Kontsumitzailearen MSISDN, hau da, jatorrizko MT mezuaren helmuga helbidea. |
| EgoeraKodea | osokoa | M | 1 | Egoera-kodeak MT mezuaren egoera adierazten du. Egoera-kode aplikagarriak hauek dira: 0 – Entregatua 2 - Ezabatu egin da (arrazoi kodea aplikatzen da) |
|
| Denbora St.amp | katea | M | – | 20 | LINK Mobility-k entrega-txostena noiz jaso duen adierazten duen ordua. Ordu-eremuaamp CET edo CEST da (EBrako zehaztutako udako orduarekin). Formatua: yyyyMMdd HH:mm:ss. |
| Eragilea | katea | M | – | 100 | SMS mezua bidaltzean erabilitako Operadorearen izena edo SMS mezua bidaltzean erabilitako kontuaren izena. Eskuragarri dauden Operadoreen zerrenda LINK Mobility laguntzak eskaintzen du. |
| ArrazoiKodea | osokoa | O | – | 3 | Arrazoi-kodeak adierazten du zergatik amaitu den mezua ezabatu egoeran. Arrazoi-kode aplikagarriak hauek dira: 100 – Iraungita 101 – Baztertua 102 – Formatu-errorea 103 – Beste akats bat 110 – Harpidedun ezezaguna 111 – Harpideduna debekatuta 112 – Harpideduna ez dago hornituta 113 - Harpideduna ez dago erabilgarri 120 - SMSC hutsegitea 121 – SMSC pilaketak 122 – SMSC ibiltaritza 130 – Telefonoaren errorea 131 – Telefonoaren memoria gainditu da Portaera alda daiteke operadorearen integrazioekin. |
| OperatorTimeStamp | katea | O | – | 20 | Operadorearen SMSCn txostena noiz abiarazi den adierazten duen denbora (Operadoreak ematen badu). Ordu-eremuaamp CET edo CEST da (EBrako zehaztutako udako orduarekin). Formatua: yyyyMMdd HH:mm:ss. |
| Egoera Testua | katea | O | – | 255 | Eragilearen informazio gehigarrirako leku-marka, adibidez, egoera/arrazoiaren testu argiaren deskribapena. Portaera alda daiteke operadorearen integrazioekin. |
| KorrelazioId | katea | O | – | 100 | SendRequest edo SendTextRequest-en emandako korrelazio IDa. |
| OperatorNetworkCode | osokoa | O | – | 6 | Operadorearen Sare Mugikorreko Kodea (MCC + MNC). |
* M = Nahitaezkoa, O = Aukerakoa, I = Ez ikusia.
Zerbitzu-hornitzaileak LINK Mobility eskaini behar du xedearekin URL entrega-txostenetarako (aukeran HTTP oinarrizko autentifikaziorako kredentzialak barne). Zerbitzu-hornitzaileak aukeratu dezake zein HTTP metodo erabili nahi duen:
HTTP POST (gomendatua)
HTTP GET.
ExampHTTP GET erabiliz fitxategia (bihurtu da):
https://user:password@www.serviceprovider.com/receivereport?%20MessageId=122&DestinationAddress=46762050312&Operator=Vodafone&TimeStamp=20100401%2007%3A47%3A44&StatusCode=0
Exampfitxategia HTTP GET erabiliz (ez da entregatu, Operadoreak denbora gehien eman duamp ekitaldirako):
Parametroak dira URL kodedi.
Karaktereen kodeketa:
Zerbitzu-hornitzaileak aukeratu dezake zein karaktere-kodeketa erabili nahi duen:
UTF-8 (gomendatua)
ISO-8859-1.
9.1 Zerbitzu-hornitzailearen aitorpena
Zerbitzu-hornitzaileak entrega-txosten bakoitza aitortu beharko du. Aitorpena positiboa izan daiteke, hau da, bidalketa-txostena arrakastaz jasota, edo negatiboa, hau da, huts egitea.
Kontuan izan: LINK Mobility-k irakurtzeko denbora-muga du 30 segundoko aitorpenetarako entrega-txostenetarako. Denbora-muga batek bidalketa berriro saiakera bat (berriro saiakera gaituta badago) edo entrega bertan behera utziko du (berriro saiakera desgaituta badago). Horrek esan nahi du Zerbitzu Hornitzaileen aplikazioak erantzun-denbora azkarrak bermatu behar dituela, batez ere karga handian.
Oso gomendagarria da LINK Mobility-ri entrega-txostena aitortzea prozesatu aurretik.
Onarpen positiboaren eta negatiboaren araua honela deskribatzen da:
Aitorpen positiboa, ACK, entrega-txostena:
HTTP 200 barrutiaren erantzun-kodea XML formatuko eduki honekin batera:
Aitorpen negatiboa, NAK, entrega-txostena ez da entregatu:
Onarpen positiboa ez den edozein erantzun, adibidezample, aitorpen negatiboa abiarazten da edozein HTTP errore-kode edo XML eduki honek:
XML edukia LINK Mobility berriro saiatzeko mekanismoa kontrolatzeko erabil daiteke. NAK batek berriro saiakera bat eragingo du, gaituta badago. Berriro saiatu mekanismorako konfiguratuta ez dauden zerbitzu-hornitzaileentzat, XML edukia hautazkoa da.
Jarraian, HTTP POST eskaera eta erantzun bat dago, adibidezampZerbitzu-hornitzaile bati bidalitako entrega-txostenaren fitxategia:
HTTP eskaera:
POST /context/app HTTP/1.1
Eduki mota: application / x-www-form-urlkodetuta;charset=utf-8
Ostalaria: zerbitzaria:portua
Edukia-Luzera: xx
MessageId=213123213&DestinationAddress=46762050312&Operator=Telia& OperatorTimeStamp=20130607%2010%3A45%3A00&TimeStamp=20130607%2010%3A 45%3A02&StatusCode=0
HTTP Erantzuna:
HTTP/1.1 200 Ados
Eduki-mota: testua/soila
9.2 Berriro saiatu
LINK Mobility sistemak berriro saiakerak egin ditzake bidalketa-txostenen bidalketetan huts egin duten, hau da, aitortu gabe. Zerbitzu-hornitzaileak hobetsitako birsaiatzeko portaera aukeratu dezake:
Ez da berriro saiatu (lehenetsia) - mezua baztertu egingo da konexio-saiakerak huts egiten badu, irakurtzeko denbora-muga edo HTTP errore-koderen bat izanez gero.
Saiatu berriro – mezua berriro bidaliko da konexio-arazo mota guztietarako, irakurtzeko denbora-muga edo aitorpen negatiborako.
NAKrako berriro saiakera gaituta dagoenean, garrantzitsua da LINK Mobility-tik berriro saiakera bat sortuko duten zein eszenatoki eta nola funtzionatzen duen ulertzea. Zerbitzu-hornitzaile bakoitzak bere saiakera-ilara du, non mezuak mezuen denboraren arabera ordenatzen direnamp. Link Mobility beti saiatzen da mezu zaharragoak bidaltzen lehenik, zerbitzu-hornitzaileari bidalitako mezuen banakako ordena bermatuta ez dagoen arren. Berriro saiakera-ilaratik mezuak baztertzeko arrazoi nagusia bi arrazoi hauetako bat da: TTL mezua iraungitzen da edo (teorian) berriro saiakera-ilara bete egiten da. TTL operadorearen eta kontuaren menpekoa da, hau da, operadorearen edo mezu motaren arabera alda daiteke, adibidez, premium SMS edo tarifa estandarreko SMS mezua.
Berriro saiakera gaituta duten zerbitzu-hornitzaileek MT mezuaren ID bakarra egiaztatu behar dute mezua dagoeneko jaso ez dela ziurtatzeko.
Garrantzitsua da Zerbitzu-hornitzaileak arau sinple hauek betetzea entrega-txostena prozesatzen denean erroreren bat gertatzen denean errorearen arrazoia bada: Aldi baterako, adibidez, datu-basea ez dago eskuragarri, NAK bat itzuli behar da. LINK Mobility-k mezua berriro bidaliko du.
Iraunkorrak eta berriro saiakerak arazo mota bera sor dezakete, ACK bat itzuli beharko litzateke. Adibidezample, mezua behar bezala analizatu ezin denean edo ustekabeko exekuzio-errore bat eragin duenean.
Horren arabera jokatuz gero, ez da blokeorik edo abiadura-hondatzerik sortuko entrega-txosten bat behin eta berriz bidaltzen delako.
10. Ezartzeko aholkuak
1. Zurea erabiltzea posible da web arakatzailea APIra eskaerak bidaltzeko. Horrek oso erraza da zerbitzuak arakatzea eta ebaluatzea inolako garapen-tresnarik gabe.
2. Chrome edo Firefox JSON bezalako luzapen batekin batera gomendatzen diraView nahiko formateatutako JSON bistaratzeko.
3. SoapUI erabili dugu POST, oinarrizko autentifikazioa probatzeko eta HTTP eskaera eta erantzun mezu gordinak ikuskatzeko.
4. cURL tresna erabilgarria da Oinarrizko Autentifikazioarekin POST eskaerak bidaltzeko. Ikus example behean.
curl POST \
-H "Eduki-mota: aplikazioa/x-www-inprimakia-urlkodetuta” \
-H "Baimena: oinarrizko am9objpjaGFuZ2VtZSA=" \
https://europe.ipx.com/restapi/v1/sms/send \
–datuak “destinationAddress=46123456789&messageText=Kaixo+Mundua%21”
_______________
Komunikazio pertsonalizatuak eraldatzea
Dokumentuak / Baliabideak
 |
LINK Mugikortasuna Ezartzeko Gida REST API SMS [pdfErabiltzailearen gida Mugikortasuna Ezartzeko Gida REST API SMS, Mugikortasuna, Inplementazio Gida REST API SMS, REST API SMS, API SMS, SMS |
