Status

Permintaan

Daftar status SMS yang dikirim oleh pengguna. Anda dapat melakukan permintaan pada daftar ini.

URL

https://sms.api.engagelab.cc/v1/status

              
              https://sms.api.engagelab.cc/v1/status

Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	string	ya	Basic base64(sms_user:sms_key)

Deskripsi Parameter

Parameter	Tipe	Wajib	Deskripsi
offset	string	tidak	posisi awal, [0-], default 0
limit	string	tidak	jumlah, [0-100], default 100
time_zone	string	tidak	zona waktu, contoh: +8
send_date	string	ya	format tanggal pengiriman: yyyy-MM-dd
phone	string	tidak	nomor ponsel
sms_ids	string	tidak	ID SMS yang dikembalikan setelah SMS berhasil dikirim, beberapa sms_id dipisahkan dengan ;, maksimal 10
msg_type	string	tidak	tipe SMS, 2 untuk SMS internasional
sms_user	string	tidak	SMS_USER tertentu untuk pelanggan
template_id	string	tidak	ID template SMS
label_id	string	tidak	ID label SMS
status	string	tidak	1 terkirim, 2 berhasil dikirim, 3 menunggu hasil, 4 proses gagal, 5 gagal kirim
sub_status	string	tidak	substatus

Tips：

Mendukung permintaan data detail untuk satu hari dalam 6 bulan terakhir.

Data hasil permintaan akan di-cache selama 10 menit.

Setiap SMS_USER dibatasi maksimal 60 kali permintaan per menit.

Contoh Permintaan

curl -X GET "sms.api.engagelab.cc/v1/status?start_date=2011-11-20&end_date=2011-11-20?msg_types=2" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "sms.api.engagelab.cc/v1/status?start_date=2011-11-20&end_date=2011-11-20?msg_types=2" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
phone	nomor ponsel
sms_id	ID SMS
msg_type	tipe SMS
sms_user	SMS_USER
template_id	ID template SMS
template_name	nama template SMS
status	1 terkirim, 2 berhasil dikirim, 3 menunggu hasil, 4 proses gagal, 5 gagal kirim
status_desc	deskripsi status pengiriman SMS: terkirim, berhasil dikirim, menunggu hasil, proses gagal, gagal kirim
sub_status	substatus
sub_status_desc	deskripsi substatus, lihat tabel di bawah
request_time	waktu permintaan
update_time	waktu pembaruan
response_message	respons

Kode status kegagalan proses dan deskripsi:

sub_status	Deskripsi substatus
410	Proses Gagal - Blokir Global
420	Proses Gagal - Blokir Parsial
430	Proses Gagal - Berhenti Berlangganan
440	Proses Gagal - Blokir Kata Kunci
450	Proses Gagal - Kesalahan Variabel
460	Proses Gagal - Kesalahan Konten
470	Proses Gagal - Melebihi Frekuensi
480	Proses Gagal - Lainnya

Kode status kegagalan pengiriman dan deskripsi:

sub_status	Deskripsi substatus
500	Gagal Kirim - Kosong
510	Gagal Kirim - Di luar layanan
520	Gagal Kirim - Daftar hitam
530	Gagal Kirim - Sibuk
540	Gagal Kirim - Tidak ada jawaban
550	Gagal Kirim - Dicegat
560	Gagal Kirim - Gangguan
570	Gagal Kirim - Tidak dalam layanan
580	Gagal Kirim - Mati daya
590	Gagal Kirim - Lainnya

Contoh Nilai Balik

{ "result": [{ "sms_id":"***_**_**_**_**$**", "msg_type": 2, "phone": "+16235217", "request_time": "2017-02-19 00:21:20", "response_message": "success", "sms_user": "*****", "status_desc": "berhasil dikirim", "status":2, "template_id": "10", "template_name": "kode engagelab", "update_time": "2017-02-19 00:21:21" } ], "total": 1 }

              
              {
    "result":  [{
            "sms_id":"***_**_**_**_**$**",
            "msg_type": 2,
            "phone": "+16235217",
            "request_time": "2017-02-19 00:21:20",
            "response_message": "success",
            "sms_user": "*****",
            "status_desc": "berhasil dikirim",
            "status":2,
            "template_id": "10",
            "template_name": "kode engagelab",
            "update_time": "2017-02-19 00:21:21"
        }
    ],
    "total": 1
}

Tampilkan blok kode ini di jendela mengambang