API Kirim HLR

Pada bagian ini akan dijelaskan mengenai cara mengirim HLR dengan menggunakan AYOSMS! HLR API, kemana URL untuk mengirimkan parameter dan nilainya.

Endpoint URL

Seluruh permintaan untuk mengirimkan HLR ke AYOSMS! HLR API harus ditujukan ke alamat URL sebagai berikut:
https://api.ayosms.com/mconnect/gw/sendhlr.php

Input Parameters

Tabel berikut ini adalah daftar parameter bisa dikirimkan ke alamat URL diatas. Perhatikan bahwa 2 parameter pertama adalah WAJIB dikirimkan sedangkan lainnya adalah optional. Semua parameter bersifat case sensitive.
Parameter Deskripsi Contoh Nilai
api_key Wajib API Key di akun AYOSMS!. 11877c8e0ac231ca93ec2cfcbe1820eb
to Wajib Nomor tujuan menggunakan format internasional (prefix dengan kode negara tanpa tanda '+'). Nomor tujuan dapat lebih dari 1, dipisahkan dengan tanda koma ','. 62811990000,628999900000
trx_id Kode Unik yang dikirim dari pengguna AYOSMS! untuk membantu referensi pada pelaporan HLR. Terbatas 36 karakter. Hanya menerima 7-bit karakter. ae75fa6b-aa5d-4ea9-9ce7-d7db9da760af
delivery_time Anda dapat melakukan penjadwalan pengiriman HLR sesuai waktu tertentu. Format untuk setting waktu: yyyymmddMM (yyyy=tahun, mm=bulan, dd=tanggal, MM=jam). Waktu mengikuti GMT+7. Jika parameter ini tidak ada, maka pengiriman HLR akan langsung dilakukan. 2015112515

Balasan Pengiriman

HLR API AYOSMS! akan memberikan balasan dalam 2 bentuk:
  • HTTP Header Status (biasanya dalam bentuk kode 200 OK yang menunjukkan bahwa permintaan API sudah sukses diterima)
  • HTTP Content (dalam format JSON)

Balasan HLR Sukses

Standar balasan API HLR adalah kode status=1 dan msg_id unik untuk referensi setiap permintaan pengiriman HLR, ditambah trx_id jika parameter trx_id diisi pada saat pemanggilan API:
HTTP Header 200 OK
Content 
{
 msg_id : "0ca9265c543baf107d3d1feda03aa4d5-1",
 trx_id : "123456",
 status : 1
}

Balasan Error: Pulsa Tidak Cukup

HTTP Header 200 OK
Content 
{
 msg_id : "0ca9265c543baf107d3d1feda03aa4d5-1",
 trx_id : "123456",
 status : 0,
 error-text : "ERR002:insufficient balance"
}

Response Attributes

Parameter Deskripsi
status Kode status '1' menunjukkan permintaan sukses diterima, sedangkan '0' menunjukkan permintaan gagal diterima (untuk kode Error, silakan lihat penjelasannya dibawah)
trx_id Kode unik referensi yang diisi oleh user saat melakukan permintaan pengiriman HLR melalui API
error-text Kode error diikuti dengan penjelasannya

Balasan Kode Error

Kode Balasan Deskripsi
ERR001 akun user dibatalkan
ERR002 pulsa tidak mencukupi
ERR006 parameter "to" salah atau kosong
ERR008 parameter "api_key" tidak ditemukan
ERR009 pengirim/masking tidak terdaftar
ERR010 waktu pengiriman telah lampau
ERR999 parameter "api_key" kosong

Contoh

Untuk mengirim HLR ke nomor 62811000000

https://api.ayosms.com/mconnect/gw/sendhlr.php?api_key=your_unique_api_key&to=62811000000&trx_id=mytrxid12345
Parameter Value in Request Description
api_key your_unique_api_key API Key di akun AYOSMS!.
to 62811000000 Nomor tujuan menggunakan format internasional (prefix dengan kode negara tanpa tanda '+').
trx_id mytrxid12345 Kode Unik yang dikirim dari pengguna AYOSMS! untuk membantu referensi pada pelaporan SMS. Terbatas 36 karakter. Hanya menerima 7-bit karakter.

Laporan Pengiriman

Laporan Pengiriman (Delivery Receipt (DLR)), adalah pesan yang dikirimkan operator untuk menunjukkan posisi terakhir dari permintaan HLR kita.

Meminta Laporan Pengiriman

Jika pada saat permintaan pengiriman mengisi parameter "dlr=1" maka sistem akan memberikan umpan balik sesaat setelah sistem AYOSMS! menerima unpan balik permintaan HLR dari operator.

Permintaan Umpan Balik DLR

<Your_DLR_Callback_URL>?msg_id=0ca9265c543baf107d3d1feda03aa4d5-1&trx_id=mytrxid12345&to=62811000000&delivered=1460019615&status=1&error-text=DELIVERED&meta-data=%7B%22countrycode%22%3A%22id%22%2C%22country%22%3A%22Indonesia%22%2C%22networkcode%22%3A%2251010%22%2C%22operator%22%3A%22TELKOMSEL%22%7D

Sesaat setelah AYOSMS! menerima laporan pengiriman dari operator (DLR), pengiriman umpan balik HTTP DLR akan dikirimkan ke URL Umpan Balik DLR Anda dengan parameter-parameter sebagai berikut:

Parameter Deskripsi
msg_id ID unik untuk identifikasi setiap permintaan pengiriman SMS. Digunakan juga untuk mencocokkan setiap laporan pengiriman (Delivery Report).
trx_id Kode unik referensi yang diisi oleh user saat melakukan permintaan HLR melalui API
to Nomor tujuan menggunakan format internasional (prefix dengan kode negara tanpa tanda '+').
delivered Waktu saat AYOSMS! menerima status DR dari operator (dalam format UNIX TIMESTAMP, GMT+7).
status Selalu berisi '1' jika SMS terkirim sampai ke nomor tujuan, dan '0' untuk gagal (seperti SMS kadaluarsa/nomor tujuan tidak aktif/handset error dll)
error-text Berisi keterangan lebih detail mengenai kegagalan. (Lihat keterangan error-text dibawah)
Error-text:
DELIVERED
PENDING
REJECTED
NO ROUTE TO DESTINATION NUMBER
UNKNOWN SUBSCIBER (IMSI IS UNKNOWN IN THE HLR)
SENT NOT DELIVERED
meta-data Informasi tambahan seperti Kode Negara, Kode Network dan Nama Operator. Informasi ini akan berbentuk JSON yang sudah di url-encode.
Contoh:
{
 countrycode : "id",
 country : "Indonesia",
 networkcode : "51010",
 operator : "TELKOMSEL"
}

Url-encoded:
%7B%22countrycode%22%3A%22id%22%2C%22country%22%3A%22Indonesia%22%2C%22networkcode%22%3A%2251010%22%2C%22operator%22%3A%22TELKOMSEL%22%7D

Balasan dari Sistem Anda

Sistem Anda HARUS membalas dengan text "OK" saat sistem AYOSMS! mengirimkan DR. Sistem AYOSMS! akan mencoba sampai 10x jika sistem Anda tidak memunculkan text "OK".
HTTP Header 200 OK
Content 
OK
AYOSMS!
PT. Ayomobile Media International
Gedung Graha Kencana, Lt.10/G,
Jl. Raya Pejuangan No. 88
Jakarta, 11530
Indonesia
+62.21.53668160
info@ayosms.com


Copyright © 2003-2024
Made in Jakarta, Indonesia
Ohio, US - IND/EN | 3.135.220.8
Tanya Jawab
Daftar
Pembayaran

Program Reseller
API
Kontak
Info Perusahaan

IKUTI KAMI
SMSMOO
AYOMOBILE!