LINK Mobility Implementation Guide REST API SMS
Hāʻawi ʻo LINK Mobility i kahi lawelawe no ka lawe ʻana i nā memo, nā uku micro, a me nā lawelawe ma kahi wahi. Hana ʻia ka paepae ma ke ʻano he mea kūʻai ʻike ʻike keʻokeʻo a me ke alahele kālepa ma waena o nā mea hoʻolako lawelawe a me nā mea hana.
Hāʻawi ʻo LINK Mobility i kahi API RESTful hiki ke hoʻohana ʻia e komo i nā lawelawe LINK Mobility e like me ka hoʻouna ʻana i ka SMS. Hoʻolālā ʻia kēia API i mea maʻalahi e hoʻohana a kūpono hoʻi me nā ʻōlelo a me nā hoʻolālā hou. Ke hoʻohana nei i ka ʻōlelo āu e koho ai, hiki i kāu palapala noi ke hoʻohana i ka Link Mobility REST API e hoʻokō i nā mana memo a me ka uku.
© LINK Mobility, Malaki 10, 2021
ʻIke pili kānāwai
ʻO ka ʻike i hāʻawi ʻia ma kēia palapala ʻo ia wale nō ka waiwai a me ke kuleana kope o Netsize. He mea hūnā a manaʻo ʻia no ka hoʻohana pono ʻana i ka ʻike. ʻAʻole paʻa a hiki ke hoʻololi ʻia me ka ʻole o ka hoʻolaha. ʻO ka hōʻike ʻole ʻia a hoʻohana ʻole ʻia e manaʻo ʻia he hewa.
Mālama ʻia ʻo Netsize™ a me linkmobility™ e nā kānāwai o ka ʻĀina Palani, EEC a me nā kānāwai waiwai naʻauao honua.
ʻO nā hōʻailona ʻē aʻe a pau i ʻōlelo ʻia ʻo ia wale nō ka waiwai o ko lākou mau mea nona.
ʻAʻohe mea i loko o kēia e manaʻo ʻia me ka hāʻawi ʻana i kekahi laikini a kuleana paha ma lalo o ka patent Netsize, kope kope, a i ʻole ka hōʻailona.
NETSIZE
Société anonyme au kapikala de 5 478 070 euros
Siège social :62, alanui Emile Zola92100 Boulogne – Palani
418 712 477 RCS Nanterre
http://www.LinkMobility.com
http://www.linkmobility.com
Lai o ka Palapala
Hōʻike kēia palapala i ka hoʻohana ʻana o ka mea hoʻolako i ka LINK Mobility REST API no ka SMS. Ua manaʻo ʻia no nā mea hoʻolālā ʻenehana a me nā mea hoʻolālā e hoʻokō nei i nā lawelawe o ka Service Provider.
1. Hoohana Kumu
He mea maʻalahi loa ka hoʻouna ʻana i kahi SMS. Hoʻouna ʻoe i kahi noi HTTP iā LINK Mobility hiki ke hoʻokō me ka hoʻohana ʻana i kahi web polokalamu kele pūnaewele.
2. Functional Overview
Hāʻawi ka ʻōnaehana LINK Mobility i kēia mau hana kumu no nā leka SMS:
Ka hoʻouna ʻana i nā memo SMS i hoʻopau ʻia (MT), e like me ke kikokikona a i ʻole ka binary (e laʻa me WAP Push) me nā memo uku maʻamau.
Loaʻa i nā hōʻike hoʻouna no nā leka MT i waiho ʻia.
Loaʻa i nā memo SMS Mobile Originated (MO), ka uku a me ka uku maʻamau.
Hoʻolaʻa ʻia ka SMS REST API no ka hoʻouna ʻana i nā leka MT SMS maʻamau.
Hoʻouna ka API i nā memo SMS āpau me ka like ʻole, hiki i nā hiʻohiʻona e like me:
"Ke ahi-a-poina" - makemake ka mea lawelawe e loaʻa i nā manawa pane ʻoi aku ka wānana a ʻaʻole makemake e kali i ka hopena mai ka Operator.
E ho'āʻo hou i ka hana - LINK Mobility e hoʻouna hou i ka leka inā loaʻa nā pilikia o ka Operator.
2.1 Hoʻouna ʻana i kahi leka SMS
Mea hoʻolako lawelawe Netsize Consumer
- E hoʻouna i ka memo MT
- E hoʻihoʻi i ka memo ID
- Hoʻouna i ka memo SMS
- Hāʻawi i ka hōʻike hoʻouna
- Hoʻouna i ka hōʻike hoʻouna
ʻO ke kahe kumu no ka hoʻouna ʻana i nā leka SMS i wehewehe ʻia penei:
Hoʻouna ka mea hoʻolako lawelawe i kahi leka SMS i ka mea loaʻa ma o ka ʻōnaehana LINK Mobility.
Hoʻihoʻi ʻia kahi ID memo i ka mea hoʻolako lawelawe. Hiki ke hoʻohana ʻia kēia ID no ka laʻana i ka hoʻopili ʻana i ka memo me ka hōʻike hoʻopuka pololei.
Mālama ʻo LINK Mobility i ka hoʻokele a hāʻawi i ka leka SMS i ka mea kūʻai aku i ʻōlelo ʻia.
Hoʻomaka ʻia kahi hōʻike hoʻopuka, e laʻa i ka wā i hoʻouna ʻia ai ka leka SMS i ka mea kūʻai aku.
Hoʻouna ʻia ka hōʻike hoʻouna i ka mea hoʻolako lawelawe. Loaʻa i ka hōʻike ka ID memo like me ka mea i hoʻihoʻi ʻia ma ka ʻanuʻu 2.
Kahe ʻokoʻa: Noi kūpono ʻole
Inā ʻaʻole kūpono nā ʻāpana i hāʻawi ʻia a i ʻole nā mea hoʻohana i loko o ka noi, ua hoʻihoʻi ʻia kahi hewa i ka mea hoʻolako lawelawe. Hōʻike ka hewa i ke kumu o ka hōʻole ʻana a pau ke kahe. ʻAʻole hoʻihoʻi ʻia nā ID memo.
3. Hopena
Loaʻa ʻia ka punawai SMS me ke ala:
/restapi/v1/sms
Example URL
https://europe.ipx.com/restapi/v1/sms
No ka palekana pili, hiki ke ʻike ʻia ka LINK Mobility REST API ma HTTPS wale nō.
Ua pūlima ʻia ka palapala kikowaena Link Mobility e Thawte Server CA.
4. Nā hana
Hāʻawi ka lawelawe SMS i nā hana penei:
| inoa | Alanui |
| Hoʻouna | /restapi/v1/sms/send |
4.1 Hoʻouna
Hoʻohana ʻia ka hana hoʻouna e hoʻouna i kahi SMS i hoʻokahi mea loaʻa.
Hana ʻia kēia hana no nā mea hoʻohana maʻamau a me nā mea hoʻohana kiʻekiʻe. Ma ka hihia maʻalahi, ʻo ka helu wahi wale nō, a me ka kikokikona memo e koi ʻia e hoʻouna i kahi SMS. E ʻike ʻo LINK Mobility i ka Data Coding Scheme a hana i ka concatenation aunoa o kahi memo i nā ʻāpana memo he nui inā pono.
No ka hoʻohana kiʻekiʻe, hiki i ka mea hoʻolako lawelawe ke hoʻohana i nā ʻāpana koho no ka mana piha o ka hoʻopili ʻana i ka memo me ke poʻo ʻikepili mea hoʻohana.
Hiki i ka Service Provider ke hoʻouna i nā memo i hui pū ʻia, akā ʻo ka hoʻomākaukau ʻana i ka ʻikepili mea hoʻohana a me ke poʻomanaʻo ʻikepili mea hoʻohana pono e hana ʻia e ka Service Provider a pono e hoʻouna ʻia ka leka ma o nā noi hoʻouna he nui iā LINK Mobility.
5. Hooiaio
Hoʻouna ʻia ka inoa hoʻohana a me ka ʻōlelo huna i kēlā me kēia noi me ka hoʻohana ʻana i ka HTTP Basic Authentication Scheme.
https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA
Hoʻouna ʻia nā hōʻoia ma kahi poʻomanaʻo Manaʻo ma ka noi HTTP. Hoʻokumu ka mea kūʻai i ke kahua poʻomanaʻo e like me ka wehewehe ʻana ma aneʻi:
https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side
No exampʻAe, inā ʻo john ka inoa inoa a ʻo changeme ka ʻōlelo huna a laila ʻo ke poʻo poʻomanaʻo mana:
Manaʻo: Basic am9objpjaGFuZ2VtZSA=
Ma ke ʻano he hāʻule hope hiki ke waiho ʻia ka inoa inoa a me ka ʻōlelo huna e like me nā ʻāpana noi. Manaʻo ʻia kēia no nā mea kūʻai aku ʻaʻole kākoʻo i ka Basic Auth.
6. Ke waiho nei i kahi noi
6.1 Ke kaula ninau
Hoʻouna ʻia nā ʻāpana noi ma ke ʻano he kaula nīnau i loaʻa nā hui inoa/waiwai. Hoʻopili ʻia ke kaula nīnau me ka hoʻohana ʻana i ka Pakeneka Encoding (URL hoʻopili).
http://www.w3schools.com/tags/ref_urlencode.asp
No example, Aloha World! ua hoʻopaʻa ʻia ʻo Hello+World%21.
6.2 Nā palena noi koi
| inoa | Max lōʻihi | wehewehe |
| wahi hoʻouna | 40 | ʻO ka MSISDN kahi e hoʻouna ʻia ai ka leka SMS, e hoʻomaka me ka code ʻāina. Example: 46123456789. No kekahi mau mākeke (kahi pono e hoʻopili ʻia ka Consumer MSISDN) hiki i kēia waiwai ke lilo i inoa alphanumeric, i kau mua ʻia me ka "#". |
| messageText | 1600 | ʻO ka ʻike memo SMS. |
6.3 Nā ʻāpana noi koho (no ka hoʻohana mua ʻana)
| inoa | Max lōʻihi | wehewehe |
| originatingAddress | 16 | Ka helu kumu no ka memo SMS puka. Ua wehewehe ʻia ke ʻano o ka helu wahi e ka originatorTON parameter. ʻO 16 ka lōʻihi o ka helu pōkole. Ua kaupalena ʻia ka mea hoʻouna helu alpha i ka Alphabet paʻamau GSM me ka lōʻihi he 11 mau huaʻōlelo. ʻO 15 ka lōʻihi o ka mea hoʻouna MSISDN (e hoʻohana ana i ka ʻano like me ka mea destinationAddress). Hiki ke waiho ʻia ke koho ʻia ka originatingAddress a me originatingTON e ka ʻōnaehana. Pili kēia hana i ka mākeke a me ka hoʻonohonoho. Hiki ke ʻokoʻa ke ʻano me ka hui pū ʻana o Operator. |
| mea hoʻomakaTON | 1 | Ke ʻano helu helu (TON): 0 - Helu pōkole 1 – Helu alpha (ka lōʻihi 11) 2 – MSISDN Hiki ke waiho ʻia ke koho ʻia ka originatingAddress a me originatingTON e ka ʻōnaehana. Pili kēia hana i ka mākeke a me ka hoʻonohonoho. Hiki ke ʻokoʻa ke ʻano me ka hui pū ʻana o Operator. |
| userDataHeader | 280 | Hiki ke loaʻa i ka Head Data User me ka User Data a hiki i ka 140, ie 280 when hex-encoded, octets. Hoʻopili mau ʻia kēia ʻāpana hex. |
| DCS | 3 | ʻIkepili hoʻopāpā helu. Hiki ke ʻokoʻa ke ʻano me ka hui pū ʻana o Operator. |
| PID | 3 | ID kaʻina. Hiki ke ʻokoʻa ke ʻano me ka hui pū ʻana o Operator. |
| relativeValidityTime | 6 | ʻO ka manawa kūpono i kekona (e pili ana i ka manawa no ka hoʻouna ʻana iā LINK Mobility). ʻO ka waiwai nui ka 604800 (7 lā) a ʻo ka paʻamau he 48 mau hola. Hiki ke ʻokoʻa ke ʻano me ka hui pū ʻana o Operator. |
| manawa hāʻawi | 20 | Manawaamp i ka wā e hoʻouna ʻia ai ka leka SMS (manawa hoʻouna ʻia). E ʻike i ka ʻāpana o ka hōʻano manawa lā. |
| statusReportFlags | 1 | Hāʻawi i ka noi hōʻike: 0 - ʻAʻohe hōʻike hoʻopuka (paʻamau) 1 - Ua noi ʻia ka hōʻike hoʻouna 9 - Ua noi ʻia ka hōʻike hoʻouna kikowaena (LINK Mobility ʻaʻole e hoʻouna i ka hōʻike i ka Mea Hoʻolako lawelawe akā hāʻawi ʻia ia i nā hōʻike a me nā mea.) |
| campaignName | 50 | ʻO nā kālepa LINK Mobility tagged me keia inoa. Hoʻohana ʻia ia e hui pū i nā hana ma nā hōʻike Link Mobility. |
| maxConcatenatedMessages | 1 | He waiwai ma waena o 1 a me 10 e wehewehe ana i ka nui o nā memo i ʻae ʻia. ʻO 3 ka paʻamau. |
| correlationId | 100 | ʻO ka ID i hāʻawi ʻia e ka mea hoʻolako lawelawe e hoʻokani ʻia i ka hōʻike hoʻouna. |
| mea hoʻohana | 100 | Hāʻawi ʻia ma ke ʻano he ʻokoʻa i ka HTTP Basic Authentication. |
| hua huna | 100 | Hāʻawi ʻia ma ke ʻano he ʻokoʻa i ka HTTP Basic Authentication. |
6.4 Nā Hana Noi HTTP
No ka hoʻokō pono loa, kākoʻo ka API i nā ala noi HTTP GET a me POST. ʻAʻole ʻae ʻia nā ala HTTP ʻē aʻe.
6.4.1 LOA
Hoʻopili ʻia ke kaula nīnau i hoʻopaʻa ʻia i ka URL.
E LOAA
https://europe.ipx.com/restapi/v1/sms/send?destinationAddress=461234
56789&messageText=Aloha+Ao%21
Manaʻo: Basic am9objpjaGFuZ2VtZSA=
6.4.2 PONO
Hoʻouna ʻia ke kaula nīnau i hoʻopaʻa ʻia ma ke kino memo noi HTTP. ʻO ke ʻano maʻiʻo ka palapala noi/x-www-form-urlhoʻopaʻa ʻia.
POST https://europe.ipx.com/restapi/v1/sms/send
Mea hoʻokele: europe.ipx.com
ʻAno maʻiʻo: application / x-www-form-urlhoʻopaʻa ʻia
Manaʻo: Basic am9objpjaGFuZ2VtZSA=
Maʻiʻo-Loihi: 57
destinationAddress=46123456789&messageText=Aloha+World%21
6.5 Ka lā a me ka manawa
ʻO nā ʻāpana o ka REST API e hōʻike ana i ka lā a me ka manawa aia mau i ka manawa UTC (Coordinated Universal Time). Ka manawaampHōʻike ʻia nā s ma ke ʻano he kaula me kēia ʻano kikoʻī:
2017-04-25T23:20:50Z
He 20 minuke a me 50 kekona ma hope o ka hola 23 o ʻApelila 25th, 2017 ma UTC.
7. ʻŌlelo pane
Ma hope o ka loaʻa ʻana a me ka unuhi ʻana i kahi leka noi, pane ka API me kahi leka pane HTTP.
7.1 HTTP code kūlana
Hoʻihoʻi mau ka REST API i ka helu kūlana HTTP 200 OK no nā noi i hoʻoponopono ʻia. Aia i loko o ke kino o ka memo kekahi code pane ʻāpana i hoʻohana ʻia e hoʻoholo i ka hopena pololei.
7.2 Ke kino memo
Aia ke kino memo me JSON e wehewehe ana i ka hopena o ka noi.
http://json.org/
Hoʻopili ʻo Link Mobility JSON me ka Google JSON Style Guide.
https://google.github.io/styleguide/jsoncstyleguide.xml
7.3 Nā palena pane
| inoa | Max lōʻihi | wehewehe |
| paneCode | 3 | Hōʻike ka 0 i ke kālepa kūleʻa. |
| paneMessage | 255 | ʻO ka wehewehe kikokikona pane, e laʻa i ke kikokikona hewa. |
| manawaamp | 20 | Ka lā a me ka manawa i hana ai ʻo LINK Mobility i ka noi. (E nānā i ka ʻāpana hōʻano lā/manawa). |
| traceId | 36 | Mea hoʻomaopopo i loko o Link Mobility. Hoʻohana ʻia no ke kākoʻo a me ka hoʻoponopono pilikia. |
| messageIds | 10 x 36 | Array o LINK Mobility mau memo ID no kēlā me kēia memo kūleʻa (ua hoʻihoʻi ʻia nā ID memo he nui inā hoʻohui ʻia ka memo). Haʻalele ʻia inā ʻaʻole i hāʻule. |
7.4 Example pane
Pōmaikaʻi
HTTP/1.1 200 OK
ʻAno maʻiʻo: noi/json
Maʻiʻo-Loihi: 144
Lā: Pōʻalima, 15 Sep 2016 13:20:31 GMT
{"Koope pane":0,"responseMessage":"Polopono","ka manawaamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Eia ka JSON i hoʻonohonoho ʻia no ka heluhelu ʻana:
{
“paneCode“:0,
“paneMessage“:”Polopono”,
“manawaamp“:”2016-0915T13:20:31Z”,
“traceId“:”f678d30879fd4adc25f2”,
“messageIds“:[“1-4850879008”] }
hāʻule
HTTP/1.1 200 OK
ʻAno maʻiʻo: noi/json
Maʻiʻo-Loihi: 148
Lā: Pōʻalima, 15 Sep 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” Komo hewa ʻole a i ʻole hoʻohana API ʻae ʻole ʻia”,” manawaamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
Pōmaikaʻi
HTTP/1.1 200 OK
ʻAno maʻiʻo: noi/json
Maʻiʻo-Loihi: 144
Lā: Pōʻalima, 15 Sep 2016 13:20:31 GMT
{"Koope pane":0,"responseMessage":"Polopono","ka manawaamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Eia ka JSON i hoʻonohonoho ʻia no ka heluhelu ʻana:
{
“paneCode“:0,
“paneMessage“:”Polopono”,
“manawaamp“:”2016-0915T13:20:31Z”,
“traceId“:”f678d30879fd4adc25f2”,
“messageIds“:[“1-4850879008”] }
hāʻule
HTTP/1.1 200 OK
ʻAno maʻiʻo: noi/json
Maʻiʻo-Loihi: 148
Lā: Pōʻalima, 15 Sep 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” Komo hewa ʻole a i ʻole hoʻohana API ʻae ʻole ʻia”,” manawaamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
7.5 Nā code pane
Hiki ke hoʻihoʻi ʻia nā code pane ma ka pane hoʻouna:
| Code | kikokikona | wehewehe |
| 0 | Pōmaikaʻi | Ua hoʻokō ʻia. |
| 1 | Komo hewa ʻole a hoʻohana ʻole ʻia ka API | Ua pāpā ʻia ka inoa inoa a i ʻole ka ʻōlelo huna a i ʻole ka mea hoʻolako lawelawe e LINK Mobility. |
| 2 | Ua ālai ʻia ka mea kūʻai e Link Mobility | Ua ālai ʻia ka Consumer e LINK Mobility. |
| 3 | ʻAʻole hāʻawi ʻia ka hana e LINK Mobility | Hoʻopaʻa ʻia ka hana no ka mea hoʻolako lawelawe. |
| 4 | ʻAʻole ʻike ʻia ka mea kūʻai aku iā LINK Mobility | ʻAʻole ʻike ʻia ka Consumer iā LINK Mobility. A i ʻole inā hoʻohana ʻia ka inoa inoa ma ka noi; ʻAʻole i loaʻa ka inoa inoa. |
| 5 | Ua pāpā ka mea kūʻai aku i kēia lawelawe ma LINK Mobility | Ua ālai ka Consumer i kēia lawelawe ma LINK Mobility. |
| 6 | ʻAʻole kākoʻo ʻia ka helu wahi kumu | ʻAʻole kākoʻo ʻia ka helu wahi kumu. |
| 7 | ʻAʻole i kākoʻo ʻia e ka moʻokāki kahi helu kumu alpha | ʻAʻole kākoʻo ʻia ka helu wahi helu alpha. |
| 8 | ʻAʻole i kākoʻo ʻia ka helu kumu o MSISDN | ʻAʻole i kākoʻo ʻia ka helu kumu MSISDN. |
| 9 | ʻAʻole kākoʻo ʻia ʻo GSM | ʻAʻole kākoʻo ʻia ʻo GSM. |
| 10 | ʻAʻole kākoʻo ʻia ka Unicode | ʻAʻole kākoʻo ʻia ka Unicode. |
| 11 | ʻAʻole kākoʻo ʻia ka hōʻike kūlana | ʻAʻole kākoʻo ʻia ka hōʻike kūlana. |
| 12 | ʻAʻole i kākoʻo ʻia ka mana i koi ʻia | ʻAʻole i kākoʻo ʻia ka mana i koi ʻia (koe ma luna aʻe) no ka hoʻouna ʻana i ka leka. |
| 13 | Ua ʻoi aku ka nui o ka helu throttling kiʻekiʻe o ka mea hāʻawi maʻiʻo | Ke hoʻouna wikiwiki nei ka mea lawelawe i nā leka SMS iā LINK Mobility. |
| 14 | ʻAʻole kākoʻo ʻia ka ID Protocol e ka moʻokāki | ʻAʻole i kākoʻo ʻia ka ID Protocol. |
| 15 | Ua ʻoi aku ka palena hoʻohui memo | ʻOi aku ka nui o nā memo i hoʻohui ʻia i ka helu max i noi ʻia. |
| 16 | ʻAʻole hiki ke ala i ka memo. | ʻAʻole hiki iā LINK Mobility ke ala i ka memo. |
| 17 | Kauā manawa pāpā ʻia | ʻAʻole ʻae ʻia e hoʻouna i ka memo i ka manawa |
| 18 | Haʻahaʻa haʻahaʻa ma ka moʻokāki hoʻolako lawelawe | Ua ālai ʻia ka mea lawelawe ma muli o ke koena haʻahaʻa loa |
| 50 | holomua hapa | Loaʻa ka lanakila ma ka hoʻouna ʻana i kahi leka SMS i nā mea loaʻa he nui. |
| 99 | Kuʻia kikowaena kikowaena | Nā hewa Link Mobility ʻē aʻe, e kelepona iā LINK Mobility kākoʻo no ka ʻike hou aku. |
| 100 | Hewa ka helu wahi e hele ai | ʻAʻole kūpono ka helu wahi (MSISDN, a i ʻole ka inoa inoa). |
| 102 | ʻAʻole kūpono ka ID i kuhikuhi ʻia (pili ʻia). | ʻAʻole kūpono ka ID kuhikuhi, malia paha ua hoʻohana mua ʻia ka ID kuhikuhi, kahiko a ʻike ʻole paha. |
| 103 | Helu ka inoa mooolelo | He kūpono ʻole ka inoa moʻokāki. |
| 105 | Hewa ka ʻikepili meta lawelawe | He kūpono ʻole ka ʻikepili meta lawelawe. |
| 106 | Helu kūpono ʻole | He kūpono ʻole ka helu wahi i kumu. |
| 107 | Heluhelu helu helu helu ʻole | He kūpono ʻole ka helu helu helu helu. |
| 108 | Manawa kūpono ʻole | ʻAʻole kūpono ka manawa kūpono. |
| 109 | Hewa ka manawa lawe | He kūpono ʻole ka manawa hoʻouna. |
| 110 | He kūpono ʻole ka ʻikepili memo/ka mea hoʻohana | ʻAʻole kūpono ka ʻikepili mea hoʻohana, ʻo ia hoʻi ka leka SMS. |
| 111 | Pono ʻole ka lōʻihi memo | He kūpono ʻole ka lōʻihi o ka memo SMS. |
| 112 | Poʻomanaʻo ʻikepili mea hoʻohana hewa ʻole | He kūpono ʻole ke poʻo ʻikepili mea hoʻohana. |
| 113 | ʻAʻohe manaʻo hoʻopaʻa inoa ʻikepili | He kūpono ʻole ka DCS. |
| 114 | Hewa ka protocol ID | He kūpono ʻole ka PID. |
| 115 | Nā hae hōʻike kūlana kūpono ʻole | He kūpono ʻole nā hae hōʻike kūlana. |
| 116 | TON hewa ʻole | He kūpono ʻole ka TON kumu. |
| 117 | Pono ʻole campinoa aign | ʻO ka campʻAʻole kūpono ka inoa aign. |
| 120 | He palena ʻole no ka helu kiʻekiʻe o nā memo i hoʻohui ʻia | He kūpono ʻole ka helu nui o nā memo i hoʻohui ʻia. |
| 121 | He kūpono ʻole ka helu wahi i puka mai ai msisdn | He kūpono ʻole ka helu wahi i hoʻokumu ʻia ai MSISDN. |
| 122 | ʻAʻole kūpono ka ID pili | He kūpono ʻole ka ID pili. |
8. Nā hiʻohiʻona koho
8.1 Hoʻoponopono MSISDN
ʻO ka hoʻoponopono MSISDN kahi hiʻohiʻona koho e hiki ke hoʻohana ʻia e LINK Mobility kākoʻo inā noi ʻia.
Na kēia hiʻohiʻona e hoʻoponopono i nā helu wahi e hele ai a hoʻolikelike iā lākou i ke ʻano E.164 i makemake ʻia. Ma waho aʻe o ka hoʻoponopono ʻana i ke ʻano, hiki i ka ʻōnaehana ke hana i nā hana kikoʻī o ka mākeke e like me ka unuhi ʻana i nā helu Farani honua e hoʻoponopono i nā helu DOM-TOM (départements et territoires d'outre-mer) inā pili.
Aia ma lalo kahi helu o exampnā hoʻoponopono:
| Waiho ʻia kahi helu wahi | Hoʻoponopono ʻia ka helu wahi |
| +46(0)702233445 | 46702233445 |
| (0046)72233445 | 46702233445 |
| +460702233445 | 46702233445 |
| 46(0)702233445 | 46702233445 |
| 46070-2233445 | 46702233445 |
| 0046702233445 | 46702233445 |
| +46(0)702233445aaa | 46702233445 |
| 336005199999 | 2626005199999 (Uhi ʻia ka helu Palani i ka helu DOM-TOM) |
Eia hou, hiki ke ʻae i nā helu kelepona aupuni no kahi mākeke i koho ʻia. Ke hoʻohana ʻia kēia hiʻohiʻona, pono e hoʻouna ʻia nā helu honua no nā mākeke ʻē aʻe me kahi hōʻailona `+' mua e hoʻokaʻawale iā lākou mai ka mākeke i koho ʻia.
Aia ma lalo kekahi mau exampka liʻiliʻi o nā hoʻoponopono i hana ʻia i ka wā e hoʻohana ai iā Kuekene (country code 46) ma ke ʻano he mākeke paʻamau no nā helu ʻāina.
| Waiho ʻia kahi helu wahi | Hoʻoponopono ʻia ka helu wahi |
| 0702233445 | 46702233445 |
| 070-2233 445 | 46702233445 |
| 070.2233.4455 | 46702233445 |
| 460702233445 | 46702233445 |
| +460702233445 | 46702233445 |
| +458022334455 | 458022334455 |
| 45802233445 | He kūpono ʻole no ka mea ua nalo ka hōʻailona '+' |
E hoʻomaopopo e hoʻohana ʻia ka MSISDN i hoʻoponopono ʻia e LINK Mobility a e hoʻihoʻi ʻia i nā hōʻike hoʻopuka.
E ʻoluʻolu e kelepona iā LINK Mobility kākoʻo no ka ʻike hou aku.
8.2 Hoʻololi i ke ʻano
ʻO ka hoʻololi ʻana i ke ʻano he hiʻohiʻona koho e hiki ke hoʻohana ʻia e ke kākoʻo LINK Mobility inā noi ʻia.
Na kēia hiʻohiʻona e unuhi i nā huapalapala ʻaʻole GSM i loko o ka ʻikepili mea hoʻohana (SMS kikokikona) i like GSM alphabet characters ke kau ʻia ka DCS i “GSM” (17). No exampe unuhi ʻia ka "Seqüência de teste em Português" i "Seqüencia de teste em Portugues".
9. Nā hōʻike hoʻouna
Hiki i ka mea hoʻolako lawelawe, inā hāʻawi ʻia, ke noi aku i nā hōʻike hoʻouna leka SMS a i ʻole nā leka hoʻolaha no nā leka MT i hoʻouna ʻia. Hoʻomaka ʻia kēia mau hōʻike i ka SMSC Operator ke hāʻawi ʻia ka leka MT i ka mea kūʻai aku i manaʻo ʻia a holoi ʻia paha, no ka laʻana, pau a i ʻole, no kekahi kumu, ʻaʻole hiki ke hoʻokele.
ʻO ke kūlana hope wale nō o ka leka SMS i hōʻike ʻia i ka Mea Hoʻolako lawelawe, ʻo ia hoʻi, hāʻawi ʻia a holoi ʻia. Hoʻokahi wale nō hōʻike no kēlā me kēia memo MT i hana ʻia. Me ke kūlana i holoi ʻia, hiki ke hoʻopili ʻia kahi code kumu. Hōʻike kēia code kumu i ke kumu o ka hāʻawi ʻole ʻia ʻana o ka leka SMS.
Hoʻouna ʻia nā hōʻike ma o LINK Mobility a hoʻouna ʻia i ka Service Provider me ka hoʻohana ʻana i ka protocol HTTP.
No ka loaʻa ʻana o nā hōʻike, pono e hoʻokō ka mea lawelawe no exampʻO kahi Java Servlet a i ʻole kahi ʻaoʻao ASP.NET. Loaʻa iā lāua nā noi HTTP GET a POST paha.
Nā ʻāpana
Aia i loko o ke noi kēia mau ʻāpana:
| ʻĀpana | ʻAno | M/O/I* | Waiwai Paʻamau | Max lōʻihi | wehewehe |
| MessageId | kaulahao | M | – | 22 | ʻO ka ID memo o ka memo MT e pili ana kēia hōʻike. |
| Wahi Hoʻopiʻi | kaulahao | M | – | 40 | ʻO ka MSISDN o ka mea kūʻai aku, ʻo ia hoʻi ka helu wahi o ka memo MT mua. |
| Code Kūlana | integer | M | 1 | Hōʻike ke code kūlana i ke kūlana o ka memo MT. ʻO nā code kūlana kūpono: 0 – Hāʻawi ʻia 2 - Holoi ʻia (pili ke kumu kumu) |
|
| Manawaamp | kaulahao | M | – | 20 | Hōʻike ka manawa i ka manawa i loaʻa ai ka hōʻike hoʻopuka e LINK Mobility. Ka palena manawa o ka manawaamp ʻo CET a i ʻole CEST (me ka manawa kauwela e like me ka wehewehe ʻana no ka EU). Hōʻano: yyyyMMdd HH:mm:ss. |
| Mea hoʻohana | kaulahao | M | – | 100 | ʻO ka inoa o ka Operator i hoʻohana ʻia i ka hoʻouna ʻana i ka memo SMS a i ʻole ka inoa moʻokāki i hoʻohana ʻia i ka hoʻouna ʻana i ka leka SMS. Hāʻawi ʻia kahi papa inoa o nā mea lawelawe e LINK Mobility kākoʻo. |
| Kumu Kumu | integer | O | – | 3 | Hōʻike ke code kumu i ke kumu i pau ai ka memo i ke kūlana i holoi ʻia. ʻO nā code kumu kūpono: 100 - Pau 101 – Hooleia 102 – Haʻihaʻi ʻia 103 - Kekahi hewa ʻē aʻe 110 - ʻAʻole ʻike ʻia ka mea kākau inoa 111 – Ua pāpā ʻia ka mea kākau inoa 112 - ʻAʻole hāʻawi ʻia ka mea kākau inoa 113 - ʻAʻole loaʻa ka mea kākau inoa 120 - SMSC hemahema 121 – Hoʻopiʻi SMSC 122 – Helu SMSC 130 – Hapa lima lima 131 - Ua ʻoi aku ka nui o ka hoʻomanaʻo lima lima Hiki ke ʻokoʻa ke ʻano me ka hoʻohui ʻana o Operator. |
| Mea ManawaStamp | kaulahao | O | – | 20 | ʻO ka manawa e hōʻike ana i ka wā i hoʻomaka ʻia ai ka hōʻike ma ka SMSC o ka Operator (inā hāʻawi ʻia e ka Operator). Ka palena manawa o ka manawaamp ʻo CET a i ʻole CEST (me ka manawa kauwela e like me ka wehewehe ʻana no ka EU). Hōʻano: yyyyMMdd HH:mm:ss. |
| KūlanaText | kaulahao | O | – | 255 | Placeholder no ka ʻike hou aku mai ka Operator, e laʻa me ka wehewehe kikokikona o ke kūlana/kumu. Hiki ke ʻokoʻa ke ʻano me ka hoʻohui ʻana o Operator. |
| CorrelationId | kaulahao | O | – | 100 | Hāʻawi ʻia ka ID correlation ma ka SendRequest a i ʻole SendTextRequest. |
| CodeNetwork Operator | integer | O | – | 6 | ʻO ka Code Network Mobile (MCC + MNC) o ka Mea Hana. |
* M = Mandatory, O = Koho, I = Manaʻo ʻole.
Pono ka mea hoʻolako lawelawe e hāʻawi iā LINK Mobility me ka pahuhopu URL no ka lawe ʻana i nā hōʻike (ke komo pū me nā hōʻoia no ka hōʻoia kumu HTTP). Hiki i ka mea lawelawe ke koho i ke ʻano HTTP makemake e hoʻohana ai:
HTTP POST (koi ʻia)
HTTP GET.
Exampme ka hoʻohana ʻana i ka HTTP GET (ua hoʻouna ʻia ka lanakila):
https://user:password@www.serviceprovider.com/receivereport?%20MessageId=122&DestinationAddress=46762050312&Operator=Vodafone&TimeStamp=20100401%2007%3A47%3A44&StatusCode=0
Exampme ka hoʻohana ʻana iā HTTP GET (ʻaʻole i hāʻawi ʻia, ua hāʻawi ka Operator i ka manawaamp no ka hanana):
ʻO nā palena URL hoʻopaʻa ʻia.
Hoʻopāpā ʻano:
Hiki i ka mea hoʻolako ke koho i ka hoʻopāpā ʻana i makemake ʻia e hoʻohana ai:
UTF-8 (manaʻo ʻia)
ISO-8859-1.
9.1 Hoʻomaikaʻi i ka mea hoʻolako lawelawe
Pono ka mea hoʻolako lawelawe e hoʻomaopopo i kēlā me kēia hōʻike hoʻopuka. Hiki ke maikaʻi ka hōʻoia, ʻo ia hoʻi, ua loaʻa maikaʻi ka hōʻike hoʻopuka, a i ʻole maikaʻi ʻole, ʻo ia hoʻi, hāʻule.
E ʻoluʻolu e hoʻomaopopo: Loaʻa iā LINK Mobility kahi manawa heluhelu no ka hoʻomaikaʻi ʻana i 30 kekona no nā hōʻike hoʻopuka. E hoʻomaka ka hoʻāʻo hou ʻana (inā hiki ke hoʻāʻo hou) a i ʻole ke kāpae ʻana i ka hoʻouna ʻana (inā paʻa ka hoʻāʻo hou). 'O ia ho'i, pono e hō'oia ka palapala 'Oihana Ho'olaha i nā manawa pane wikiwiki, 'oi aku ka nui o ka ukana.
Manaʻo nui ʻia e hoʻomaopopo i ka hōʻike hoʻouna ʻana iā LINK Mobility ma mua o ka hana ʻana.
Ua wehewehe ʻia ka lula no ka hōʻoia maikaʻi a me ka maikaʻi ʻole:
Hoʻomaikaʻi maikaʻi, ACK, hōʻike hoʻopuka i hāʻawi ʻia:
HTTP 200 pāʻālua pane pane i hui pū ʻia me kēia maʻiʻo XML i hoʻopaʻa ʻia:
ʻAʻole i hāʻawi ʻia ka hōʻike hōʻike ʻino, NAK,
ʻO nā pane ʻē aʻe ma waho o ka hōʻoia maikaʻi, no ka exampʻOiaʻiʻo, hoʻomaka ʻia kahi hōʻoia maikaʻi ʻole e kekahi code hewa HTTP a i ʻole ka ʻike XML e hiki mai ana:
Hiki ke hoʻohana ʻia ka ʻike XML no ka hoʻomalu ʻana i ka mīkini hoʻāʻo LINK Mobility. E ho'āʻo hou ka NAK, inā hiki. No nā mea hoʻolako lawelawe ʻaʻole i hoʻonohonoho ʻia no ka mīkini hoʻāʻo hou, he koho ka ʻike XML.
Aia ma lalo kahi noi HTTP POST a pane example o kahi hōʻike hoʻouna i hāʻawi ʻia i kahi Mea Hoʻolako lawelawe:
Noi HTTP:
POST /context/app HTTP/1.1
ʻAno maʻiʻo: application / x-www-form-urlhoʻopili ʻia;charset=utf-8
Mea hoʻokele: server:port
Maʻiʻo-Loihi: xx
MessageId=213123213&DestinationAddress=46762050312&Operator=Telia& OperatorTimeStamp=20130607%2010%3A45%3A00&TimeStamp=20130607%2010%3A 45%3A02&StatusCode=0
Pane HTTP:
HTTP/1.1 200 OK
ʻAno maʻiʻo: kikokiko/plain
9.2 E ho'āʻo hou
Hiki i ka ʻōnaehana LINK Mobility ke hana i nā hoʻāʻo hou no ka hāʻule ʻole, ʻo ia hoʻi, ʻaʻole i ʻae ʻia, nā hoʻopuka hōʻike hoʻopuka. Hiki i ka mea hoʻolako ke koho i ke ʻano hoʻāʻo hou i makemake ʻia:
ʻAʻohe hoʻāʻo hou (paʻamau) - e hoʻolei ʻia ka leka inā hāʻule ka hoʻāʻo pili, heluhelu i ka manawa a i ʻole no kekahi code hewa HTTP.
E hoao hou - e hoʻopiʻi ʻia ka memo no kēlā me kēia ʻano pilikia pili, heluhelu manawa pau, a i ʻole ka hōʻoia maikaʻi ʻole.
Ke hoʻā ʻia ka hoʻāʻo hou ʻana no NAK, he mea nui e hoʻomaopopo i nā hiʻohiʻona e hoʻopuka i kahi hoʻāʻo hou mai LINK Mobility a pehea e hana ai ka hoʻāʻo hou. Loaʻa i kēlā me kēia mea hoʻolako lawelawe kāna laina hoʻāʻo hou, kahi e kauoha ʻia ai nā memo e like me ka manawa o ka memoamp. Ke ho'āʻo mau nei ʻo Link Mobility e hoʻouna mua i nā memo kahiko, ʻoiai ʻaʻole ʻoiaʻiʻo ʻia ke kauoha pākahi o nā memo i hoʻouna ʻia i ka Service Provider. ʻO ke kumu nui o ka hoʻolei ʻia ʻana o nā memo mai ka pila hoʻāʻo hou kekahi o nā kumu ʻelua: a i ʻole ka pau ʻana o ka memo TTL a i ʻole (ma ke ʻano) piha ka pila hoʻāʻo hou. ʻO ka TTL ka mea hoʻohana a pili pū i ka moʻokāki, ʻo ia hoʻi, hiki ke ʻokoʻa ma muli o ke ʻano o ka Operator a i ʻole ke ʻano memo, e laʻa, ka SMS premium a i ʻole ka leka SMS helu maʻamau.
Pono nā mea hoʻolako lawelawe me ka hoʻāʻo hou e nānā i ka ID kūʻokoʻa o ka memo MT e hōʻoia ai ʻaʻole i loaʻa ka memo.
He mea nui i ka mea hoʻolako lawelawe e hoʻokō i kēia mau lula maʻalahi ke loaʻa kahi hewa i ka wā o ka hoʻoili ʻana i kahi hōʻike hoʻopuka inā ʻo ke kumu o ka hewa ʻo ia: No ka manawa, no ka laʻana, ʻaʻole i loaʻa ka waihona, pono e hoʻihoʻi ʻia kahi NAK. E hoʻouna hou ʻo LINK Mobility i ka memo.
ʻO ka hoʻāʻo paʻa a me ka hoʻāʻo hou ʻana paha ke kumu o ka pilikia like, pono e hoʻihoʻi ʻia kahi ACK. No example, i ka wā i hiki ʻole ke hoʻokaʻawale ʻia ka memo a i ʻole i hana hewa ʻole i ka wā holo.
ʻO ka hana e like me ka mea e hōʻoia ʻole ʻaʻole i hoʻopaʻa ʻia a i ʻole ka hoʻohaʻahaʻa ʻia ʻana ma muli o kahi hōʻike hoʻopuka e hoʻouna pinepine ʻia.
10. Nā ʻōlelo aʻoaʻo hoʻokō
1. Hiki ke hoʻohana i kāu web polokalamu kele pūnaewele e hoʻouna i nā noi i ka API. He mea maʻalahi kēia e ʻimi a loiloi i nā lawelawe me ka ʻole o nā mea hana hoʻomohala.
2. Manaʻo ʻia ʻo Chrome a Firefox paha me kahi hoʻonui e like me JSONView e hōʻike iā JSON i hoʻopaʻa ʻia.
3. Ua hoʻohana mākou iā SoapUI no ka hoʻāʻo ʻana i ka POST, Basic Authentication a no ka nānā ʻana i ka noi HTTP maka a me nā memo pane.
4. ʻO ka cURL mea pono no ka waiho ʻana i nā noi POST me ka Basic Authentication. See example lalo.
curl POST \
-H "ʻAno-Maʻiʻo: palapala noi/x-www-form-urlhoʻopaʻa ʻia” \
-H “Ka ʻae: kumu am9objpjaGFuZ2VtZSA =” \
https://europe.ipx.com/restapi/v1/sms/send \
–ʻikepili “destinationAddress=46123456789&messageText=Aloha+World%21”
_______________
Hoʻololi i nā kamaʻilio pilikino
Palapala / Punawai
 |
LINK Mobility Implementation Guide REST API SMS [pdf] Ke alakaʻi hoʻohana Alakaʻi hoʻokō kaʻa REST API SMS, Mobility, alakaʻi hoʻokō REST API SMS, REST API SMS, API SMS, SMS |
