LINK Giya sa Pagpatuman sa Mobility REST API SMS
Ang LINK Mobility naghatag og serbisyo alang sa paghatud sa mensahe, micro nga pagbayad, ug mga serbisyo nga nakabase sa lokasyon. Ang plataporma naglihok isip usa ka transparent, white-label content acquirer ug transaction router tali sa mga Service Provider ug Operators.
Ang LINK Mobility naghatag ug RESTful API nga magamit sa pag-access sa mga serbisyo sa LINK Mobility sama sa pagpadala og SMS. Kini nga API gidesinyo nga sayon gamiton ug nahiuyon sa tanang modernong pinulongan ug mga gambalay. Gamit ang lengguwahe nga imong gipili ang imong aplikasyon makagamit sa Link Mobility REST API aron mapatuman ang kusgan nga mga kapabilidad sa pagmemensahe ug pagbayad
© LINK Mobility, Marso 10, 2021
Legal nga Impormasyon
Ang kasayuran nga gihatag sa kini nga dokumento mao ang bugtong kabtangan ug copyright sa Netsize. Kompidensyal kini ug gituyo alang sa estrikto nga paggamit sa impormasyon. Dili kini mapuslan ug mahimong mapailalom sa mga pagbag-o nga wala’y pahibalo. Ang bisan unsang dili awtorisado nga pagbutyag o paggamit maisip nga supak sa balaod.
Ang Netsize™ ug linkmobility™ gipanalipdan sa French, EEC ug internasyonal nga mga balaod sa intelektwal nga kabtangan.
Ang tanan nga ubang mga marka sa pamatigayon nga gikutlo mao ang bugtong kabtangan sa ilang tagsa-tagsa nga mga tag-iya.
Walay bisan unsa nga nasulod dinhi ang pagasabton nga naghatag ug bisan unsang lisensya o katungod ubos sa Netsize patent, copyright, o trademark.
NETSIZE
Société anonyme au kapital sa 5 478 070 euros
Siège sosyal :62, avenue Emile Zola92100 Boulogne – France
418 712 477 RCS Nanterre
http://www.LinkMobility.com
http://www.linkmobility.com
Kasangkaran sa Dokumento
Kini nga dokumento naghulagway kung giunsa paggamit sa Service Provider ang LINK Mobility REST API para sa SMS. Gituyo kini alang sa mga teknikal nga arkitekto ug tigdesinyo nga nagpatuman sa mga serbisyo sa Service Provider.
1. Batakang Paggamit
Sayon ra kaayo ang pagpadala og SMS. Nagpadala ka ug HTTP nga hangyo sa LINK Mobility nga mahimo gamit ang usa lang web browser.
2. Functional Overview
Ang sistema sa LINK Mobility naghatag sa mosunod nga batakang kagamitan alang sa mga mensahe sa SMS:
Pagpadala sa Mobile Terminated (MT) SMS nga mga mensahe, sama sa text o binary (eg WAP Push) premium ug standard rate nga mga mensahe.
Pagdawat sa mga taho sa pagpadala alang sa gisumite nga mga mensahe sa MT.
Pagdawat sa Mobile Originated (MO) SMS nga mga mensahe, premium ug standard rate.
Ang SMS REST API gipahinungod sa pagpadala sa standard rate MT SMS nga mga mensahe.
Ang API nagpadala sa tanang mga mensahe sa SMS nga asynchronous, nga makapahimo sa mga feature sama sa:
"Fire-and-forget" - ang Service Provider gusto nga adunay mas matag-an nga mga oras sa pagtubag ug dili gusto nga maghulat sa resulta gikan sa Operator.
Sulayi pag-usab ang pag-andar - Ang LINK Mobility ipadala pag-usab ang mensahe kung ang Operator adunay temporaryo nga mga problema.
2.1 Pagpadala ug SMS nga mensahe
Tighatag sa Serbisyo nga Netsize Consumer
- Ipadala ang mensahe sa MT
- Ibalik ang message ID
- Isumite ang mensahe sa SMS
- Ihatag ang report sa pagpadala
- Ipadala ang report sa pagpadala
Ang sukaranan nga dagan sa pagpadala sa mga mensahe sa SMS gihulagway ingon sa mosunod:
Naghangyo ang Service Provider nga magpadala usa ka mensahe sa SMS sa usa ka nakadawat pinaagi sa LINK Mobility system.
Usa ka ID sa mensahe ang gibalik sa Service Provider. Kini nga ID mahimong gamiton alang sa pananglitan sa pag-correlate sa mensahe sa husto nga report sa paghatud.
Ang LINK Mobility nagdumala sa pagruta ug naghatud sa mensahe sa SMS ngadto sa gitumong nga Konsyumer.
Ang usa ka report sa pagpadala ma-trigger, pananglitan kung ang mensahe sa SMS ipadala sa aparato sa Consumer.
Ang report sa pagpadala ipadala ngadto sa Service Provider. Ang report adunay parehas nga ID sa mensahe nga gibalik sa lakang 2.
Alternatibong dagan: Dili balido nga hangyo
Kung ang gihatag nga mga parameter o mga kredensyal sa gumagamit sa hangyo dili balido usa ka sayup ang ibalik sa Service Provider. Ang sayup nagpakita sa hinungdan sa pagsalikway ug ang pag-agos natapos. Walay message ID nga gibalik.
3. Katapusan nga punto
Ang kapanguhaan sa SMS ma-access gamit ang dalan:
/restapi/v1/sms
Example URL
https://europe.ipx.com/restapi/v1/sms
Alang sa seguridad sa koneksyon ang LINK Mobility REST API ma-access lamang sa HTTPS.
Ang Link Mobility server certificate gipirmahan sa Thawte Server CA.
4. Mga operasyon
Ang serbisyo sa SMS naghatag sa mosunod nga mga operasyon:
| Ngalan | Dalan |
| Ipadala | /restapi/v1/sms/send |
4.1 Ipadala
Ang operasyon sa pagpadala gigamit aron magpadala usa ka SMS sa usa ka nakadawat.
Kini nga operasyon gituyo alang sa sukaranan ug advanced nga mga tiggamit. Sa pinakasimple nga kaso, ang adres lamang sa destinasyon, ug ang text sa mensahe ang gikinahanglan aron makahatud og SMS. Ang LINK Mobility makamatikod sa Data Coding Scheme ug maghimo ug awtomatik nga pagdugtong sa usa ka mensahe ngadto sa daghang mga bahin sa mensahe kon gikinahanglan.
Para sa abante nga paggamit, ang Service Provider makagamit ug opsyonal nga mga parametro para sa kinatibuk-ang pagkontrolar sa pag-format sa mensahe lakip na ang user data header.
Ang Service Provider makapadala ug concatenated nga mga mensahe, apan ang pag-andam sa user data ug user data header kinahanglan nga himoon sa Service Provider ug ang mensahe kinahanglang ipadala pinaagi sa multiple send requests ngadto sa LINK Mobility.
5. Pagpamatuod
Ang username ug password gisumite sa matag hangyo gamit ang HTTP Basic Authentication Scheme.
https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA
Ang mga kredensyal gipadala sa usa ka ulohan sa Awtorisasyon sa hangyo sa HTTP. Ang kliyente nagtukod sa header field sama sa gihulagway dinhi:
https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side
Kay example, kung ang username kay john ug changeme ang password unya ang resulta nga Authorization header mao ang:
Awtorisasyon: Basic am9objpjaGFuZ2VtZSA=
Isip usa ka fall-back ang username ug password mahimong isumite isip mga parameter sa hangyo. Kini girekomenda lamang alang sa mga kliyente nga wala mosuporta sa Basic Auth.
6. Pagsumite sa usa ka hangyo
6.1 Pangutana nga string
Ang mga parameter sa hangyo gisumite ingon usa ka string sa pangutana nga adunay mga pares nga ngalan/bili. Ang string sa pangutana gi-encode gamit ang Percent Encoding (URL pag-encode).
http://www.w3schools.com/tags/ref_urlencode.asp
Kay example, Hello Kalibutan! gi-encode ingon Hello+World%21.
6.2 Mandatory nga mga parametro sa hangyo
| Ngalan | Max nga gitas-on | Deskripsyon |
| destinasyonAddress | 40 | Ang MSISDN diin ang mensahe sa SMS kinahanglan ipadala, sugod sa code sa nasud. Exampug: 46123456789. Alang sa pipila ka mga merkado (diin ang Consumer MSISDN kinahanglan nga ma-obfuscate) kini nga kantidad mahimo usab nga usa ka alphanumeric alias, nga adunay prefix nga "#". |
| mensaheText | 1600 | Ang sulod sa mensahe sa SMS. |
6.3 Opsyonal nga mga parametro sa hangyo (para sa abante nga paggamit)
| Ngalan | Max nga gitas-on | Deskripsyon |
| gigikanan ngaAddress | 16 | Ang gigikanan nga adres alang sa mogawas nga mensahe sa SMS. Ang tipo sa gigikanan nga adres gihubit sa parameter nga originatorTON. Mubo nga numero max nga gitas-on mao ang 16. Ang alpha numeric sender limitado sa GSM default nga Alphabet nga adunay max nga gitas-on nga 11 ka karakter. Ang max nga gitas-on sa nagpadala sa MSISDN mao ang 15 (gamit ang parehas nga format sa elemento sa destinationAddress). Mahimong tangtangon kung ang originatingAddress ug originatingTON gipili sa sistema. Kini nga function nagsalig sa merkado ug configuration. Mahimong magkalainlain ang pamatasan sa mga integrasyon sa Operator. |
| tagmugnaTON | 1 | Ang gigikanan nga adres' tipo sa numero (TON): 0 – Mubo nga numero 1 – Alpha numeric (maximum nga gitas-on 11) 2 – MSISDN Mahimong tangtangon kung ang originatingAddress ug originatingTON ang pilion sa sistema. Kini nga function nagsalig sa merkado ug configuration. Mahimong magkalainlain ang pamatasan sa mga integrasyon sa Operator. |
| userDataHeader | 280 | Ang Ulohan sa Data sa Gumagamit kauban ang Data sa Gumagamit mahimong adunay hangtod sa 140, ie 280 kung gi-encode ang hex, mga octet. Kini nga parameter kanunay nga hex-encoded. |
| DCS | 3 | Data coding scheme. Mahimong magkalainlain ang pamatasan sa mga integrasyon sa Operator. |
| PID | 3 | Protocol ID. Mahimong magkalainlain ang pamatasan sa mga integrasyon sa Operator. |
| relativeValidityTime | 6 | Relatibo nga oras sa balido sa mga segundo (relasyon sa oras sa pagsumite sa LINK Mobility). Ang labing taas nga kantidad mao ang 604800 (7 ka adlaw) ug ang default mao ang 48 ka oras. Mahimong magkalainlain ang pamatasan sa mga integrasyon sa Operator. |
| oras sa pagpadala | 20 | Takdang panahonamp kung ang mensahe sa SMS kinahanglan ipadala (nalangan ang oras sa pagpadala). Tan-awa ang seksyon sa format sa oras sa petsa. |
| statusReportFlags | 1 | Ihatag ang hangyo sa report: 0 - Walay report sa pagpadala (default) 1 - Gihangyo ang report sa pagpadala 9 – Gihangyo ang report sa paghatod sa server (LINK Mobility dili ipadala ang report ngadto sa Service Provider apan gihimo kini nga anaa sa mga report ug uban pa) |
| campaignName | 50 | Ang mga transaksyon sa LINK Mobility mao ang tagged uban niini nga ngalan. Gigamit kini sa paggrupo sa mga transaksyon sa mga taho sa Link Mobility. |
| maxConcatenatedMessages | 1 | Usa ka bili tali sa 1 ug 10 nga naghubit kung pila ang gidugtong nga mga mensahe nga gitugotan. Default kay 3. |
| correlationId | 100 | ID nga gihatag sa Service Provider nga ipalanog sa Delivery Report. |
| username | 100 | Gihatag isip alternatibo sa HTTP Basic Authentication. |
| password | 100 | Gihatag isip alternatibo sa HTTP Basic Authentication. |
6.4 Mga Pamaagi sa Paghangyo sa HTTP
Para sa maximum interoperability, ang API nagsuporta sa HTTP GET ug POST nga mga pamaagi sa paghangyo. Walay laing HTTP nga pamaagi ang gitugot.
6.4.1 GET
Ang gi-encode nga string sa pangutana gidugang sa URL.
GET
https://europe.ipx.com/restapi/v1/sms/send?destinationAddress=461234
56789&messageText=Kumusta+Kalibutan%21
Awtorisasyon: Basic am9objpjaGFuZ2VtZSA=
6.4.2 POST
Ang gi-encode nga string sa pangutana gisumite sa HTTP request message body. Ang Type-Content mao ang aplikasyon/x-www-form-urlgi-encode.
POST https://europe.ipx.com/restapi/v1/sms/send
Host: europe.ipx.com
Type-sa Sulud: aplikasyon / x-www-form-urlgi-encode
Awtorisasyon: Basic am9objpjaGFuZ2VtZSA=
Sulod-Gitas-on: 57
destinationAddress=46123456789&messageText=Hello+World%21
6.5 Petsa ug oras
Ang mga parametro sa REST API nga nagrepresentar sa petsa ug oras anaa kanunay sa UTC time zone (Coordinated Universal Time). Orasamps girepresentar isip usa ka hilo nga adunay eksaktong format:
2017-04-25T23:20:50Z
Kini nagrepresentar sa 20 ka minuto ug 50 ka segundo pagkahuman sa ika-23 nga oras sa Abril 25, 2017 sa UTC.
7. Mensahe sa pagtubag
Human makadawat ug paghubad sa usa ka mensahe sa hangyo ang API motubag sa usa ka mensahe sa tubag sa HTTP.
7.1 HTTP status code
Ang REST API kanunay nga nagbalik sa HTTP status code 200 OK alang sa giproseso nga mga hangyo. Ang lawas sa mensahe adunay usa ka parameter responseCode nga gigamit aron mahibal-an ang eksakto nga sangputanan.
7.2 Lawas sa mensahe
Ang lawas sa mensahe naglangkob sa JSON nga naghulagway sa sangputanan sa hangyo.
http://json.org/
Ang Link Mobility JSON nagsunod sa Google JSON Style Guide.
https://google.github.io/styleguide/jsoncstyleguide.xml
7.3 Mga parametro sa pagtubag
| Ngalan | Max nga gitas-on | Deskripsyon |
| tubagCode | 3 | 0 nagpakita sa malampuson nga transaksyon. |
| tubagMensahe | 255 | Deskripsyon sa teksto sa tubag, pananglitan sa sayup nga teksto. |
| panahonamp | 20 | Petsa ug oras kanus-a giproseso sa LINK Mobility ang hangyo. (Tan-awa ang seksyon sa pormat sa petsa/oras). |
| traceId | 36 | Link Mobility internal identifier. Gigamit alang sa suporta ug pag-troubleshoot. |
| messageIds | 10 x 36 | Array sa LINK Mobility talagsaon nga mga ID sa mensahe alang sa matag malampuson nga mensahe (daghang mga ID sa mensahe ang ibalik kung ang mensahe gidugtong). Gilaktawan sa kaso sa kapakyasan. |
7.4 Exampmga tubag
Kalampusan
HTTP/1.1 200 OK
Type-Content: aplikasyon/json
Sulod-Gitas-on: 144
Petsa: Huwebes, 15 Sep 2016 13:20:31 GMT
{“responseCode”:0,”responseMessage”:”Success”,”timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Ania ang parehas nga JSON nga gi-format aron mabasa:
{
“tubagCode“:0,
“tubagMensahe":"Kalamposan",
“panahonamp“:”2016-0915T13:20:31Z”,
“traceId“:”f678d30879fd4adc25f2”,
“messageIds“:[“1-4850879008”] }
Kapakyasan
HTTP/1.1 200 OK
Type-Content: aplikasyon/json
Sulod-Gitas-on: 148
Petsa: Huwebes, 15 Sep 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” Invalid login or un-authorized API usage”,”timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
Kalampusan
HTTP/1.1 200 OK
Type-Content: aplikasyon/json
Sulod-Gitas-on: 144
Petsa: Huwebes, 15 Sep 2016 13:20:31 GMT
{“responseCode”:0,”responseMessage”:”Success”,”timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Ania ang parehas nga JSON nga gi-format aron mabasa:
{
“tubagCode“:0,
“tubagMensahe":"Kalamposan",
“panahonamp“:”2016-0915T13:20:31Z”,
“traceId“:”f678d30879fd4adc25f2”,
“messageIds“:[“1-4850879008”] }
Kapakyasan
HTTP/1.1 200 OK
Type-Content: aplikasyon/json
Sulod-Gitas-on: 148
Petsa: Huwebes, 15 Sep 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” Invalid login or un-authorized API usage”,”timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
7.5 Mga kodigo sa pagtubag
Ang mosunod nga mga kodigo sa tubag mahimong ibalik sa tubag sa pagpadala:
| Kodigo | Text | Deskripsyon |
| 0 | Kalampusan | Malampuson nga gipatuman. |
| 1 | Dili balido nga pag-login o dili awtorisado nga paggamit sa API | Ang sayop nga username o password o Service Provider gidid-an sa LINK Mobility. |
| 2 | Ang konsumedor gibabagan sa Link Mobility | Ang Consumer gibabagan sa LINK Mobility. |
| 3 | Ang operasyon wala gihatag sa LINK Mobility | Ang operasyon gibabagan para sa Service Provider. |
| 4 | Ang konsumidor wala mailhi sa LINK Mobility | Ang Consumer wala mailhi sa LINK Mobility. O kung gigamit ang alyas sa hangyo; wala makit-an ang alyas. |
| 5 | Gibabagan sa konsumidor kini nga serbisyo sa LINK Mobility | Gibabagan sa Consumer kini nga serbisyo sa LINK Mobility. |
| 6 | Ang gigikanan nga adres wala gisuportahan | Ang gigikanan nga adres wala gisuportahan. |
| 7 | Ang gigikanan sa alpha nga adres wala gisuportahan sa account | Ang alpha nga gigikanan nga adres wala gisuportahan sa account. |
| 8 | Dili suportado ang gigikanang adres sa MSISDN | Dili suportado ang gigikanang adres sa MSISDN. |
| 9 | GSM extended dili suportado | GSM extended dili suportado. |
| 10 | Unicode dili suportado | Unicode dili suportado. |
| 11 | Ang taho sa kahimtang wala gisuportahan | Ang taho sa kahimtang wala gisuportahan. |
| 12 | Ang gikinahanglan nga kapabilidad wala gisuportahan | Ang gikinahanglan nga kapabilidad (gawas sa nahisgutan) para sa pagpadala sa mensahe wala gisuportahan. |
| 13 | Ang max throttling rate sa taghatag sa sulud milabaw | Ang Service Provider nagpadala sa mga mensahe sa SMS ngadto sa LINK Mobility nga paspas kaayo. |
| 14 | Ang Protocol ID wala gisuportahan sa account | Ang Protocol ID wala gisuportahan. |
| 15 | Milapas na sa limitasyon sa paghugpong sa mensahe | Ang gidaghanon sa gidugtong nga mga mensahe milapas sa max nga gidaghanon nga gipangayo. |
| 16 | Dili ma-ruta ang mensahe. | Ang LINK Mobility wala makahimo sa pagruta sa mensahe. |
| 17 | Gidili nga yugto sa panahon | Dili tugotan nga magpadala og mensahe sa panahon |
| 18 | Ubos kaayo nga balanse sa account sa service provider | Ang service provider gibabagan tungod sa Sobra low balance |
| 50 | Partial nga kalampusan | Partial nga kalampusan kung magpadala usa ka mensahe sa SMS sa daghang mga nakadawat. |
| 99 | Sayop sa internal nga server | Ubang Link Mobility error, kontaka ang LINK Mobility nga suporta para sa dugang impormasyon. |
| 100 | Dili balido nga adres sa destinasyon | Ang destinasyon nga adres (MSISDN, o alyas) dili balido. |
| 102 | Dili balido nga reference (nalambigit) ID | Ang reference ID dili balido, tingali ang reference ID gigamit na, tigulang na kaayo o wala mailhi. |
| 103 | Dili balido nga ngalan sa account | Ang ngalan sa account dili balido. |
| 105 | Dili balido nga meta data sa serbisyo | Ang meta data sa serbisyo dili balido. |
| 106 | Dili balido nga gigikanan nga adres | Ang gigikanan nga adres dili balido. |
| 107 | Dili balido nga gigikanan nga adres sa alphanumeric | Ang alphanumeric nga gigikanan nga adres dili balido. |
| 108 | Dili balido nga panahon | Ang balido nga oras dili balido. |
| 109 | Dili balido nga oras sa pagpadala | Ang oras sa pagpadala dili balido. |
| 110 | Dili balido nga sulud sa mensahe/data sa tiggamit | Ang data sa tiggamit, ie ang mensahe sa SMS, dili balido. |
| 111 | Dili balido ang gitas-on sa mensahe | Dili balido ang gitas-on sa mensahe sa SMS. |
| 112 | Dili balido nga header sa datos sa tiggamit | Ang header sa data sa tiggamit dili balido. |
| 113 | Dili balido nga data coding scheme | Ang DCS dili balido. |
| 114 | Dili balido nga protocol ID | Ang PID dili balido. |
| 115 | Dili balido nga mga bandera sa report sa status | Ang mga bandera sa status report dili balido. |
| 116 | Dili balido nga TON | Ang nagmugna nga TON dili balido. |
| 117 | Dili balido campaign ngalan | Ang campAng ngalan sa aign dili balido. |
| 120 | Dili balido nga limitasyon alang sa labing taas nga gidaghanon sa gidugtong nga mga mensahe | Dili balido ang kinatas-an nga gidaghanon sa mga gidugtong nga mensahe. |
| 121 | Dili balido nga gigikanan nga adres sa msisdn | Dili balido ang gigikanang adres sa MSISDN. |
| 122 | Dili balido nga correlation ID | Ang correlation ID dili balido. |
8. Opsyonal nga mga bahin
8.1 MSISDN Pagtul-id
Ang pagtul-id sa MSISDN usa ka opsyonal nga bahin nga mahimo pinaagi sa suporta sa LINK Mobility kung gihangyo.
Kini nga bahin magtul-id sa mga adres sa destinasyon ug ipahiangay kini sa gikinahanglan nga E.164 format. Dugang sa pagkorihir sa pormat ang sistema mahimo usab nga mopahigayon sa espesipikong merkado sama sa paghubad sa internasyonal nga Pranses nga mga numero aron matul-id ang DOM-TOM (départements et territoires d'outre-mer) nga mga numero kung magamit.
Sa ubos mao ang usa ka gidaghanon sa mga exampmga pagkorihir:
| Gisumite nga Destinasyon nga Address | Gitul-id nga Address sa Destinasyon |
| +46(0)702233445 | 46702233445 |
| (0046)72233445 | 46702233445 |
| +460702233445 | 46702233445 |
| 46(0)702233445 | 46702233445 |
| 46070-2233445 | 46702233445 |
| 0046702233445 | 46702233445 |
| +46(0)702233445aaa | 46702233445 |
| 336005199999 | 2626005199999 (French nga numero gihubad ngadto sa DOM-TOM nga numero) |
Dugang pa, posible nga tugutan ang nasyonal nga mga numero sa telepono alang sa usa ka pinili nga merkado. Sa diha nga kini nga bahin mahimo nga bisan unsa nga internasyonal nga mga numero alang sa ubang mga merkado kinahanglan nga ipadala uban sa usa ka inisyal nga `+' ilhanan aron sa pag-ila kanila gikan sa pinili nga merkado.
Sa ubos adunay daghang mga exampmga pagkorihir nga gihimo sa paggamit sa Sweden (country code 46) isip default nga merkado alang sa nasudnong mga numero.
| Gisumite nga Destinasyon nga Address | Gitul-id nga Address sa Destinasyon |
| 0702233445 | 46702233445 |
| 070-2233 445 | 46702233445 |
| 070.2233.4455 | 46702233445 |
| 460702233445 | 46702233445 |
| +460702233445 | 46702233445 |
| +458022334455 | 458022334455 |
| 45802233445 | Dili balido tungod kay nawala ang timaan nga '+' |
Timan-i nga ang gitul-id nga MSISDN gamiton sa LINK Mobility ug kini ibalik sa mga report sa paghatud.
Palihug kontaka ang LINK Mobility nga suporta alang sa dugang nga impormasyon.
8.2 Pagpuli sa Karakter
Ang pagpuli sa karakter usa ka opsyonal nga bahin nga mahimo pinaagi sa suporta sa LINK Mobility kung gihangyo.
Kini nga feature maghubad sa dili-GSM alphabet nga mga karakter sa user data (SMS text) ngadto sa katumbas nga GSM alphabet characters kon ang DCS itakda sa “GSM” (17). Kay example “Seqüência de teste em Português” hubaron sa “Seqüencia de teste em Portugues”.
9. Mga report sa paghatud
Ang Service Provider mahimo, kon mahatag, makapangayo ug SMS message delivery reports o delivery notifications para sa MT messages nga gipadala. Kini nga mga taho ma-trigger sa Operator SMSC kung ang MT nga mensahe ihatud sa gipunting nga Konsyumer o gitangtang, pananglitan, na-expire o, sa usa ka hinungdan, dili ma-ruta.
Katapusan ra nga kahimtang sa mensahe sa SMS ang gitaho sa Service Provider, ie, gihatud o gitangtang. Usa ra ka taho matag mensahe sa MT ang nahimo. Uban sa natangtang nga status, ang usa ka rason nga code mahimong magamit. Kini nga rason nga code nagtino sa rason sa SMS nga mensahe nga wala ipadala.
Ang mga taho gipaagi sa LINK Mobility ug gipadala sa Service Provider gamit ang HTTP protocol.
Aron makadawat og mga taho, ang Service Provider kinahanglan nga ipatuman alang sa exampusa ka Java Servlet o usa ka panid sa ASP.NET. Ang duha nakadawat HTTP GET o POST hangyo.
Parameter
Ang hangyo naglakip sa mosunod nga mga parameter:
| Parameter | Type | M/O/I* | Default nga Bili | Max nga gitas-on | Deskripsyon |
| MessageId | hilo | M | – | 22 | Ang message ID sa mensahe sa MT nga katugbang niini nga taho. |
| DestinasyonAddress | hilo | M | – | 40 | Ang MSISDN sa Konsyumer, ie ang destinasyon nga adres sa orihinal nga mensahe sa MT. |
| StatusCode | integer | M | 1 | Ang status code nagpakita sa status sa MT nga mensahe. Ang mga magamit nga status code mao ang: 0 - Gihatud 2 – Gitangtang (rason code magamit) |
|
| Ang TimeStamp | hilo | M | – | 20 | Ang oras nga nagpakita kung kanus-a ang report sa pagpadala nadawat sa LINK Mobility. Ang time zone sa orasamp mao ang CET o CEST (nga adunay panahon sa ting-init nga gihubit alang sa EU). Format: yyyyMMdd HH:mm:ss. |
| Operator | hilo | M | – | 100 | Ang ngalan sa Operator nga gigamit sa pagpadala sa mensahe sa SMS o ang ngalan sa account nga gigamit sa pagpadala sa mensahe sa SMS. Usa ka lista sa magamit nga mga Operator gihatag sa suporta sa LINK Mobility. |
| RasonCode | integer | O | – | 3 | Ang rason code nagpakita ngano nga ang mensahe natapos sa status nga natangtang. Ang magamit nga mga kodigo sa rason mao ang: 100 - Na-expire 101 – Gisalikway 102 – Sayop sa pag-format 103 – Lain nga sayop 110 – Wala mailhi ang subscriber 111 – Gidili ang subscriber 112 – Ang subscriber wala gihatag 113 – Dili magamit ang subscriber 120 – kapakyasan sa SMSC 121 – Paghuot sa SMSC 122 – SMSC roaming 130 – Kasaypanan sa handset 131 – Milapas ang handset memory Mahimong magkalainlain ang pamatasan sa mga integrasyon sa Operator. |
| OperatorTimeStamp | hilo | O | – | 20 | Oras nga nagpakita kung kanus-a na-trigger ang report sa SMSC sa Operator (kung gihatag sa Operator). Ang time zone sa orasamp mao ang CET o CEST (nga adunay panahon sa ting-init nga gihubit alang sa EU). Format: yyyyMMdd HH:mm:ss. |
| StatusText | hilo | O | – | 255 | Placeholder para sa dugang nga impormasyon gikan sa Operator, eg klaro nga deskripsyon sa teksto sa status/rason. Mahimong magkalainlain ang pamatasan sa mga integrasyon sa Operator. |
| CorrelationId | hilo | O | – | 100 | Ang correlation ID nga gihatag sa SendRequest o SendTextRequest. |
| OperatorNetworkCode | integer | O | – | 6 | Ang Mobile Network Code (MCC + MNC) sa Operator. |
* M = Mandatory, O = Opsyonal, I = Wala tagda.
Ang Service Provider kinahanglan maghatag LINK Mobility sa target URL alang sa mga taho sa paghatod (opsyonal nga naglakip sa mga kredensyal alang sa HTTP nga batakang pag-ila). Makapili ang Service Provider kung unsa ang gusto nga pamaagi sa HTTP nga gamiton:
HTTP POST (girekomenda)
HTTP GET.
Exampgamit ang HTTP GET (malampuson nga gihatag):
https://user:password@www.serviceprovider.com/receivereport?%20MessageId=122&DestinationAddress=46762050312&Operator=Vodafone&TimeStamp=20100401%2007%3A47%3A44&StatusCode=0
Exampgamit ang HTTP GET (wala gihatod, ang Operator naghatag ug timestamp para sa panghitabo):
Ang mga parameter mao ang URL pag-encode.
Pag-encode sa karakter:
Makapili ang Service Provider kung unsang gusto nga pag-encode sa karakter ang gamiton:
UTF-8 (girekomendar)
ISO-8859-1.
9.1 Pag-ila sa Taghatag sa Serbisyo
Kinahanglang ilhon sa Service Provider ang matag report sa paghatod. Ang pag-ila mahimong positibo, ie ang report sa pagpadala malampuson nga nadawat, o negatibo, ie kapakyasan.
Palihug timan-i: Ang LINK Mobility adunay timeout sa pagbasa alang sa mga pag-ila nga 30 segundos alang sa mga taho sa pagpadala. Ang usa ka timeout magpahinabog usa ka pagsulay pag-usab sa pagpadala (kon sulayan pag-usab ang mahimo) o usa ka pagkansela sa paghatod (kon sulayan pag-usab ang dili mahimo). Kini nagpasabut nga ang aplikasyon sa Service Provider kinahanglan nga masiguro ang dali nga mga oras sa pagtubag, labi na sa panahon sa taas nga load.
Girekomendar kaayo ang pag-ila sa report sa paghatud ngadto sa LINK Mobility sa dili pa kini iproseso.
Ang lagda alang sa positibo ug negatibo nga pag-ila gihulagway ingon sa mosunod:
Positibo nga pag-ila, ACK, report sa pagpadala nga gihatag:
HTTP 200 range response code inubanan sa mosunod nga XML formatted content:
Negatibo nga pag-ila, NAK, report sa paghatud wala gihatag:
Bisan unsa nga tubag gawas sa positibo nga pag-ila, alang sa exampUg, usa ka negatibo nga pag-ila ang ma-trigger sa bisan unsang HTTP error code o sa mosunod nga XML nga sulud:
Ang sulud sa XML mahimong magamit alang sa pagkontrol sa mekanismo sa pagsulay pag-usab sa LINK Mobility. Ang NAK magpahinabo sa pagsulay pag-usab, kung mahimo. Para sa mga Service Provider nga wala ma-configure para sa mekanismo sa pagsulay pag-usab, opsyonal ang XML content.
Sa ubos usa ka HTTP POST nga hangyo ug tubag exampAng usa ka report sa pagpadala nga gihatag sa usa ka Service Provider:
HTTP hangyo:
POST /konteksto/app HTTP/1.1
Type-sa Sulud: aplikasyon / x-www-form-urlgi-encode;charset=utf-8
Host: server: pantalan
Sulod-Gitas-on: xx
MessageId=213123213&DestinationAddress=46762050312&Operator=Telia& OperatorTimeStamp=20130607%2010%3A45%3A00&TimeStamp=20130607%2010%3A 45%3A02&StatusCode=0
Tubag sa HTTP:
HTTP/1.1 200 OK
Content-Type: text/plain
9.2 Sulayi pag-usab
Ang sistema sa LINK Mobility makahimo sa pagsulay pag-usab alang sa napakyas, ie wala giila, paghatod sa report sa paghatod. Ang Service Provider makapili sa gusto nga sulayan pag-usab nga kinaiya:
Walay pagsulay pag-usab (default) – ang mensahe isalikway kung ang pagsulay sa koneksyon mapakyas, basaha ang time-out o alang sa bisan unsang HTTP error code.
Sulayi pag-usab – ang mensahe isuko alang sa matag matang sa problema sa koneksyon, pagbasa sa timeout, o negatibo nga pag-ila.
Kung gi-enable ang pagsulay pag-usab alang sa NAK, importante nga masabtan kung unsang mga senaryo ang makamugna og pagsulay pag-usab gikan sa LINK Mobility ug kung giunsa ang pagsulay pag-usab. Ang matag Service Provider adunay kaugalingong retry queue, diin ang mga mensahe gi-order sumala sa message timesamp. Ang Link Mobility kanunay nga mosulay sa paghatud sa daan nga mga mensahe una, bisan kung ang indibidwal nga han-ay sa mga mensahe nga gihatag sa Service Provider dili garantiya. Ang nag-unang rason sa mga mensahe nga gilabay gikan sa retry queue mao ang usa sa duha ka rason: ang mensahe TTL matapos o (theoretically) ang retry queue mahimong puno. Ang TTL kay Operator ug nagsalig sa account, ie, mahimong magkalainlain depende sa Operator ug o tipo sa mensahe, pananglitan, premium nga SMS o standard rate nga mensahe sa SMS.
Ang usa ka Service Provider nga adunay retry enabled kinahanglang magsusi sa talagsaong ID sa MT nga mensahe aron masiguro nga ang mensahe wala pa madawat.
Importante alang sa Service Provider nga mosunod niining yano nga mga lagda kung adunay usa ka sayup nga mahitabo sa panahon sa pagproseso sa usa ka report sa paghatud kung ang hinungdan sa sayup mao ang: Temporaryo, pananglitan wala ang database, usa ka NAK kinahanglan ibalik. Ang LINK Mobility mopadala pag-usab sa mensahe.
Permanente ug usa ka pagsulay pag-usab lagmit nga hinungdan sa parehas nga klase sa problema, usa ka ACK kinahanglan ibalik. Kay example, kung ang mensahe dili ma-parse sa husto o hinungdan sa usa ka wala damha nga runtime error.
Ang paglihok sumala niini magsiguro nga wala’y pag-block o pagkadaot sa throughput nga gipahinabo tungod sa usa ka taho sa pagpadala nga gibalikbalik nga gibalikbalik.
10. Mga tip sa pagpatuman
1. Posible nga gamiton ang imong web browser aron isumite ang mga hangyo sa API. Gipadali niini ang pagsuhid ug pagtimbang-timbang sa mga serbisyo nga wala’y bisan unsang mga himan sa pag-uswag.
2. Girekomenda ang Chrome o Firefox kauban ang usa ka extension sama sa JSONView aron ipakita ang pretty-formatted nga JSON.
3. Gigamit namo ang SoapUI alang sa pagsulay sa POST, Basic Authentication ug sa pag-inspeksyon sa hilaw nga HTTP nga hangyo ug tubag nga mga mensahe.
4. Ang cURL Ang himan mapuslanon alang sa pagsumite sa mga hangyo sa POST nga adunay Basic Authentication. Tan-awa ang exampsa ubos.
curl POST \
-H “Content-Type: aplikasyon/x-www-form-urlgi-encode” \
-H "Awtorisasyon: Basic am9objpjaGFuZ2VtZSA=" \
https://europe.ipx.com/restapi/v1/sms/send \
–data “destinationAddress=46123456789&messageText=Hello+World%21”
_______________
Pag-usab sa Personalized nga Komunikasyon
Mga Dokumento / Mga Kapanguhaan
 |
LINK Giya sa Pagpatuman sa Mobility REST API SMS [pdf] Giya sa Gumagamit Giya sa Pagpatuman sa Mobility REST API SMS, Mobility, Giya sa Pagpatuman REST API SMS, REST API SMS, API SMS, SMS |
