LINK Mobilitas Implementasi Guide REST API SMS
LINK Mobility nyedhiyakake layanan kanggo pangiriman pesen, pembayaran mikro, lan layanan basis lokasi. Platform kasebut minangka panyedhiya konten label putih transparan lan dalan transaksi antarane Panyedhiya Layanan lan Operator.
LINK Mobility nyedhiyakake API RESTful sing bisa digunakake kanggo ngakses layanan LINK Mobility kayata ngirim SMS. API iki dirancang supaya gampang digunakake lan kompatibel karo kabeh basa lan kerangka kerja modern. Nggunakake basa sing dipilih, aplikasi sampeyan bisa nggunakake Link Mobility REST API kanggo ngetrapake kemampuan olahpesen lan pembayaran sing kuat
© LINK Mobilitas, 10 Maret 2021
Informasi Hukum
Informasi sing diwenehake ing dokumen iki minangka properti tunggal lan hak cipta Netsize. Iku rahasia lan dimaksudaké kanggo nggunakake strictly informasi. Iku ora naleni lan bisa tundhuk owah-owahan tanpa kabar. Sembarang pambocoran utawa panggunaan sing ora sah bakal dianggep ora sah.
Netsize™ lan linkmobility™ dilindhungi dening hukum properti intelektual Prancis, EEC lan internasional.
Kabeh merek dagang liyane sing dikutip minangka properti tunggal sing nduweni.
Ora ana sing ana ing kene sing bakal dianggep minangka menehi lisensi utawa hak miturut paten Netsize, hak cipta, utawa merek dagang.
NETSIZE
Société anonyme au capital de 5 478 070 euro
Siège sosial :62, avenue Emile Zola92100 Boulogne – France
418 712 477 RCS Nanterre
http://www.LinkMobility.com
http://www.linkmobility.com
Lingkup Dokumen
Dokumen iki nerangake carane Panyedhiya Layanan nggunakake LINK Mobility REST API kanggo SMS. Iki ditrapake kanggo arsitek teknis lan desainer sing ngetrapake layanan saka Panyedhiya Layanan.
1. Panggunaan dhasar
Iku gampang banget kanggo ngirim SMS. Sampeyan ngirim panjalukan HTTP menyang LINK Mobility sing bisa ditindakake mung nggunakake a web browser.
2. Fungsional Overview
Sistem LINK Mobility nyedhiyakake fungsi dhasar ing ngisor iki kanggo pesen SMS:
Ngirim pesen SMS Mobile Terminated (MT), kayata teks utawa binar (eg WAP Push) premium lan pesen tarif standar.
Nampa laporan pangiriman kanggo pesen MT sing dikirim.
Nampa pesen SMS Mobile Originated (MO), premium lan tarif standar.
SMS REST API dikhususake kanggo ngirim pesen SMS MT tarif standar.
API ngirim kabeh pesen SMS asynchronous, mbisakake fitur kayata:
"Fire-and-forget" - Panyedhiya Layanan pengin duwe wektu respon sing bisa diprediksi lan ora pengin ngenteni asil saka Operator.
Coba maneh fungsi - LINK Mobilitas bakal ngirim pesen maneh yen Operator duwe masalah sementara.
2.1 Ngirim pesen SMS
Service Provider Netsize Konsumen
- Kirim pesen MT
- ID pesen bali
- Kirim pesen SMS
- Ngirim laporan pangiriman
- Kirim laporan pangiriman
Alur dhasar kanggo ngirim pesen SMS diterangake kaya ing ngisor iki:
Panyedhiya Layanan nggawe panjalukan kanggo ngirim pesen SMS menyang panampa liwat sistem LINK Mobility.
ID pesen bali menyang Panyedhiya Layanan. ID iki bisa digunakake kanggo umpamane nggandhengake pesen karo laporan pangiriman sing bener.
LINK Mobility nangani rute lan ngirim pesen SMS menyang Konsumen sing dituju.
Laporan pangiriman dipicu, contone, nalika pesen SMS dikirim menyang piranti Konsumen.
Laporan pangiriman dikirim menyang Panyedhiya Layanan. Laporan kasebut ngemot ID pesen sing padha karo sing bali ing langkah 2.
Aliran alternatif: Panyuwunan ora sah
Yen parameter sing diwenehake utawa kredensial pangguna ing panyuwunan ora sah, kesalahan bakal bali menyang Panyedhiya Layanan. Kesalahan nuduhake alasan penolakan lan aliran rampung. Ora ana ID pesen sing bali.
3. Titik pungkasan
Sumber daya SMS diakses nggunakake path:
/restapi/v1/sms
Example URL
https://europe.ipx.com/restapi/v1/sms
Kanggo keamanan sambungan, LINK Mobility REST API mung bisa diakses liwat HTTPS.
Sertifikat Link Mobility server ditandatangani dening Thawte Server CA.
4. Operasi
Layanan SMS nyedhiyakake operasi ing ngisor iki:
| jeneng | Path |
| Ngirim | /restapi/v1/sms/send |
4.1 Ngirim
Operasi kirim digunakake kanggo ngirim SMS menyang panampa siji.
Operasi iki ditrapake kanggo pangguna dhasar lan lanjut. Ing kasus sing paling gampang, mung alamat tujuan, lan teks pesen sing dibutuhake kanggo ngirim SMS. LINK Mobility bakal ndeteksi Skema Coding Data lan nindakake concatenation otomatis pesen menyang sawetara bagean pesen yen perlu.
Kanggo panggunaan lanjut, Panyedhiya Layanan bisa nggunakake parameter opsional kanggo kontrol total format pesen kalebu header data pangguna.
Service Provider bisa ngirim pesen concatenated, nanging preparation saka data pangguna lan data pangguna header kudu digawe dening Service Provider lan pesen kudu dikirim liwat macem-macem panjalukan kirim menyang LINK Mobility.
5. Authentication
Jeneng pangguna lan sandhi dikirim ing saben panjalukan nggunakake Skema Otentikasi Dasar HTTP.
https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA
Kredensial dikirim ing header Wewenang ing panjalukan HTTP. Klien mbangun kolom header kaya sing diterangake ing kene:
https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side
Kanggo example, yen jeneng panganggo john lan changeme minangka tembung sandhi banjur header Wewenang sing diasilake yaiku:
Wewenang: Dasar am9objpjaGFuZ2VtZSA=
Minangka mundur, jeneng pangguna lan sandhi bisa diajukake minangka paramèter panyuwunan. Iki mung dianjurake kanggo klien sing ora ndhukung Auth Dasar.
6. Ngajokake panjaluk
6.1 Pitakonan string
Parameter panjalukan dikirim minangka string pitakon sing ngemot pasangan jeneng/nilai. String pitakon dienkode nggunakake Percent Encoding (URL enkoding).
http://www.w3schools.com/tags/ref_urlencode.asp
Kanggo example, Hello World! dienkode minangka Hello+World%21.
6.2 Parameter panyuwunan wajib
| jeneng | dawa maksimum | Katrangan |
| alamat tujuan | 40 | MSISDN sing ngirim pesen SMS, diwiwiti karo kode negara. Exampnomer: 46123456789. Kanggo sawetara pasar (ing ngendi Konsumen MSISDN kudu obfuscated) nilai iki uga bisa dadi alias alfanumerik, prefixed karo "#". |
| pesenTeks | 1600 | Isi pesen SMS. |
6.3 Parameter panyuwunan opsional (kanggo panggunaan lanjutan)
| jeneng | dawa maksimum | Katrangan |
| asaleAlamat | 16 | Alamat asal kanggo pesen SMS sing metu. Jinis alamat asal ditetepake dening parameter originatorTON. Panjang maksimal nomer cendhak yaiku 16. Pangirim angka alfa diwatesi ing Alfabet standar GSM kanthi dawa maksimal 11 karakter. Panjang maksimal pangirim MSISDN yaiku 15 (nggunakake format sing padha karo unsur destinationAddress). Bisa diilangi nalika originatingAlamat lan originatingTON dipilih dening sistem. Fungsi iki gumantung pasar lan konfigurasi. Prilaku bisa beda-beda karo integrasi Operator. |
| panggagasTON | 1 | Tipe nomer alamat asal (TON): 0 - Nomer singkat 1 – Angka alfa (panjang maksimal 11) 2 – MSISDN Bisa diilangi nalika originatingAlamat lan originatingTON bakal dipilih dening sistem. Fungsi iki gumantung pasar lan konfigurasi. Prilaku bisa beda-beda karo integrasi Operator. |
| userDataHeader | 280 | Header Data pangguna bebarengan karo Data pangguna bisa ngemot nganti 140, yaiku 280 nalika dienkode hex, oktet. Parameter iki tansah dienkode hex. |
| DCS | 3 | Skema kode data. Prilaku bisa beda-beda karo integrasi Operator. |
| PID | 3 | ID Protokol. Prilaku bisa beda-beda karo integrasi Operator. |
| relatifValidityTime | 6 | Wektu validitas relatif ing detik (relatif karo wektu kanggo ngirim menyang LINK Mobilitas). Nilai maksimal yaiku 604800 (7 dina) lan standar yaiku 48 jam. Prilaku bisa beda-beda karo integrasi Operator. |
| wektu pangiriman | 20 | Waktosamp nalika pesen SMS kudu dikirim (wektu pangiriman telat). Waca bagean ing format tanggal wektu. |
| statusReportFlags | 1 | Kirimake panjalukan laporan: 0 - Ora ana laporan pangiriman (standar) 1 - Laporan pangiriman dijaluk 9 - Laporan pangiriman server dijaluk (LINK Mobilitas ora nerusake laporan menyang Panyedhiya Layanan nanging kasedhiya ing laporan lsp.) |
| campaignName | 50 | Transaksi LINK Mobilitas yaiku tagged karo jeneng iki. Iki digunakake kanggo ngelompokake transaksi ing laporan Link Mobility. |
| maxConcatenatedMessages | 1 | Nilai antarane 1 lan 10 sing nemtokake jumlah pesen concatenated sing diijini. Default yaiku 3. |
| korelasiId | 100 | ID sing diwenehake dening Panyedhiya Layanan sing bakal digarap ing Laporan Pangiriman. |
| jeneng panganggo | 100 | Kasedhiya minangka alternatif kanggo Otentikasi Dasar HTTP. |
| sandi | 100 | Kasedhiya minangka alternatif kanggo Otentikasi Dasar HTTP. |
6.4 Metode Request HTTP
Kanggo interoperabilitas maksimal, API ndhukung metode panjalukan HTTP GET lan POST. Ora ana cara HTTP liyane sing diidini.
6.4.1 GET
String pitakon sing dienkode ditambahake menyang URL.
GET
https://europe.ipx.com/restapi/v1/sms/send?destinationAddress=461234
56789&messageText=Hello+World%21
Wewenang: Dasar am9objpjaGFuZ2VtZSA=
6.4.2 POST
String pitakon sing dienkode dikirim ing awak pesen panjalukan HTTP. Tipe-Konten yaiku aplikasi/x-www-form-urldienkode.
POST https://europe.ipx.com/restapi/v1/sms/send
Host: europe.ipx.com
Jinis Konten: aplikasi / x-www-form-urldienkode
Wewenang: Dasar am9objpjaGFuZ2VtZSA=
Dawane isi: 57
destinationAddress=46123456789&messageText=Halo+World%21
6.5 Tanggal lan wektu
Parameter ing API REST sing makili tanggal lan wektu mesthi ana ing zona wektu UTC (Waktu Universal Terkoordinasi). Wektuamps dituduhake minangka senar kanthi format sing tepat:
2017-04-25T23:20:50Z
Iki nuduhake 20 menit lan 50 detik sawise jam 23 tanggal 25 April 2017 ing UTC.
7. Pesen tanggapan
Sawise nampa lan nerjemahake pesen panjalukan API nanggapi karo pesen respon HTTP.
7.1 Kode status HTTP
API REST tansah ngasilake kode status HTTP 200 OK kanggo panjalukan sing diproses. Awak pesen ngemot kode respon parameter sing digunakake kanggo nemtokake asil sing tepat.
7.2 Isi pesen
Badan pesen kasusun saka JSON sing njlèntrèhaké asil panjalukan.
http://json.org/
Link Mobility JSON tundhuk karo Google JSON Style Guide.
https://google.github.io/styleguide/jsoncstyleguide.xml
7.3 Paramèter respon
| jeneng | dawa maksimum | Katrangan |
| kode respon | 3 | 0 nuduhake transaksi sukses. |
| responPesen | 255 | Deskripsi teks tanggapan, contone teks kesalahan. |
| kapingamp | 20 | Tanggal & wektu nalika LINK Mobility ngolah panjaluk kasebut. (Deleng bagean format tanggal / wektu). |
| traceId | 36 | Pengenal internal Link Mobilitas. Digunakake kanggo dhukungan lan ngatasi masalah. |
| messageId | 10 x 36 | Array ID pesen unik LINK Mobility kanggo saben pesen sing sukses (kaping pirang-pirang ID pesen bakal bali yen pesen kasebut digabung). Dibuwang yen gagal. |
7.4 Kelample tanggapan
Sukses
HTTP / 1.1 200 OK
Tipe Konten: application/json
Dawane isi: 144
Tanggal: Kamis, 15 Sep 2016 13:20:31 GMT
{"Kode tanggapan":0,"responseMessage":"Sukses","timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Mangkene format JSON sing padha supaya bisa diwaca:
{
“kode respon": 0,
“responPesen":"Sukses",
“kapingamp“:”2016-0915T13:20:31Z”,
“traceId“:”f678d30879fd4adc25f2”,
“messageId":["1-4850879008"] }
Gagal
HTTP / 1.1 200 OK
Tipe Konten: application/json
Dawane isi: 148
Tanggal: Kamis, 15 Sep 2016 13:20:31 GMT
{"Kode tanggapan": 1,"responseMessage":" Login ora sah utawa panggunaan API sing ora sah","timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
Sukses
HTTP / 1.1 200 OK
Tipe Konten: application/json
Dawane isi: 144
Tanggal: Kamis, 15 Sep 2016 13:20:31 GMT
{"Kode tanggapan":0,"responseMessage":"Sukses","timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Mangkene format JSON sing padha supaya bisa diwaca:
{
“kode respon": 0,
“responPesen":"Sukses",
“kapingamp“:”2016-0915T13:20:31Z”,
“traceId“:”f678d30879fd4adc25f2”,
“messageId":["1-4850879008"] }
Gagal
HTTP / 1.1 200 OK
Tipe Konten: application/json
Dawane isi: 148
Tanggal: Kamis, 15 Sep 2016 13:20:31 GMT
{"Kode tanggapan": 1,"responseMessage":" Login ora sah utawa panggunaan API sing ora sah","timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
7.5 Kode respon
Kode respon ing ngisor iki bisa bali ing respon kirim:
| Kode | Teks | Katrangan |
| 0 | Sukses | Kasil dieksekusi. |
| 1 | Login ora sah utawa panggunaan API sing ora sah | Jeneng pangguna utawa sandhi sing salah utawa Panyedhiya Layanan dilarang dening LINK Mobility. |
| 2 | Konsumen diblokir dening Link Mobility | Konsumen diblokir dening LINK Mobility. |
| 3 | Operasi ora diwenehake dening LINK Mobility | Operasi diblokir kanggo Panyedhiya Layanan. |
| 4 | Konsumen ora dingerteni LINK Mobility | Konsumen ora dingerteni kanggo LINK Mobility. Utawa yen alias digunakake ing panjalukan; alias ora ketemu. |
| 5 | Konsumen wis mblokir layanan iki ing LINK Mobility | Konsumen wis mblokir layanan iki ing LINK Mobility. |
| 6 | Alamat asal ora didhukung | Alamat asal ora didhukung. |
| 7 | Alamat asal Alpha ora didhukung dening akun | Alamat asal alpha ora didhukung dening akun. |
| 8 | Alamat asal MSISDN ora didhukung | Alamat asal MSISDN ora didhukung. |
| 9 | GSM ditambahi ora didhukung | GSM ditambahi ora didhukung. |
| 10 | Unicode ora didhukung | Unicode ora didhukung. |
| 11 | Laporan status ora didhukung | Laporan status ora didhukung. |
| 12 | Kapabilitas sing dibutuhake ora didhukung | Kapabilitas sing dibutuhake (liyane saka ndhuwur) kanggo ngirim pesen ora didhukung. |
| 13 | Tingkat throttling maksimal panyedhiya konten wis ngluwihi | Panyedhiya Layanan ngirim pesen SMS menyang LINK Mobility cepet banget. |
| 14 | ID Protokol ora didhukung dening akun | ID Protokol ora didhukung. |
| 15 | watesan concatenation pesen ngluwihi | Jumlah pesen sing digabung ngluwihi nomer maksimal sing dijaluk. |
| 16 | Ora bisa nuntun pesen. | LINK Mobilitas ora bisa nuntun pesen kasebut. |
| 17 | Periode wektu sing dilarang | Ora diijini ngirim pesen sajrone wektu |
| 18 | Imbangan banget ing akun panyedhiya layanan | Panyedhiya layanan diblokir amarga imbangan banget |
| 50 | Sukses sebagean | Sukses sebagian nalika ngirim pesen SMS menyang sawetara panampa. |
| 99 | kesalahan server internal | Kesalahan Link Mobility liyane, hubungi dhukungan LINK Mobility kanggo informasi luwih lengkap. |
| 100 | Alamat tujuan ora valid | Alamat tujuan (MSISDN, utawa alias) ora sah. |
| 102 | ID referensi (disambung) ora valid | ID referensi ora valid, bisa uga ID referensi wis digunakake, lawas banget utawa ora dingerteni. |
| 103 | Jeneng akun ora valid | Jeneng akun ora sah. |
| 105 | Data meta layanan ora valid | Data meta layanan ora sah. |
| 106 | Alamat asal ora valid | Alamat asal ora sah. |
| 107 | Alamat asal alfanumerik ora valid | Alamat asli alfanumerik ora valid. |
| 108 | Wektu validitas ora valid | Wektu validitas ora sah. |
| 109 | Wektu pangiriman ora bener | Wektu pangiriman ora sah. |
| 110 | Isi pesen/data pangguna ora valid | Data pangguna, yaiku pesen SMS, ora valid. |
| 111 | Dawane pesen ora valid | Dawane pesen SMS ora sah. |
| 112 | Header data pangguna ora valid | Header data pangguna ora valid. |
| 113 | Skema kode data ora valid | DCS ora sah. |
| 114 | ID protokol ora valid | PID ora sah. |
| 115 | Gendéra laporan status ora valid | Gendéra laporan status ora sah. |
| 116 | TON ora sah | TON pemula ora sah. |
| 117 | Ora sah campjeneng aign | Ing campjeneng aign ora sah. |
| 120 | Watesan ora sah kanggo jumlah maksimal pesen sing digabung | Jumlah maksimum pesen gabungan ora sah. |
| 121 | Alamat asal msisdn ora valid | Alamat asal MSISDN ora valid. |
| 122 | ID korélasi ora valid | ID korélasi ora sah. |
8. Fitur opsional
8.1 Koreksi MSISDN
Koreksi MSISDN minangka fitur opsional sing bisa diaktifake kanthi dhukungan LINK Mobility yen dijaluk.
Fitur iki bakal mbenerake alamat tujuan lan nyelarasake menyang format E.164 sing dibutuhake. Saliyane koreksi format, sistem uga bisa nindakake fungsi khusus pasar kayata nerjemahake nomer Prancis internasional kanggo mbenerake nomer DOM-TOM (départements et territoires d'outre-mer) yen ditrapake.
Ing ngisor iki sawetara mantanampkoreksi:
| Alamat Tujuan sing dikirim | Alamat Tujuan sing didandani |
| +46(0)702233445 | 46702233445 |
| (0046)72233445 | 46702233445 |
| +460702233445 | 46702233445 |
| 46(0)702233445 | 46702233445 |
| 46070-2233445 | 46702233445 |
| 0046702233445 | 46702233445 |
| +46(0)702233445aaa | 46702233445 |
| 336005199999 | 2626005199999 (Nomer Prancis diterjemahake menyang nomer DOM-TOM) |
Kajaba iku, bisa uga ngidini nomer telpon nasional kanggo pasar sing dipilih. Nalika fitur iki diaktifake, nomer internasional kanggo pasar liyane kudu dikirim kanthi tandha `+' dhisikan kanggo mbedakake saka pasar sing dipilih.
Ing ngisor iki sawetara exampkoreksi sing ditindakake nalika nggunakake Swedia (kode negara 46) minangka pasar standar kanggo nomer nasional.
| Alamat Tujuan sing dikirim | Alamat Tujuan sing didandani |
| 0702233445 | 46702233445 |
| 070-2233 445 | 46702233445 |
| 070.2233.4455 | 46702233445 |
| 460702233445 | 46702233445 |
| +460702233445 | 46702233445 |
| +458022334455 | 458022334455 |
| 45802233445 | Ora sah amarga tandha '+' ora ana |
Elinga yen MSISDN sing wis didandani bakal digunakake dening LINK Mobility lan bakal dibalekake ing laporan pangiriman.
Hubungi dhukungan LINK Mobility kanggo informasi luwih lengkap.
8.2 Panggantos aksara
Panggantos karakter minangka fitur opsional sing bisa diaktifake kanthi dhukungan LINK Mobility yen dijaluk.
Fitur iki bakal nerjemahake karakter alfabet non-GSM ing data pangguna (teks SMS) dadi karakter alfabet GSM sing padha nalika DCS disetel dadi "GSM" (17). Kanggo example "Seqüência de teste em Português" bakal diterjemahake dadi "Seqüencia de teste em Portugues".
9. Laporan pangiriman
Panyedhiya Layanan bisa, yen diwenehake, njaluk laporan pangiriman pesen SMS utawa kabar pangiriman kanggo pesen MT sing dikirim. Laporan kasebut dipicu ing Operator SMSC nalika pesen MT dikirim menyang Konsumen sing ditargetake utawa dibusak, contone, kadaluwarsa utawa, sakperangan alesan, ora bisa dirute.
Mung status pungkasan pesen SMS sing dilaporake menyang Panyedhiya Layanan, yaiku, dikirim utawa dibusak. Mung siji laporan saben pesen MT digawe. Kanthi status sing wis dibusak, kode alesan bisa ditrapake. Kode alesan iki nemtokake alesan kanggo pesen SMS ora dikirim.
Laporan kasebut diarahake liwat LINK Mobility lan dikirim menyang Panyedhiya Layanan nggunakake protokol HTTP.
Kanggo nampa laporan, Service Provider kudu ngleksanakake kanggo example a Java Servlet utawa kaca ASP.NET. Loro-lorone nampa panjalukan HTTP GET utawa POST.
Paramèter
Panjaluk kasebut kalebu paramèter ing ngisor iki:
| Paramèter | Jinis | M/O/I* | Nilai Default | dawa maksimum | Katrangan |
| PesenId | senar | M | – | 22 | ID pesen pesen MT sing cocog karo laporan iki. |
| Alamat tujuan | senar | M | – | 40 | MSISDN Konsumen, yaiku alamat tujuan pesen MT asli. |
| Kode Status | integer | M | 1 | Kode status nuduhake status pesen MT. Kode status sing ditrapake yaiku: 0 - Dikirim 2 - Dibusak (kode alasan ditrapake) |
|
| WektuStamp | senar | M | – | 20 | Wektu sing nuduhake nalika laporan pangiriman ditampa dening LINK Mobility. Zona wektu wektuamp yaiku CET utawa CEST (kanthi wektu panas kaya sing ditetepake kanggo EU). Format: yyyyMMdd HH:mm:ss. |
| Operator | senar | M | – | 100 | Jeneng Operator sing digunakake nalika ngirim pesen SMS utawa jeneng akun sing digunakake nalika ngirim pesen SMS. Dhaptar Operator sing kasedhiya diwenehake dening dhukungan LINK Mobility. |
| Kode Alasan | integer | O | – | 3 | Kode alesan nuduhake apa pesen rampung ing status dibusak. Kode alasan sing ditrapake yaiku: 100 - Kadaluwarsa 101 – Ditolak 102 - Kesalahan format 103 - Kesalahan liyane 110 - Subscriber ora dingerteni 111 - Subscriber dilarang 112 - Pelanggan ora diwenehake 113 - Pelanggan ora kasedhiya 120 - Gagal SMSC 121 – SMSC rame 122 – SMSC roaming 130 - Kesalahan handset 131 - Memori handset ngluwihi Prilaku bisa beda-beda karo integrasi Operator. |
| OperatorTimeStamp | senar | O | – | 20 | Wektu sing nuduhake nalika laporan kasebut dipicu ing SMSC Operator (yen diwenehake dening Operator). Zona wektu wektuamp yaiku CET utawa CEST (kanthi wektu panas kaya sing ditetepake kanggo EU). Format: yyyyMMdd HH:mm:ss. |
| StatusTeks | senar | O | – | 255 | Placeholder kanggo informasi tambahan saka Operator, contone katrangan teks cetha status/alesan. Prilaku bisa beda-beda karo integrasi Operator. |
| KorelasiId | senar | O | – | 100 | ID korelasi sing kasedhiya ing SendRequest utawa SendTextRequest. |
| Kode Jaringan Operator | integer | O | – | 6 | Kode Jaringan Seluler (MCC + MNC) saka Operator. |
* M = Wajib, O = Opsional, I = Digatekake.
Panyedhiya Layanan kudu nyedhiyakake LINK Mobilitas kanthi target URL kanggo laporan pangiriman (opsional kalebu kredensial kanggo otentikasi dhasar HTTP). Panyedhiya Layanan bisa milih cara HTTP sing disenengi:
HTTP POST (disaranake)
HTTP GET.
Exampnggunakake HTTP GET (kasil dikirim):
https://user:password@www.serviceprovider.com/receivereport?%20MessageId=122&DestinationAddress=46762050312&Operator=Vodafone&TimeStamp=20100401%2007%3A47%3A44&StatusCode=0
Example nggunakake HTTP GET (ora dikirim, Operator wis nyedhiyakake kapingamp kanggo acara):
Paramèter kasebut yaiku URL encodedi.
Encoding karakter:
Panyedhiya Layanan bisa milih enkoding karakter sing disenengi:
UTF-8 (dianjurake)
ISO-8859-1.
9.1 Pengakuan Panyedhiya Layanan
Panyedhiya Layanan kudu ngakoni saben laporan pangiriman. Pengakuan kasebut bisa positif, yaiku laporan kiriman kasil ditampa, utawa negatif, yaiku gagal.
Wigati dicathet: LINK Mobility duwe wektu entek maca kanggo 30 detik kanggo laporan pangiriman. Wektu entek bakal micu kiriman maneh (yen nyoba maneh diaktifake) utawa mbatalake pangiriman (yen nyoba maneh dipateni). Iki tegese aplikasi Panyedhiya Layanan kudu njamin wektu nanggepi cepet, utamane nalika mbukak akeh.
Apike banget kanggo ngakoni laporan pangiriman menyang LINK Mobility sadurunge ngolah.
Aturan kanggo ngakoni positif lan negatif diterangake kaya ing ngisor iki:
Pengakuan positif, ACK, laporan pangiriman dikirim:
Kode respon kisaran HTTP 200 kanthi kombinasi karo konten format XML ing ngisor iki:
Pengakuan negatif, NAK, laporan pangiriman ora dikirim:
Sembarang balesan liyane saka pengakuan positif, contoneampNanging, pengakuan negatif dipicu dening kode kesalahan HTTP utawa konten XML ing ngisor iki:
Konten XML bisa digunakake kanggo ngontrol mekanisme nyoba maneh LINK Mobility. A NAK bakal nyebabake nyoba maneh, yen diaktifake. Kanggo Service Provider ora dikonfigurasi kanggo mekanisme nyoba maneh, isi XML iku opsional.
Ing ngisor iki minangka panjalukan lan respon HTTP POSTampsaka laporan pangiriman sing dikirim menyang Panyedhiya Layanan:
Panjaluk HTTP:
POST /konteks/app HTTP/1.1
Jinis Konten: aplikasi / x-www-form-urldikodekan;charset=utf-8
Host: server: port
Dawane isi: xx
MessageId=213123213&DestinationAddress=46762050312&Operator=Telia& OperatorTimeStamp=20130607%2010%3A45%3A00&TimeStamp=20130607%2010%3A 45%3A02&StatusCode=0
Tanggapan HTTP:
HTTP / 1.1 200 OK
Jinis-isi: teks / polos
9.2 Coba maneh
Sistem LINK Mobility bisa nindakake nyoba maneh kanggo gagal, yaiku ora diakoni, pangiriman laporan pangiriman. Panyedhiya Layanan bisa milih prilaku nyoba maneh sing disenengi:
Ora nyoba maneh (standar) - pesen bakal dibuwak yen nyoba sambungan gagal, maca wektu entek utawa kanggo kode kesalahan HTTP.
Coba maneh - pesen kasebut bakal dikirim kanggo saben jinis masalah sambungan, wektu entek maca, utawa ngakoni negatif.
Nalika nyoba maneh NAK diaktifake, iku penting kanggo ngerti skenario sing bakal generate nyoba maneh saka LINK Mobility lan carane nyoba maneh bisa. Saben Panyedhiya Layanan duwe antrian nyoba maneh dhewe, ing ngendi pesen dipesen miturut wektu pesenamp. Link Mobility tansah nyoba ngirim pesen lawas luwih dhisik, sanajan urutan pesen individu sing dikirim menyang Panyedhiya Layanan ora dijamin. Alesan utama pesen sing dibuwang saka antrian nyoba maneh yaiku salah siji saka rong alasan: pesen TTL kadaluwarsa utawa (secara teoritis) antrian nyoba maneh dadi kebak. TTL iku Operator lan gumantung akun, yaiku, bisa beda-beda gumantung saka Operator lan utawa jinis pesen, contone, SMS premium utawa pesen SMS tarif standar.
Panyedhiya Layanan kanthi nyoba maneh kudu mriksa ID unik pesen MT kanggo ngamanake manawa pesen kasebut durung ditampa.
Penting kanggo Service Provider kanggo tundhuk karo aturan prasaja iki nalika ana kesalahan sak Processing saka laporan pangiriman yen alesan kanggo kesalahan punika: Sauntara, contone, database ora kasedhiya, NAK kudu bali. LINK Mobilitas bakal ngirim pesen maneh.
Permanen lan nyoba maneh bisa nyebabake masalah sing padha, ACK kudu dibalekake. Kanggo example, nalika pesen ora bisa diurai kanthi bener utawa nyebabake kesalahan runtime sing ora dikarepke.
Tumindak sing cocog bakal mesthekake yen ora ana pamblokiran utawa degradasi throughput amarga laporan pangiriman bola-bali.
10. Tips implementasine
1. Sampeyan bisa nggunakake Panjenengan web browser kanggo ngirim panjalukan kanggo API. Iki nggawe gampang banget kanggo njelajah lan ngevaluasi layanan tanpa alat pangembangan.
2. Chrome utawa Firefox dianjurake bebarengan karo ekstensi kayata JSONView kanggo nampilake JSON sing diformat kanthi apik.
3. Kita wis nggunakake SoapUI kanggo nguji POST, Otentikasi Dasar lan kanggo mriksa panjalukan HTTP mentah lan pesen respon.
4. Ing cURL alat migunani kanggo ngirim panjalukan POST karo Otentikasi Dasar. Ndeleng mantanample ngisor.
curl POST \
-H "Tipe-Konten: application/x-www-form-urldikodekan"\
-H "Wewenang: Dasar am9objpjaGFuZ2VtZSA=" \
https://europe.ipx.com/restapi/v1/sms/send \
–data “destinationAddress=46123456789&messageText=Hello+World%21”
_______________
Ngowahi Komunikasi Pribadi
Dokumen / Sumber Daya
 |
LINK Mobilitas Implementasi Guide REST API SMS [pdf] Pandhuan pangguna Panduan Implementasi Mobilitas REST API SMS, Mobilitas, Panduan Implementasi REST API SMS, REST API SMS, API SMS, SMS |
