LINK Mobiliteitsimplementeringsgids REST API SMS Gebruikersgids

LINK Mobiliteitsimplementeringsgids REST API SMS

LINK Mobility verskaf 'n diens vir boodskapaflewering, mikrobetalings en ligginggebaseerde dienste. Die platform dien as 'n deursigtige, wit-etiket inhoudverkryger en transaksieroeteerder tussen diensverskaffers en operateurs.

LINK Mobility bied 'n RESTful API wat gebruik kan word om toegang te verkry tot LINK Mobility dienste soos die stuur van SMS. Hierdie API is ontwerp om maklik te gebruik en versoenbaar te wees met alle moderne tale en raamwerke. Deur die taal van jou keuse te gebruik, kan jou toepassing die Link Mobility REST API gebruik om kragtige boodskap- en betalingsvermoëns te implementeer

© LINK Mobiliteit, 10 Maart 2021

Regsinligting

Die inligting wat in hierdie dokument verskaf word, is die uitsluitlike eiendom en kopiereg van Netsize. Dit is vertroulik en bedoel vir streng inligtinggebruik. Dit is nie bindend nie en kan onderhewig wees aan veranderinge sonder kennisgewing. Enige ongemagtigde openbaarmaking of gebruik sal as onwettig beskou word.

Netsize™ en linkmobility™ word deur Franse, EEG en internasionale intellektuele eiendomswette beskerm.

Alle ander handelsmerke wat aangehaal word, is die uitsluitlike eiendom van hul onderskeie eienaars.

Niks hierin vervat sal vertolk word as die toekenning van enige lisensie of reg onder Netsize patent, kopiereg of handelsmerk nie.

NETGROOTTE
Société anonyme au capital de 5 478 070 euro
Siège social :62, Avenue Emile Zola92100 Boulogne – Frankryk
418 712 477 RCS Nanterre
http://www.LinkMobility.com
http://www.linkmobility.com

Omvang van dokument

Hierdie dokument beskryf hoe die diensverskaffer die LINK Mobility REST API vir SMS gebruik. Dit is bedoel vir tegniese argitekte en ontwerpers wat die dienste van die diensverskaffer implementeer.

1. Basiese gebruik

Dit is baie maklik om 'n SMS te stuur. Jy stuur 'n HTTP-versoek na LINK Mobility wat bewerkstellig kan word deur slegs 'n web blaaier.

2. Funksionele oorview

Die LINK Mobility-stelsel bied die volgende basiese funksionaliteit vir SMS-boodskappe:
Stuur SMS-boodskappe met mobiele beëindiging (MT), soos teks- of binêre (bv. WAP-stoot) premie- en standaardtariefboodskappe.

Ontvang afleweringsverslae vir ingediende MT-boodskappe.

Ontvangs van Mobile Origined (MO) SMS-boodskappe, premium en standaardtarief.
Die SMS REST API is toegewy aan die stuur van standaardtarief MT SMS-boodskappe.

Die API stuur alle SMS-boodskappe asinchroon, wat kenmerke moontlik maak soos:

“Vuur-en-vergeet” – die Diensverskaffer wil meer voorspelbare reaksietye hê en wil nie wag vir die uitslag van die Operator nie.

Herprobeer funksionaliteit – LINK Mobility sal die boodskap weer stuur as die operateur tydelike probleme het.

2.1 Stuur 'n SMS-boodskap

                                       
Diensverskaffer Netsize Verbruiker

1. Stuur MT boodskap
2. Stuur boodskap-ID terug
3. Dien SMS-boodskap in
4. Lewer afleweringsverslag af
5. Stuur afleweringsverslag

Die basiese vloei vir die stuur van 'n SMS-boodskap word soos volg beskryf:

Die Diensverskaffer rig 'n versoek om 'n SMS-boodskap aan 'n ontvanger te stuur via die LINK Mobiliteitstelsel.

'n Boodskap-ID word aan die diensverskaffer teruggestuur. Hierdie ID kan gebruik word om bv. die boodskap met die korrekte afleweringsverslag te korreleer.

LINK Mobility hanteer roetering en lewer die SMS-boodskap aan die geadresseerde Verbruiker.
'n Afleweringsverslag word geaktiveer, bv. wanneer die SMS-boodskap by die Verbruiker se toestel afgelewer word.

Die afleweringsverslag word aan die Diensverskaffer gestuur. Die verslag bevat dieselfde boodskap-ID as wat in stap 2 teruggestuur is.

Alternatiewe vloei: Ongeldige versoek

As die verskafde parameters of gebruikersbewyse in die versoek ongeldig is, word 'n fout aan die Diensverskaffer teruggestuur. Die fout dui die rede vir die verwerping aan en die vloei eindig. Geen boodskap-ID's word teruggestuur nie.

3. Eindpunt

Die SMS-hulpbron word verkry deur die pad te gebruik:
/restapi/v1/sms
Example URL
https://europe.ipx.com/restapi/v1/sms
Vir verbindingsekuriteit is die LINK Mobility REST API slegs toeganklik oor HTTPS.
Die Link Mobility-bedienersertifikaat word deur Thawte Server CA onderteken.

4. Bedrywighede

Die SMS-diens bied die volgende bewerkings:

Naam	Pad
Stuur	/restapi/v1/sms/stuur

4.1 Stuur

Die stuur-operasie word gebruik om 'n SMS aan 'n enkele ontvanger te stuur.

Hierdie operasie is bedoel vir beide basiese en gevorderde gebruikers. In die eenvoudigste geval word slegs bestemmingsadres en die boodskapteks vereis om 'n SMS af te lewer. LINK Mobility sal die datakoderingskema opspoor en outomatiese samevoeging van 'n boodskap in veelvuldige boodskapdele uitvoer indien nodig.

Vir gevorderde gebruik kan die diensverskaffer opsionele parameters gebruik vir totale beheer van die boodskapformatering, insluitend die gebruikerdatakopskrif.

Die Diensverskaffer kan aaneengeskakelde boodskappe stuur, maar die voorbereiding van die gebruikerdata en gebruikerdatakopskrif moet deur die Diensverskaffer gedoen word en die boodskap moet deur middel van veelvuldige stuurversoeke na LINK Mobility gestuur word.

5. Verifikasie

Gebruikersnaam en wagwoord word in elke versoek ingedien met behulp van HTTP Basiese Authentication Scheme.

https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA

Geloofsbriewe word in 'n magtigingsopskrif in die HTTP-versoek gestuur. Die kliënt konstrueer die kopveld soos hier beskryf:

https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side

Byvoorbeeldample, as die gebruikersnaam john is en changeme die wagwoord is, is die resulterende magtigingsopskrif:

Magtiging: Basiese am9objpjaGFuZ2VtZSA=

As 'n terugval kan die gebruikersnaam en wagwoord as versoekparameters ingedien word. Dit word slegs aanbeveel vir kliënte wat nie Basic Auth ondersteun nie.

6. Die indiening van 'n versoek

6.1 Navraagstring

Versoekparameters word ingedien as 'n navraagstring wat naam/waarde-pare bevat. Die navraagstring is geënkodeer deur gebruik te maak van persentasie-kodering (URL enkodering).

http://www.w3schools.com/tags/ref_urlencode.asp

Byvoorbeeldample, Hallo Wêreld! is geënkodeer as Hello+World%21.

6.2 Verpligte versoek parameters

Naam	Maksimum lengte	Beskrywing
bestemmingsadres	40	Die MSISDN waarna die SMS-boodskap gestuur moet word, begin met landkode. Bvampbel: 46123456789. Vir sommige markte (waar die Verbruikers-MSISDN verduister moet word) kan hierdie waarde ook 'n alfanumeriese alias wees, voorafgegaan met "#".
boodskapTeks	1600	Die inhoud van die SMS-boodskap.

6.3 Opsionele versoekparameters (vir gevorderde gebruik)

Naam	Maksimum lengte	Beskrywing
oorsprongadres	16	Die oorsprongadres vir die uitgaande SMS-boodskap. Tipe oorsprongadres word gedefinieer deur die originatorTON-parameter. Kort getal maksimum lengte is 16. Alfa numeriese sender is beperk tot GSM verstek alfabet met maksimum lengte 11 karakters. MSISDN-sender maksimum lengte is 15 (gebruik dieselfde formaat as die bestemmingsadres-element). Kan weggelaat word wanneer originatingAddress en originatingTON deur die stelsel gekies word. Hierdie funksie is mark- en konfigurasieafhanklik. Gedrag kan verskil met operateur-integrasies.
originatorTON	1	Die oorspronklike adres se tipe nommer (TON): 0 – Kort nommer 1 – Alfa-numeries (maksimum lengte 11) 2 – MSISDN Kan weggelaat word wanneer originatingAddress en originatingTON deur die stelsel gekies sal word. Hierdie funksie is mark- en konfigurasieafhanklik. Gedrag kan verskil met operateur-integrasies.
userDataHeader	280	Gebruikersdatakopskrif saam met die Gebruikerdata kan tot 140, dws 280, wanneer heks-gekodeerde, oktette bevat. Hierdie parameter is altyd heks-geënkodeer.
DKD	3	Data kodering skema. Gedrag kan verskil met operateur-integrasies.
PID	3	Protokol ID. Gedrag kan verskil met operateur-integrasies.
relatiewe Geldigheid Tyd	6	Relatiewe geldigheidstyd in sekondes (relatief tot die tyd vir die indiening by LINK Mobility). Maksimum waarde is 604800 (7 dae) en die verstek is 48 uur. Gedrag kan verskil met operateur-integrasies.
afleweringstyd	20	Tydigsteamp wanneer SMS-boodskap afgelewer moet word (vertraagde afleweringstyd). Sien afdeling oor datum tyd formaat.
statusVerslagVlae	1	Lewer verslagversoek: 0 – Geen afleweringsverslag (verstek) 1 – Afleweringsverslag aangevra 9 – Bedienerafleweringsverslag aangevra (LINK Mobility stuur nie die verslag aan die diensverskaffer aan nie, maar stel dit beskikbaar in verslae ens.)
camprigNaam	50	Die LINK Mobiliteit transaksies is tagged met hierdie naam. Dit word gebruik om transaksies in Link Mobility-verslae te groepeer.
maxConcatenatedMessages	1	'n Waarde tussen 1 en 10 wat definieer hoeveel aaneengeskakelde boodskappe toegelaat word. Verstek is 3.
korrelasieId	100	ID verskaf deur Diensverskaffer wat in Afleweringsverslag weerklink sal word.
gebruikernaam	100	Verskaf as 'n alternatief vir HTTP Basiese Verifikasie.
wagwoord	100	Verskaf as 'n alternatief vir HTTP Basiese Verifikasie.

6.4 HTTP-versoekmetodes

Vir maksimum interoperabiliteit ondersteun die API beide HTTP GET- en POST-versoekmetodes. Geen ander HTTP-metodes word toegelaat nie.

6.4.1 KRY

Die geënkodeerde navraagstring word by die URL.

KRY
https://europe.ipx.com/restapi/v1/sms/send?destinationAddress=461234
56789&messageText=Hallo+Wêreld%21
Magtiging: Basiese am9objpjaGFuZ2VtZSA=

6.4.2 POS

Die geënkodeerde navraagstring word in die HTTP-versoekboodskapliggaam ingedien. Inhoud-tipe is toepassing/x-www-vorm-urlgeënkodeer.

POS https://europe.ipx.com/restapi/v1/sms/send
Gasheer: europe.ipx.com
Inhoudstipe: toepassing / x-www-vorm-urlgeënkodeer
Magtiging: Basiese am9objpjaGFuZ2VtZSA=
Inhoud-lengte: 57

destinationAddress=46123456789&messageText=Hallo+Wêreld%21

6.5 Datum en tyd

Parameters in die REST API wat datum en tyd verteenwoordig, is altyd in UTC-tydsone (gekoördineerde universele tyd). Tydsteamps word voorgestel as 'n string met hierdie presiese formaat:
2017-04-25T23:20:50Z
Dit verteenwoordig 20 minute en 50 sekondes ná die 23ste uur van 25 April 2017 in UTC.

7. Reaksieboodskap

Nadat 'n versoekboodskap ontvang en geïnterpreteer is, reageer die API met 'n HTTP-antwoordboodskap.

7.1 HTTP-statuskode

Die REST API gee altyd HTTP-statuskode 200 OK vir verwerkte versoeke. Die boodskapliggaam bevat 'n parameter responseCode wat gebruik word om die presiese uitkoms te bepaal.

7.2 Boodskapliggaam

Die boodskapliggaam bestaan ​​uit JSON wat die uitkoms van die versoek beskryf.
http://json.org/
Link Mobility JSON voldoen aan die Google JSON Style Guide.
https://google.github.io/styleguide/jsoncstyleguide.xml

7.3 Reaksie parameters

Naam	Maksimum lengte	Beskrywing
reaksiekode	3	0 dui suksesvolle transaksie aan.
reaksie Boodskap	255	Antwoordtekstuele beskrywing, bv. foutteks.
tyeamp	20	Datum en tyd wanneer LINK Mobility die versoek verwerk het. (Verwys na datum/tyd formaat afdeling).
spoorId	36	Skakel Mobiliteit interne identifiseerder. Word gebruik vir ondersteuning en probleemoplossing.
boodskap-ID's	10 x 36	Skikking van LINK Mobility unieke boodskap ID's vir elke suksesvolle boodskap (veelvuldige boodskap ID's word teruggestuur as die boodskap aaneengeskakel is). Weggelaat in geval van mislukking.

7.4 Eksampdie antwoorde

Sukses

HTTP/1.1 200 OK
Inhoudtipe: toepassing/json
Inhoud-lengte: 144
Datum: Do, 15 Sep 2016 13:20:31 GMT
{"responseCode":0,"responseMessage":"Sukses","timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}

Hier is dieselfde JSON geformateer vir leesbaarheid:

{
"reaksiekode":0,
"reaksie Boodskap":"Sukses",
"tyeamp“:”2016-0915T13:20:31Z”,
"spoorId“:”f678d30879fd4adc25f2”,
"boodskap-ID's“:[“1-4850879008”]
}

Mislukking

HTTP/1.1 200 OK
Inhoudtipe: toepassing/json
Inhoud-lengte: 148
Datum: Do, 15 Sep 2016 13:20:31 GMT
{"responseCode":1,"responseMessage":" Ongeldige aanmelding of ongemagtigde API-gebruik","timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}

Sukses

HTTP/1.1 200 OK
Inhoudtipe: toepassing/json
Inhoud-lengte: 144
Datum: Do, 15 Sep 2016 13:20:31 GMT
{"responseCode":0,"responseMessage":"Sukses","timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}

Hier is dieselfde JSON geformateer vir leesbaarheid:

{
"reaksiekode":0,
"reaksie Boodskap":"Sukses",
"tyeamp“:”2016-0915T13:20:31Z”,
"spoorId“:”f678d30879fd4adc25f2”,
"boodskap-ID's“:[“1-4850879008”]
}

Mislukking

HTTP/1.1 200 OK
Inhoudtipe: toepassing/json
Inhoud-lengte: 148
Datum: Do, 15 Sep 2016 13:20:31 GMT
{"responseCode":1,"responseMessage":" Ongeldige aanmelding of ongemagtigde API-gebruik","timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}

7.5 Reaksiekodes

Die volgende antwoordkodes kan in die stuurantwoord teruggestuur word:

Kode	Teks	Beskrywing
0	Sukses	Suksesvol uitgevoer.
1	Ongeldige aanmelding of ongemagtigde API-gebruik	Verkeerde gebruikersnaam of wagwoord of diensverskaffer word deur LINK Mobility verbied.
2	Verbruiker word geblokkeer deur Link Mobility	Die verbruiker word deur LINK Mobility geblokkeer.
3	Bedryf word nie deur LINK Mobility voorsien nie	Die operasie is geblokkeer vir die diensverskaffer.
4	Die verbruiker is onbekend aan LINK Mobility	Die verbruiker is onbekend aan LINK Mobility. Of as alias in die versoek gebruik is; alias nie gevind nie.
5	Verbruiker het hierdie diens in LINK Mobility geblokkeer	Die verbruiker het hierdie diens in LINK Mobility geblokkeer.
6	Die oorspronklike adres word nie ondersteun nie	Die oorspronklike adres word nie ondersteun nie.
7	Alfa-oorsprongadres word nie deur rekening ondersteun nie	Die alfa-oorsprongadres word nie deur rekening ondersteun nie.
8	MSISDN-oorsprongadres word nie ondersteun nie	Die MSISDN-oorsprongadres word nie ondersteun nie.
9	GSM verleng word nie ondersteun nie	GSM verleng word nie ondersteun nie.
10	Unicode word nie ondersteun nie	Unicode word nie ondersteun nie.
11	Statusverslag word nie ondersteun nie	Statusverslag word nie ondersteun nie.
12	Vereiste vermoë word nie ondersteun nie	Die vereiste vermoë (behalwe bogenoemde) om die boodskap te stuur word nie ondersteun nie.
13	Die inhoudverskaffer se maksimum versnellingtempo is oorskry	Die diensverskaffer stuur die SMS-boodskappe te vinnig na LINK Mobility.
14	Protokol-ID word nie deur rekening gesteun nie	Protokol-ID word nie ondersteun nie.
15	Boodskapaaneenskakelingslimiet oorskry	Die aantal aaneengeskakelde boodskappe oorskry die maksimum aantal versoek.
16	Kan nie boodskap stuur nie.	LINK Mobility kon nie die boodskap stuur nie.
17	Verbode tydperk	Word nie toegelaat om boodskappe gedurende tydperk te stuur nie
18	Te lae saldo op diensverskafferrekening	Diensverskaffer is geblokkeer weens te lae balans
50	Gedeeltelike sukses	Gedeeltelike sukses wanneer 'n SMS-boodskap aan verskeie ontvangers gestuur word.
99	Interne bedienerfout	Ander skakelmobiliteit-fout, kontak LINK-mobiliteit-ondersteuning vir meer inligting.
100	Ongeldige bestemmingsadres	Die bestemmingsadres (MSISDN, of alias) is ongeldig.
102	Ongeldige verwysde (gekoppelde) ID	Die verwysings-ID is ongeldig, miskien is die verwysings-ID reeds gebruik, te oud of onbekend.
103	Ongeldige rekeningnaam	Die rekeningnaam is ongeldig.
105	Ongeldige diens-metadata	Die diens-metadata is ongeldig.
106	Ongeldige oorsprongadres	Die oorspronklike adres is ongeldig.
107	Ongeldige alfanumeriese oorsprongadres	Die alfanumeriese oorsprongadres is ongeldig.
108	Ongeldige geldigheidstyd	Die geldigheidstyd is ongeldig.
109	Ongeldige afleweringstyd	Die afleweringstyd is ongeldig.
110	Ongeldige boodskapinhoud/gebruikerdata	Die gebruikerdata, dws die SMS-boodskap, is ongeldig.
111	Ongeldige boodskaplengte	Die lengte van die SMS-boodskap is ongeldig.
112	Ongeldige gebruikerdata-opskrif	Die gebruikerdataopskrif is ongeldig.
113	Ongeldige datakoderingskema	Die DKD is ongeldig.
114	Ongeldige protokol-ID	Die PID is ongeldig.
115	Ongeldige statusverslagvlae	Die statusverslagvlae is ongeldig.
116	Ongeldige TON	Die oorspronklike TON is ongeldig.
117	Ongeldig camprig naam	Die camprigtingnaam is ongeldig.
120	Ongeldige limiet vir maksimum aantal aaneengeskakelde boodskappe	Die maksimum aantal aaneengeskakelde boodskappe is ongeldig.
121	Ongeldige msisdn-oorsprongadres	Die MSISDN-oorsprongadres is ongeldig.
122	Ongeldige korrelasie-ID	Die korrelasie-ID is ongeldig.

8. Opsionele kenmerke

8.1 MSISDN-regstelling

MSISDN-regstelling is 'n opsionele kenmerk wat deur LINK Mobility-ondersteuning geaktiveer kan word indien versoek.

Hierdie kenmerk sal bestemmingsadresse korrigeer en in lyn bring met die vereiste E.164-formaat. Benewens formaatkorreksie kan die stelsel ook markspesifieke funksionaliteit uitvoer, soos die vertaling van internasionale Franse nommers om DOM-TOM (départements et territoires d'outre-mer) nommers te korrigeer waar van toepassing.

Hieronder is 'n aantal examples van regstellings:

Bestemmingsadres ingedien	Gekorrigeerde bestemmingsadres
+46(0)702233445	46702233445
(0046)72233445	46702233445
+460702233445	46702233445
46(0)702233445	46702233445
46070-2233445	46702233445
0046702233445	46702233445
+46(0)702233445aaa	46702233445
336005199999	2626005199999 (Franse nommer vertaal na 'n DOM-TOM-nommer)

Daarbenewens is dit moontlik om nasionale telefoonnommers vir 'n geselekteerde mark toe te laat. Wanneer hierdie kenmerk geaktiveer is, moet enige internasionale nommers vir ander markte gestuur word met 'n aanvanklike `+' teken om hulle van die geselekteerde mark te onderskei.

Hieronder is verskeie examples van regstellings wat gedoen is wanneer Swede (landkode 46) as verstekmark vir nasionale nommers gebruik word.

Bestemmingsadres ingedien	Gekorrigeerde bestemmingsadres
0702233445	46702233445
070-2233 445	46702233445
070.2233.4455	46702233445
460702233445	46702233445
+460702233445	46702233445
+458022334455	458022334455
45802233445	Ongeldig aangesien die '+'-teken ontbreek

Let daarop dat die gekorrigeerde MSISDN deur LINK Mobility gebruik sal word en dit sal in die afleweringsverslae teruggestuur word.

Kontak asseblief LINK Mobiliteit-ondersteuning vir meer inligting.

8.2 Karaktervervanging

Karaktervervanging is 'n opsionele kenmerk wat deur LINK Mobility-ondersteuning geaktiveer kan word indien versoek.

Hierdie kenmerk sal nie-GSM-alfabetkarakters in die gebruikerdata (SMS-teks) vertaal na ekwivalente GSM-alfabetkarakters wanneer die DCS op "GSM" gestel is (17). Byvoorbeeldample “Seqüência de teste em Português” sal vertaal word na “Sequüencia de teste em Portugues”.

9. Afleweringsverslae

Die diensverskaffer kan, indien voorsien, SMS-boodskapafleweringsverslae of afleweringskennisgewings versoek vir die MT-boodskappe wat gestuur word. Hierdie verslae word in die Operator SMSC geaktiveer wanneer die MT-boodskap óf aan die geteikende verbruiker afgelewer word óf uitgevee word, bv. verval of, om een ​​of ander rede, nie herleibaar is nie.

Slegs finale status van die SMS-boodskap word aan die Diensverskaffer gerapporteer, dws afgelewer of uitgevee. Slegs een verslag per MT-boodskap word gegenereer. Met die verwyderde status kan 'n redekode van toepassing wees. Hierdie redekode spesifiseer die rede waarom die SMS-boodskap nie afgelewer is nie.

Die verslae word deur LINK Mobility gestuur en na die diensverskaffer gestuur deur die HTTP-protokol te gebruik.

Om verslae te ontvang, moet die diensverskaffer bvample 'n Java Servlet of 'n ASP.NET-bladsy. Albei ontvang HTTP GET- of POST-versoeke.

Parameters

Die versoek sluit die volgende parameters in:

Parameter	Tik	M/O/I*	Verstekwaarde	Maksimum lengte	Beskrywing
Boodskap-ID	string	M	–	22	Die boodskap-ID van die MT-boodskap waarmee hierdie verslag ooreenstem.
Bestemmingsadres	string	M	–	40	Die Verbruiker se MSISDN, dit wil sê die bestemmingsadres van die oorspronklike MT-boodskap.
Statuskode	heelgetal	M		1	Statuskode dui die status van die MT-boodskap aan. Toepaslike statuskodes is: 0 – Afgelewer 2 – Geskrap (redekode geld)
Tyd St.amp	string	M	–	20	Tyd wat aandui wanneer die afleweringsverslag deur LINK Mobility ontvang is. Die tydsone van die tydsteamp is CET of CEST (met somertyd soos gedefinieer vir die EU). Formaat: jjjjMMdd UU:mm:ss.
Operator	string	M	–	100	Die naam van die operateur wat gebruik word wanneer die SMS-boodskap gestuur word of die rekeningnaam wat gebruik word wanneer die SMS-boodskap gestuur word. 'n Lys van beskikbare operateurs word deur LINK Mobility-ondersteuning verskaf.
Redekode	heelgetal	O	–	3	Redekode dui aan waarom die boodskap in die status uitgevee beland het. Toepaslike redekodes is: 100 – Verval 101 – Verwerp 102 – Formaatfout 103 – Ander fout 110 – Intekenaar onbekend 111 – Intekenaar verbied 112 – Intekenaar nie voorsien nie 113 – Intekenaar nie beskikbaar nie 120 – SMSC mislukking 121 – SMSC-opeenhoping 122 – SMSC-swerwing 130 – Handsetfout 131 – Handstelgeheue oorskry Gedrag kan verskil met operateur-integrasies.
Operator TydStamp	string	O	–	20	Tyd wat aandui wanneer die verslag in die SMSC van die operateur geaktiveer is (indien deur die operateur verskaf). Die tydsone van die tydsteamp is CET of CEST (met somertyd soos gedefinieer vir die EU). Formaat: jjjjMMdd UU:mm:ss.
StatusTeks	string	O	–	255	Plekhouer vir bykomende inligting van die operateur, bv. duidelike teksbeskrywing van die status/rede. Gedrag kan verskil met operateur-integrasies.
Korrelasie-ID	string	O	–	100	Die korrelasie-ID verskaf in die SendRequest of SendTextRequest.
Operator Netwerkkode	heelgetal	O	–	6	Die mobiele netwerkkode (MCC + MNC) van die operateur.

* M = Verpligtend, O = Opsioneel, I = Ignoreer.
Die diensverskaffer moet LINK Mobility met die teiken verskaf URL vir afleweringsverslae (opsioneel insluitend geloofsbriewe vir basiese HTTP-verifikasie). Die diensverskaffer kan kies watter voorkeur-HTTP-metode om te gebruik:
HTTP POST (aanbeveel)
HTTP KRY.

Example gebruik HTTP GET (suksesvol afgelewer):
https://user:password@www.serviceprovider.com/receivereport?%20MessageId=122&DestinationAddress=46762050312&Operator=Vodafone&TimeStamp=20100401%2007%3A47%3A44&StatusCode=0

Example met behulp van HTTP GET (nie afgelewer nie, die operateur het die tydstip verskafamp vir die geleentheid):

https://user:password@www.serviceprovider.com/receivereport?MessageId=123&DestinationAddress=46762050312&Operator=Vodafone&OperatorTimeStamp=20100401%2007%3A47%3A59&TimeStamp=20100401%2007%3A47%3A51&StatusCode=2&StatusText=Delivery%20failed&ReasonCode=10

Die parameters is URL encodedi.

Karakterkodering:
Die diensverskaffer kan kies watter voorkeurkarakterkodering om te gebruik:
UTF-8 (aanbeveel)
ISO-8859-1.

9.1 Diensverskaffer erkenning

Die diensverskaffer moet elke afleweringsverslag erken. Die erkenning kan positief wees, maw afleweringsverslag suksesvol ontvang, of negatief, maw mislukking.

Neem asseblief kennis: LINK Mobility het 'n leestydperk vir erkennings van 30 sekondes vir afleweringsverslae. 'n Uitteltyd sal 'n afleweringsherprobering aktiveer (indien herprobeer geaktiveer) of 'n kansellasie van die aflewering (indien herprobeer gedeaktiveer). Dit beteken dat die Diensverskaffer-toepassing vinnige reaksietye moet verseker, veral tydens hoë vrag.

Dit word sterk aanbeveel om die afleweringsverslag teenoor LINK Mobility te erken voordat dit verwerk word.

Die reël vir positiewe en negatiewe erkenning word soos volg beskryf:

Positiewe erkenning, ACK, afleweringsverslag afgelewer:
HTTP 200-reeks reaksiekode in kombinasie met die volgende XML-geformateerde inhoud:

Negatiewe erkenning, NAK, afleweringsverslag nie afgelewer nie:
Enige ander antwoord as positiewe erkenning, bvample, 'n negatiewe erkenning word veroorsaak deur enige HTTP-foutkode of die volgende XML-inhoud:

Die XML-inhoud kan gebruik word om die LINK Mobility-herprobeermeganisme te beheer. 'n NAK sal herprobeerpoging veroorsaak, indien geaktiveer. Vir diensverskaffers wat nie vir die herprobeermeganisme opgestel is nie, is die XML-inhoud opsioneel.

Hieronder is 'n HTTP POST-versoek en -antwoord, bvample van 'n afleweringsverslag wat aan 'n diensverskaffer afgelewer is:

HTTP-versoek:

POST /konteks/toepassing HTTP/1.1
Inhoudstipe: toepassing / x-www-vorm-urlgeëncoded;charset=utf-8
Gasheer: bediener:poort
Inhoud-lengte: xx

MessageId=213123213&DestinationAddress=46762050312&Operator=Telia& OperatorTimeStamp=20130607%2010%3A45%3A00&TimeStamp=20130607%2010%3A 45%3A02&StatusCode=0

HTTP-reaksie:

HTTP/1.1 200 OK
Inhoud-tipe: teks/gewoon

9.2 Probeer weer

Die LINK Mobility-stelsel kan herprobeerpogings uitvoer vir mislukte, dws nie-erkende, afleweringsverslagaflewerings. Die diensverskaffer kan die voorkeur herprobeergedrag kies:

Geen herprobeer nie (verstek) – die boodskap sal weggegooi word as verbindingspoging misluk, lees-time-out of vir enige HTTP-foutkode.

Probeer weer – die boodskap sal weer gestuur word vir elke tipe verbindingsprobleem, lees-time-out of negatiewe erkenning.

Wanneer herprobeer vir NAK geaktiveer is, is dit belangrik om te verstaan ​​watter scenario's wat 'n herprobeerpoging vanaf LINK Mobility sal genereer en hoe die herprobeer werk. Elke diensverskaffer het sy eie herprobeer-waglys, waar boodskappe volgens die boodskaptyd gerangskik wordamp. Link Mobility probeer altyd ouer boodskappe eerste aflewer, al is die individuele volgorde van boodskappe wat aan die Diensverskaffer afgelewer word nie gewaarborg nie. Die hoofrede waarom boodskappe uit die herprobeer-tou weggegooi word, is een van twee redes: óf die boodskap TTL verval óf (teoreties) word die herprobeer-tou vol. Die TTL is operateur en rekening afhanklik, dit wil sê, kan wissel na gelang van operateur en/of boodskap tipe, bv. premium SMS of standaard tarief SMS boodskap.

A Diensverskaffers met herprobeer geaktiveer moet die unieke ID van die MT-boodskap nagaan om te verseker dat die boodskap nie reeds ontvang is nie.

Dit is belangrik vir die Diensverskaffer om aan hierdie eenvoudige reëls te voldoen wanneer 'n fout tydens die verwerking van 'n afleweringsverslag voorkom indien die rede vir die fout is: Tydelik, bv. databasis nie beskikbaar nie, 'n NAK moet teruggestuur word. LINK Mobility sal die boodskap weer stuur.

Permanente en 'n herprobeerpoging sal waarskynlik dieselfde soort probleem veroorsaak, 'n ACK moet teruggestuur word. Byvoorbeeldample, wanneer die boodskap nie korrek ontleed kon word nie of 'n onverwagte looptydfout veroorsaak het.

Deur dienooreenkomstig op te tree sal verseker dat geen blokkering of deurvloeidegradasie veroorsaak word as gevolg van 'n afleweringsverslag wat herhaaldelik versend word nie.

10. Implementeringswenke

1. Dit is moontlik om jou web blaaier om versoeke by die API in te dien. Dit maak dit baie maklik om die dienste te verken en te evalueer sonder enige ontwikkelingsinstrumente.

2. Chrome of Firefox word saam met 'n uitbreiding soos JSON aanbeveelView om mooi-geformateerde JSON te vertoon.

3. Ons het SoapUI gebruik vir die toets van POST, basiese verifikasie en om die rou HTTP-versoek- en reaksieboodskappe te inspekteer.

https://www.soapui.org/

4. Die cURL instrument is nuttig vir die indien van POST-versoeke met basiese verifikasie. Sien bvample hieronder.

https://curl.haxx.se/

curl PLAAS \
-H “Inhoud-tipe: application/x-www-form-urlgeënkodeer” \
-H “Magtiging: Basiese am9objpjaGFuZ2VtZSA=” \
https://europe.ipx.com/restapi/v1/sms/send \
–data “destinationAddress=46123456789&messageText=Hallo+Wêreld%21”

_______________

Transformasie van persoonlike kommunikasie