Panduan Implementasi Mobilitas LINK REST API SMS
LINK Mobility menyediakan layanan untuk pengiriman pesan, pembayaran mikro, dan layanan berbasis lokasi. Platform ini bertindak sebagai pengakuisisi konten berlabel putih yang transparan dan router transaksi antara Penyedia Layanan dan Operator.
LINK Mobility menyediakan RESTful API yang dapat digunakan untuk mengakses layanan LINK Mobility seperti mengirim SMS. API ini dirancang agar mudah digunakan dan kompatibel dengan semua bahasa dan kerangka kerja modern. Dengan menggunakan bahasa pilihan Anda, aplikasi Anda dapat menggunakan Link Mobility REST API untuk menerapkan kemampuan pengiriman pesan dan pembayaran yang canggih.
© LINK Mobility, 10 Maret 2021
Informasi Hukum
Informasi yang diberikan dalam dokumen ini adalah milik dan hak cipta Netsize. Informasi ini bersifat rahasia dan ditujukan untuk penggunaan informasi semata. Informasi ini tidak mengikat dan dapat berubah sewaktu-waktu tanpa pemberitahuan. Setiap pengungkapan atau penggunaan yang tidak sah akan dianggap melanggar hukum.
Netsize™ dan linkmobility™ dilindungi oleh undang-undang kekayaan intelektual Prancis, EEC, dan internasional.
Semua merek dagang lain yang dikutip merupakan hak milik tunggal dari pemiliknya masing-masing.
Tidak ada yang tercantum di sini yang boleh ditafsirkan sebagai pemberian lisensi atau hak apa pun berdasarkan paten, hak cipta, atau merek dagang Netsize.
UKURAN BERSIH
Société anonime au capital de 5 478 070 euro
Pengepungan sosial :62, jalan Emile Zola92100 Boulogne – Prancis
418 712 477 RCS Nanterre
http://www.LinkMobility.com
http://www.linkmobility.com
Lingkup Dokumen
Dokumen ini menjelaskan cara Penyedia Layanan menggunakan LINK Mobility REST API untuk SMS. Dokumen ini ditujukan untuk arsitek dan desainer teknis yang mengimplementasikan layanan Penyedia Layanan.
1. Penggunaan Dasar
Sangat mudah untuk mengirim SMS. Anda mengirim permintaan HTTP ke LINK Mobility yang dapat dilakukan hanya dengan web peramban.
2. Fungsional Berakhirview
Sistem Mobilitas LINK menyediakan fungsionalitas dasar berikut untuk pesan SMS:
Mengirim pesan SMS Mobile Terminated (MT), seperti teks atau biner (misalnya WAP Push) dengan tarif premium dan standar.
Menerima laporan pengiriman untuk pesan MT yang dikirimkan.
Menerima pesan SMS Asal Seluler (MO), tarif premium dan standar.
SMS REST API diperuntukkan untuk mengirim pesan SMS MT dengan tarif standar.
API mengirimkan semua pesan SMS secara asinkron, mengaktifkan fitur-fitur seperti:
“Tembak-dan-lupakan” – Penyedia Layanan menginginkan waktu respons yang lebih dapat diprediksi dan tidak ingin menunggu hasil dari Operator.
Fungsi coba lagi – LINK Mobility akan mengirim ulang pesan jika Operator mengalami masalah sementara.
2.1 Mengirim pesan SMS
Penyedia Layanan Netsize Konsumen
- Kirim pesan MT
- Kembalikan ID pesan
- Kirim pesan SMS
- Kirim laporan pengiriman
- Kirim laporan pengiriman
Alur dasar untuk mengirim pesan SMS dijelaskan sebagai berikut:
Penyedia Layanan membuat permintaan untuk mengirim pesan SMS ke penerima melalui sistem LINK Mobility.
ID pesan dikembalikan ke Penyedia Layanan. ID ini dapat digunakan untuk misalnya menghubungkan pesan dengan laporan pengiriman yang benar.
LINK Mobility menangani perutean dan mengirimkan pesan SMS ke Konsumen yang dituju.
Laporan pengiriman dipicu, misalnya ketika pesan SMS terkirim ke perangkat Konsumen.
Laporan pengiriman dikirim ke Penyedia Layanan. Laporan tersebut berisi ID pesan yang sama seperti yang dikembalikan pada langkah 2.
Aliran alternatif: Permintaan tidak valid
Jika parameter atau kredensial pengguna yang diberikan dalam permintaan tidak valid, kesalahan akan dikembalikan ke Penyedia Layanan. Kesalahan menunjukkan alasan penolakan dan alur berakhir. Tidak ada ID pesan yang dikembalikan.
3. Titik akhir
Sumber daya SMS diakses menggunakan jalur:
/restapi/v1/sms
Example URL
https://europe.ipx.com/restapi/v1/sms
Untuk keamanan koneksi, LINK Mobility REST API hanya dapat diakses melalui HTTPS.
Sertifikat server Link Mobility ditandatangani oleh Thawte Server CA.
4. Operasi
Layanan SMS menyediakan operasi berikut:
| Nama | Jalur |
| Mengirim | /restapi/v1/sms/kirim |
4.1 Kirim
Operasi kirim digunakan untuk mengirim SMS ke satu penerima.
Operasi ini ditujukan untuk pengguna dasar dan lanjutan. Dalam kasus yang paling sederhana, hanya alamat tujuan dan teks pesan yang diperlukan untuk mengirimkan SMS. LINK Mobility akan mendeteksi Skema Pengodean Data dan melakukan penggabungan otomatis pesan menjadi beberapa bagian pesan jika diperlukan.
Untuk penggunaan tingkat lanjut, Penyedia Layanan dapat menggunakan parameter opsional untuk kontrol total terhadap pemformatan pesan termasuk tajuk data pengguna.
Penyedia Layanan dapat mengirim pesan yang dirangkai, tetapi penyiapan data pengguna dan header data pengguna harus dilakukan oleh Penyedia Layanan dan pesan harus dikirim melalui beberapa permintaan kirim ke LINK Mobility.
5. Autentikasi
Nama pengguna dan kata sandi dikirimkan dalam setiap permintaan menggunakan Skema Autentikasi Dasar HTTP.
https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA
Kredensial dikirim dalam header Otorisasi dalam permintaan HTTP. Klien membuat kolom header seperti yang dijelaskan di sini:
https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side
Misalnyaample, jika nama pengguna adalah john dan changeme adalah kata sandinya maka header Otorisasi yang dihasilkan adalah:
Otorisasi: Dasar am9objpjaGFuZ2VtZSA=
Sebagai cadangan, nama pengguna dan kata sandi dapat dikirimkan sebagai parameter permintaan. Ini hanya disarankan untuk klien yang tidak mendukung Basic Auth.
6. Mengajukan permintaan
6.1 String kueri
Parameter permintaan dikirimkan sebagai string kueri yang berisi pasangan nama/nilai. String kueri dikodekan menggunakan Pengkodean Persen (URL pengkodean).
http://www.w3schools.com/tags/ref_urlencode.asp
Misalnyaample, Hello World! dikodekan sebagai Hello+World%21.
6.2 Parameter permintaan wajib
| Nama | Panjang maksimal | Keterangan |
| alamat tujuan | 40 | MSISDN yang akan dikirimi pesan SMS, dimulai dengan kode negara.ampl: 46123456789. Untuk beberapa pasar (di mana MSISDN Konsumen harus dikaburkan), nilai ini juga dapat berupa alias alfanumerik, diawali dengan “#”. |
| pesanteks | 1600 | Isi pesan SMS. |
6.3 Parameter permintaan opsional (untuk penggunaan tingkat lanjut)
| Nama | Panjang maksimal | Keterangan |
| alamatasal | 16 | Alamat asal untuk pesan SMS keluar. Jenis alamat asal ditentukan oleh parameter originatorTON. Panjang maksimal nomor pendek adalah 16. Pengirim alfanumerik terbatas pada Alfabet bawaan GSM dengan panjang maksimal 11 karakter. Panjang maksimal pengirim MSISDN adalah 15 (menggunakan format yang sama dengan elemen destinationAddress). Dapat dihilangkan saat originatingAddress dan originatingTON dipilih oleh sistem. Fungsi ini bergantung pada pasar dan konfigurasi. Perilaku dapat bervariasi dengan integrasi Operator. |
| pencetusTON | 1 | Jenis nomor alamat asal (TON): 0 – Angka pendek 1 – Alfanumerik (panjang maks 11) 2 – MSISDN Dapat dihilangkan saat originatingAddress dan originatingTON akan dipilih oleh sistem. Fungsi ini bergantung pada pasar dan konfigurasi. Perilaku dapat bervariasi dengan integrasi Operator. |
| HeaderDataPengguna | 280 | Header Data Pengguna bersama dengan Data Pengguna dapat berisi hingga 140, yaitu 280 ketika dikodekan dalam heksadesimal, oktet. Parameter ini selalu dikodekan dalam heksadesimal. |
| DCS | 3 | Skema pengkodean data. Perilaku dapat bervariasi dengan integrasi Operator. |
| IDENTIFIKASI | 3 | ID Protokol. Perilaku dapat bervariasi dengan integrasi Operator. |
| WaktuValiditasRelatif | 6 | Waktu validitas relatif dalam hitungan detik (relatif terhadap waktu pengajuan ke LINK Mobility). Nilai maksimum adalah 604800 (7 hari) dan default adalah 48 jam. Perilaku dapat bervariasi dengan integrasi Operator. |
| Waktu pengiriman | 20 | Waktuamp kapan pesan SMS harus dikirim (waktu pengiriman tertunda). Lihat bagian tentang format tanggal waktu. |
| statusLaporanBendera | 1 | Kirim permintaan laporan: 0 – Tidak ada laporan pengiriman (default) 1 – Laporan pengiriman diminta 9 – Laporan pengiriman server diminta (LINK Mobility tidak meneruskan laporan ke Penyedia Layanan tetapi menyediakannya dalam laporan, dsb.) |
| campnama aign | 50 | Transaksi Mobilitas LINK adalah tagdiberi nama ini. Digunakan untuk mengelompokkan transaksi dalam laporan Link Mobility. |
| pesan gabungan maksimum | 1 | Nilai antara 1 dan 10 yang menentukan berapa banyak pesan gabungan yang diizinkan. Nilai default adalah 3. |
| korelasiId | 100 | ID yang diberikan oleh Penyedia Layanan yang akan ditampilkan dalam Laporan Pengiriman. |
| nama belakang | 100 | Disediakan sebagai alternatif untuk Autentikasi Dasar HTTP. |
| kata sandi | 100 | Disediakan sebagai alternatif untuk Autentikasi Dasar HTTP. |
6.4 Metode Permintaan HTTP
Untuk interoperabilitas maksimum, API mendukung metode permintaan HTTP GET dan POST. Tidak ada metode HTTP lain yang diizinkan.
6.4.1 DAPATKAN
String kueri yang dikodekan ditambahkan ke URL.
MENDAPATKAN
https://europe.ipx.com/restapi/v1/sms/send?destinationAddress=461234
56789&messageText=Halo+Dunia%21
Otorisasi: Dasar am9objpjaGFuZ2VtZSA=
6.4.2 POSTING
String kueri yang dikodekan dikirimkan dalam badan pesan permintaan HTTP. Tipe Konten adalah application/x-www-form-urldikodekan.
POS https://europe.ipx.com/restapi/v1/sms/send
Tuan rumah: europe.ipx.com
Jenis Konten: application / x-www-form-urldikodekan
Otorisasi: Dasar am9objpjaGFuZ2VtZSA=
Panjang Konten: 57
alamattujuan=46123456789&tekspesan=Halo+Dunia%21
6.5 Tanggal dan waktu
Parameter dalam REST API yang mewakili tanggal dan waktu selalu dalam zona waktu UTC (Waktu Universal Terkoordinasi).amps direpresentasikan sebagai string dengan format yang tepat ini:
2017-04-25T23:20:50Z
Ini mewakili 20 menit dan 50 detik setelah jam ke-23 tanggal 25 April 2017 dalam UTC.
7. Pesan tanggapan
Setelah menerima dan menafsirkan pesan permintaan, API merespons dengan pesan respons HTTP.
7.1 Kode status HTTP
REST API selalu mengembalikan kode status HTTP 200 OK untuk permintaan yang diproses. Isi pesan berisi parameter responseCode yang digunakan untuk menentukan hasil yang tepat.
7.2 Isi pesan
Isi pesan terdiri dari JSON yang menjelaskan hasil permintaan.
http://json.org/
Link Mobility JSON mematuhi Panduan Gaya JSON Google.
https://google.github.io/styleguide/jsoncstyleguide.xml
7.3 Parameter respons
| Nama | Panjang maksimal | Keterangan |
| kode respons | 3 | 0 menunjukkan transaksi berhasil. |
| pesanrespons | 255 | Deskripsi tekstual respons, misalnya teks kesalahan. |
| waktuamp | 20 | Tanggal & waktu saat LINK Mobility memproses permintaan. (Lihat bagian format tanggal/waktu). |
| jejakID | 36 | Pengidentifikasi internal Link Mobility. Digunakan untuk dukungan dan pemecahan masalah. |
| id pesan | Ukuran 10x36 | Rangkaian ID pesan unik LINK Mobility untuk setiap pesan yang berhasil (beberapa ID pesan dikembalikan jika pesan digabungkan). Dihilangkan jika terjadi kegagalan. |
7.4 Contohamptanggapan
Kesuksesan
HTTP/1.1 200 Oke
Tipe Konten: aplikasi/json
Panjang Konten: 144
Tanggal: Kamis, 15 September 2016 13:20:31 GMT
{“responseCode”:0,”responseMessage”:”Berhasil”,”timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Berikut ini adalah format JSON yang sama agar mudah dibaca:
{
“kode respons“:0,
“pesanrespons":"Kesuksesan",
“waktuamp“:”2016-0915T13:20:31Z”,
“jejakID“:”f678d30879fd4adc25f2”,
“id pesan“:[“1-4850879008”] }
Kegagalan
HTTP/1.1 200 Oke
Tipe Konten: aplikasi/json
Panjang Konten: 148
Tanggal: Kamis, 15 September 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:”Login tidak valid atau penggunaan API tidak sah”,”timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
Kesuksesan
HTTP/1.1 200 Oke
Tipe Konten: aplikasi/json
Panjang Konten: 144
Tanggal: Kamis, 15 September 2016 13:20:31 GMT
{“responseCode”:0,”responseMessage”:”Berhasil”,”timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Berikut ini adalah format JSON yang sama agar mudah dibaca:
{
“kode respons“:0,
“pesanrespons":"Kesuksesan",
“waktuamp“:”2016-0915T13:20:31Z”,
“jejakID“:”f678d30879fd4adc25f2”,
“id pesan“:[“1-4850879008”] }
Kegagalan
HTTP/1.1 200 Oke
Tipe Konten: aplikasi/json
Panjang Konten: 148
Tanggal: Kamis, 15 September 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:”Login tidak valid atau penggunaan API tidak sah”,”timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
7.5 Kode respons
Kode respons berikut dapat dikembalikan dalam respons pengiriman:
| Kode | Teks | Keterangan |
| 0 | Kesuksesan | Berhasil dieksekusi. |
| 1 | Login tidak valid atau penggunaan API tidak sah | Nama pengguna atau kata sandi salah atau Penyedia Layanan diblokir oleh LINK Mobility. |
| 2 | Konsumen diblokir oleh Link Mobility | Konsumen diblokir oleh LINK Mobility. |
| 3 | Operasi tidak disediakan oleh LINK Mobility | Operasi diblokir untuk Penyedia Layanan. |
| 4 | Konsumen tidak diketahui oleh LINK Mobility | Konsumen tidak dikenal oleh LINK Mobility. Atau jika alias digunakan dalam permintaan; alias tidak ditemukan. |
| 5 | Konsumen telah memblokir layanan ini di LINK Mobility | Konsumen telah memblokir layanan ini di LINK Mobility. |
| 6 | Alamat asal tidak didukung | Alamat asal tidak didukung. |
| 7 | Alamat asal Alpha tidak didukung oleh akun | Alamat asal alfa tidak didukung oleh akun. |
| 8 | Alamat asal MSISDN tidak didukung | Alamat asal MSISDN tidak didukung. |
| 9 | GSM diperpanjang tidak didukung | GSM diperpanjang tidak didukung. |
| 10 | Unicode tidak didukung | Unicode tidak didukung. |
| 11 | Laporan status tidak didukung | Laporan status tidak didukung. |
| 12 | Kemampuan yang dibutuhkan tidak didukung | Kemampuan yang diperlukan (selain yang di atas) untuk mengirim pesan tidak didukung. |
| 13 | Tingkat pembatasan maksimum penyedia konten telah terlampaui | Penyedia Layanan mengirim pesan SMS ke LINK Mobility terlalu cepat. |
| 14 | ID Protokol tidak didukung oleh akun | ID Protokol tidak didukung. |
| 15 | Batas penggabungan pesan terlampaui | Jumlah pesan yang dirangkai melebihi jumlah maksimum yang diminta. |
| 16 | Tidak dapat mengarahkan pesan. | LINK Mobilitas tidak dapat mengarahkan pesan. |
| 17 | Periode waktu terlarang | Tidak diperbolehkan mengirim pesan selama jangka waktu tersebut |
| 18 | Saldo terlalu rendah pada akun penyedia layanan | Penyedia layanan diblokir karena saldo terlalu rendah |
| 50 | Keberhasilan sebagian | Berhasil sebagian saat mengirim pesan SMS ke beberapa penerima. |
| 99 | Kesalahan server internal | Kesalahan Mobilitas Tautan Lainnya, hubungi dukungan Mobilitas LINK untuk informasi lebih lanjut. |
| 100 | Alamat tujuan tidak valid | Alamat tujuan (MSISDN, atau alias) tidak valid. |
| 102 | ID yang direferensikan (tertaut) tidak valid | ID referensi tidak valid, mungkin ID referensi sudah digunakan, terlalu lama atau tidak dikenal. |
| 103 | Nama akun tidak valid | Nama akun tidak valid. |
| 105 | Meta data layanan tidak valid | Meta data layanan tidak valid. |
| 106 | Alamat asal tidak valid | Alamat asal tidak valid. |
| 107 | Alamat asal alfanumerik tidak valid | Alamat asal alfanumerik tidak valid. |
| 108 | Waktu validitas tidak valid | Waktu validitas tidak valid. |
| 109 | Waktu pengiriman tidak valid | Waktu pengiriman tidak valid. |
| 110 | Konten pesan/data pengguna tidak valid | Data pengguna, yaitu pesan SMS, tidak valid. |
| 111 | Panjang pesan tidak valid | Panjang pesan SMS tidak valid. |
| 112 | Header data pengguna tidak valid | Header data pengguna tidak valid. |
| 113 | Skema pengkodean data tidak valid | DCS tidak valid. |
| 114 | ID protokol tidak valid | PID tidak valid. |
| 115 | Bendera laporan status tidak valid | Bendera laporan status tidak valid. |
| 116 | TON tidak valid | TON pembuatnya tidak valid. |
| 117 | Tidak valid campnama aign | C adalahampNama aign tidak valid. |
| 120 | Batasan tidak valid untuk jumlah maksimum pesan yang digabungkan | Jumlah maksimum pesan yang dirangkai tidak valid. |
| 121 | Alamat asal msisdn tidak valid | Alamat asal MSISDN tidak valid. |
| 122 | ID korelasi tidak valid | ID korelasi tidak valid. |
8. Fitur opsional
8.1 Koreksi MSISDN
Koreksi MSISDN adalah fitur opsional yang dapat diaktifkan oleh dukungan LINK Mobility jika diminta.
Fitur ini akan mengoreksi alamat tujuan dan menyelaraskannya dengan format E.164 yang diperlukan. Selain koreksi format, sistem juga dapat menjalankan fungsi khusus pasar seperti menerjemahkan nomor internasional Prancis ke nomor DOM-TOM (départements et territoires d'outre-mer) yang benar jika berlaku.
Berikut ini adalah beberapa contohampsedikit koreksi:
| Alamat Tujuan yang Dikirimkan | Alamat Tujuan Telah Dikoreksi |
| +46(0)702233445 | 46702233445 |
| (0046)72233445 | 46702233445 |
| +460702233445 | 46702233445 |
| 46(0)702233445 | 46702233445 |
| Nomor telepon 46070-2233445 | 46702233445 |
| 0046702233445 | 46702233445 |
| +46(0)702233445a | 46702233445 |
| 336005199999 | 2626005199999 (Angka Prancis diterjemahkan ke nomor DOM-TOM) |
Selain itu, nomor telepon nasional dapat diizinkan untuk pasar tertentu. Bila fitur ini diaktifkan, nomor internasional untuk pasar lain harus dikirim dengan tanda awal `+' untuk membedakannya dari pasar tertentu.
Di bawah ini adalah beberapa mantanampSedikit koreksi yang dilakukan saat menggunakan Swedia (kode negara 46) sebagai pasar default untuk nomor nasional.
| Alamat Tujuan yang Dikirimkan | Alamat Tujuan Telah Dikoreksi |
| 0702233445 | 46702233445 |
| Telepon: 070-2233 445 | 46702233445 |
| 070.2233.4455 | 46702233445 |
| 460702233445 | 46702233445 |
| +460702233445 | 46702233445 |
| +458022334455 | 458022334455 |
| 45802233445 | Tidak valid karena tanda '+' hilang |
Perhatikan bahwa MSISDN yang diperbaiki akan digunakan oleh LINK Mobility dan akan dikembalikan dalam laporan pengiriman.
Silakan hubungi dukungan LINK Mobility untuk informasi lebih lanjut.
8.2 Penggantian Karakter
Penggantian karakter adalah fitur opsional yang dapat diaktifkan oleh dukungan LINK Mobility jika diminta.
Fitur ini akan menerjemahkan karakter alfabet non-GSM dalam data pengguna (teks SMS) menjadi karakter alfabet GSM yang setara ketika DCS diatur ke “GSM” (17). Misalnyaample “Seqüência de teste em Português” akan diterjemahkan menjadi “Seqüencia de teste em Portugues”.
9. Laporan pengiriman
Penyedia Layanan dapat, jika disediakan, meminta laporan pengiriman pesan SMS atau pemberitahuan pengiriman untuk pesan MT yang dikirim. Laporan ini dipicu di Operator SMSC saat pesan MT dikirimkan ke Konsumen yang dituju atau dihapus, misalnya, kedaluwarsa atau, karena alasan tertentu, tidak dapat dirutekan.
Hanya status akhir pesan SMS yang dilaporkan ke Penyedia Layanan, yaitu terkirim atau dihapus. Hanya satu laporan per pesan MT yang dibuat. Dengan status terhapus, kode alasan mungkin berlaku. Kode alasan ini menentukan alasan mengapa pesan SMS tidak terkirim.
Laporan disalurkan melalui LINK Mobility dan dikirim ke Penyedia Layanan menggunakan protokol HTTP.
Untuk menerima laporan, Penyedia Layanan perlu menerapkan misalnyaample Java Servlet atau halaman ASP.NET. Keduanya menerima permintaan HTTP GET atau POST.
Parameter
Permintaan tersebut mencakup parameter berikut:
| Parameter | Jenis | Nama Pria/Wanita* | Nilai Default | Panjang maksimal | Keterangan |
| IdPesan | rangkaian | M | – | 22 | ID pesan dari pesan MT yang sesuai dengan laporan ini. |
| Alamat Tujuan | rangkaian | M | – | 40 | MSISDN Konsumen, yaitu alamat tujuan pesan MT asli. |
| Kode Status | bilangan bulat | M | 1 | Kode status menunjukkan status pesan MT. Kode status yang berlaku adalah: 0 – Terkirim 2 – Dihapus (kode alasan berlaku) |
|
| WaktuStamp | rangkaian | M | – | 20 | Waktu yang menunjukkan saat laporan pengiriman diterima oleh LINK Mobility. Zona waktu dari timestamp adalah CET atau CEST (dengan waktu musim panas sebagaimana ditetapkan untuk UE). Format: ttttbbhhjj:mm:dd. |
| Operator | rangkaian | M | – | 100 | Nama Operator yang digunakan saat mengirim pesan SMS atau nama akun yang digunakan saat mengirim pesan SMS. Daftar Operator yang tersedia disediakan oleh dukungan LINK Mobility. |
| Kode Alasan | bilangan bulat | O | – | 3 | Kode alasan menunjukkan mengapa pesan berakhir dalam status terhapus. Kode alasan yang berlaku adalah: 100 – Kedaluwarsa 101 – Ditolak 102 – Kesalahan format 103 – Kesalahan lainnya 110 – Pelanggan tidak diketahui 111 – Pelanggan diblokir 112 – Pelanggan tidak disediakan 113 – Pelanggan tidak tersedia 120 – Kegagalan SMSC 121 – Kemacetan SMSC 122 – Jelajah SMSC 130 – Kesalahan telepon genggam 131 – Memori handset terlampaui Perilaku dapat bervariasi dengan integrasi Operator. |
| OperatorWaktuStamp | rangkaian | O | – | 20 | Waktu yang menunjukkan saat laporan dipicu dalam SMSC Operator (jika disediakan oleh Operator). Zona waktu dari timestamp adalah CET atau CEST (dengan waktu musim panas sebagaimana ditetapkan untuk UE). Format: ttttbbhhjj:mm:dd. |
| Teks Status | rangkaian | O | – | 255 | Placeholder untuk informasi tambahan dari Operator, misalnya deskripsi teks yang jelas tentang status/alasan. Perilaku dapat bervariasi dengan integrasi Operator. |
| KorelasiId | rangkaian | O | – | 100 | ID korelasi yang disediakan dalam SendRequest atau SendTextRequest. |
| Kode Jaringan Operator | bilangan bulat | O | – | 6 | Kode Jaringan Seluler (MCC + MNC) Operator. |
* M = Wajib, O = Opsional, I = Diabaikan.
Penyedia Layanan harus menyediakan LINK Mobility dengan target URL untuk laporan pengiriman (opsional termasuk kredensial untuk autentikasi dasar HTTP). Penyedia Layanan dapat memilih metode HTTP mana yang lebih disukai untuk digunakan:
HTTP POST (disarankan)
HTTP DAPATKAN.
Example menggunakan HTTP GET (berhasil dikirim):
https://user:password@www.serviceprovider.com/receivereport?%20MessageId=122&DestinationAddress=46762050312&Operator=Vodafone&TimeStamp=20100401%2007%3A47%3A44&StatusCode=0
Example menggunakan HTTP GET (tidak terkirim, Operator telah menyediakan waktuamp untuk acara tersebut):
Parameternya adalah URL dikodekan.
Pengkodean karakter:
Penyedia Layanan dapat memilih pengkodean karakter mana yang akan digunakan:
UTF-8 (disarankan)
Bahasa Indonesia: ISO 8859-1.
9.1 Pengakuan Penyedia Layanan
Penyedia Layanan harus memberikan konfirmasi atas setiap laporan pengiriman. Konfirmasi tersebut dapat berupa konfirmasi positif, yaitu laporan pengiriman berhasil diterima, atau konfirmasi negatif, yaitu kegagalan.
Harap diperhatikan: LINK Mobility memiliki batas waktu baca untuk pengakuan selama 30 detik untuk laporan pengiriman. Batas waktu akan memicu percobaan ulang pengiriman (jika percobaan ulang diaktifkan) atau pembatalan pengiriman (jika percobaan ulang dinonaktifkan). Ini berarti bahwa aplikasi Penyedia Layanan harus memastikan waktu respons yang cepat, terutama selama beban tinggi.
Sangat disarankan untuk mengakui laporan pengiriman terhadap LINK Mobility sebelum memprosesnya.
Aturan untuk pengakuan positif dan negatif dijelaskan sebagai berikut:
Pengakuan positif, ACK, laporan pengiriman terkirim:
Kode respons rentang HTTP 200 dikombinasikan dengan konten berformat XML berikut:
Pengakuan negatif, NAK, laporan pengiriman tidak terkirim:
Segala balasan selain pengakuan positif, misalnyaample, pengakuan negatif dipicu oleh kode kesalahan HTTP atau konten XML berikut:
Konten XML dapat digunakan untuk mengendalikan mekanisme percobaan ulang LINK Mobility. NAK akan menyebabkan percobaan ulang, jika diaktifkan. Bagi Penyedia Layanan yang tidak dikonfigurasi untuk mekanisme percobaan ulang, konten XML bersifat opsional.
Di bawah ini adalah permintaan dan respons HTTP POSTamplembar laporan pengiriman yang dikirimkan ke Penyedia Layanan:
Permintaan HTTP:
POST /konteks/aplikasi HTTP/1.1
Jenis Konten: application / x-www-form-urldikodekan;charset=utf-8
Tuan rumah: server:port
Panjang Konten: xx
MessageId=213123213&DestinationAddress=46762050312&Operator=Telia& OperatorTimeStamp=20130607%2010%3A45%3A00&TimeStamp=20130607%2010%3A 45%3A02&StatusCode=0
Respons HTTP:
HTTP/1.1 200 Oke
Tipe Konten: teks/biasa
9.2 Coba lagi
Sistem LINK Mobility dapat melakukan percobaan ulang untuk pengiriman laporan pengiriman yang gagal, yaitu tidak diakui. Penyedia Layanan dapat memilih perilaku percobaan ulang yang diinginkan:
Tidak ada percobaan ulang (default) – pesan akan dibuang jika upaya koneksi gagal, batas waktu baca habis, atau ada kode kesalahan HTTP apa pun.
Mencoba kembali – pesan akan dikirim ulang untuk setiap jenis masalah koneksi, batas waktu baca, atau pengakuan negatif.
Saat percobaan ulang untuk NAK diaktifkan, penting untuk memahami skenario mana yang akan menghasilkan percobaan ulang dari LINK Mobility dan bagaimana percobaan ulang tersebut bekerja. Setiap Penyedia Layanan memiliki antrean percobaan ulang sendiri, di mana pesan diurutkan menurut waktu pengiriman pesanamp. Link Mobility selalu mencoba mengirimkan pesan lama terlebih dahulu, meskipun urutan pesan yang dikirimkan ke Penyedia Layanan tidak dijamin. Alasan utama mengapa pesan dibuang dari antrean percobaan ulang adalah salah satu dari dua alasan: TTL pesan kedaluwarsa atau (secara teoritis) antrean percobaan ulang menjadi penuh. TTL bergantung pada Operator dan akun, yaitu, dapat bervariasi tergantung pada Operator dan atau jenis pesan, misalnya, SMS premium atau pesan SMS tarif standar.
Penyedia Layanan dengan coba lagi yang diaktifkan harus memeriksa ID unik pesan MT untuk memastikan bahwa pesan tersebut belum diterima.
Penting bagi Penyedia Layanan untuk mematuhi aturan sederhana ini ketika terjadi kesalahan selama pemrosesan laporan pengiriman jika alasan kesalahan tersebut: Sementara, misalnya basis data tidak tersedia, NAK harus dikembalikan. LINK Mobility akan mengirim ulang pesan tersebut.
Permanen dan upaya percobaan ulang kemungkinan besar akan menyebabkan masalah yang sama, ACK harus dikembalikan. Misalnyaample, ketika pesan tidak dapat diurai dengan benar atau menyebabkan kesalahan runtime yang tidak terduga.
Bertindak sesuai dengan itu akan memastikan tidak ada pemblokiran atau penurunan throughput yang disebabkan oleh laporan pengiriman yang dikirim ulang berulang kali.
10. Tips implementasi
1. Anda dapat menggunakan web browser untuk mengirimkan permintaan ke API. Hal ini memudahkan penjelajahan dan evaluasi layanan tanpa alat pengembangan apa pun.
2. Chrome atau Firefox direkomendasikan bersama dengan ekstensi seperti JSONView untuk menampilkan JSON yang diformat cantik.
3. Kami telah menggunakan SoapUI untuk menguji POST, Autentikasi Dasar, dan untuk memeriksa permintaan HTTP dan pesan respons mentah.
4. C adalahURL alat ini berguna untuk mengirimkan permintaan POST dengan Autentikasi Dasar. Lihat contohample di bawah.
curl POS \
-H “Jenis Konten: aplikasi/x-www-form-url“dikodekan” \
-H “Otorisasi: Dasar am9objpjaGFuZ2VtZSA=” \
https://europe.ipx.com/restapi/v1/sms/send \
–data “alamatTujuan=46123456789&teksPesan=Halo+Dunia%21”
Bahasa Indonesia: _______________
Transformasi Komunikasi Pribadi
Dokumen / Sumber Daya
 |
Panduan Implementasi Mobilitas LINK REST API SMS [Bahasa Indonesia:] Panduan Pengguna Panduan Implementasi Mobilitas REST API SMS, Mobilitas, Panduan Implementasi REST API SMS, REST API SMS, API SMS, SMS |
