SMS Bounces (Pesan SMS yang Gagal Terkirim)
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
Tampilkan blok kode ini di jendela mengambang
Metode HTTP Request
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 Query
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| offset | Integer | tidak | posisi offset, [0-], default 0 |
| limit | Integer | tidak | jumlah, [0-100], default 100 |
| phone | string | tidak | nomor telepon |
| start_date | string | ya | tanggal mulai, format yyyy-MM-dd |
| end_date | string | ya | tanggal akhir, format yyyy-MM-dd |
Tips:
Jumlah hari pencarian antara start_date dan end_date tidak boleh melebihi 90 hari.
Contoh Permintaan
curl -X GET "https://sms.api.engagelab.cc/v1/bounces"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/bounces"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang
Deskripsi Nilai Balikan
| Parameter | Deskripsi |
|---|---|
| phone | nomor telepon |
| bounce_type | jenis bounce |
| msg_type | tipe SMS, 2 berarti SMS internasional |
| bounce_time | waktu bounce |
| expire_time | waktu kedaluwarsa |
| reason | alasan bounce |
Kode bounce_type dan Deskripsinya
| Bounce_Type | Deskripsi |
|---|---|
| 500 | Gagal kirim, nomor tidak ada |
| 510 | Gagal kirim, nomor tidak aktif |
| 520 | Gagal kirim, nomor masuk daftar hitam |
| 530 | Gagal kirim, jalur sibuk |
| 540 | Gagal kirim, tidak ada jawaban |
| 550 | Gagal kirim, isi template terblokir |
| 560 | Gagal kirim, kesalahan terminal seluler |
| 570 | Gagal kirim, ponsel tidak aktif |
| 580 | Gagal kirim, ponsel mati |
| 590 | Gagal kirim, alasan lain |
| 410 | Daftar intersepsi global |
| 411 | Kustomisasi daftar intersepsi global |
| 420 | Daftar intersepsi lokal |
| 421 | Kustomisasi daftar intersepsi lokal |
| 430 | Berhenti berlangganan |
| 440 | Penyaringan kata kunci |
| 450 | Kesalahan penggantian variabel |
| 460 | Panjang variabel melebihi batas |
| 470 | Pengecualian encoding (Catatan: sekarang 470 berarti frekuensi melebihi batas) |
| 480 | Jenis pengiriman tidak didukung |
Contoh Nilai Balikan
Respon-berhasil
HTTP Status: 200
{
"result": [
{
"phone": "008613681312917",
"bounce_type": 421,
"bounce_time": "2023-08-04T16:47:02+0800",
"expire_time": "2023-08-08T00:00:00+0800",
"msg_type": 2,
"reason": "Kustomisasi daftar intersepsi lokal"
}
],
"total": 1,
"count": 1
}
{
"result": [
{
"phone": "008613681312917",
"bounce_type": 421,
"bounce_time": "2023-08-04T16:47:02+0800",
"expire_time": "2023-08-08T00:00:00+0800",
"msg_type": 2,
"reason": "Kustomisasi daftar intersepsi lokal"
}
],
"total": 1,
"count": 1
}
Tampilkan blok kode ini di jendela mengambang
Hapus
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
Tampilkan blok kode ini di jendela mengambang
Metode HTTP Request
DELETE
DELETE
Tampilkan blok kode ini di jendela mengambang
Content-type
application/json
application/json
Tampilkan blok kode ini di jendela mengambang
Header Permintaan
| Header | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| Authorization | string | ya | Basic base64(sms_user:sms_key) |
Deskripsi Parameter Body
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| phone | string | ya | nomor telepon |
| start_date | string | ya | tanggal mulai, format yyyy-MM-dd |
| end_date | string | ya | tanggal akhir, format yyyy-MM-dd |
Tips:
Jumlah hari pencarian antara start_date dan end_date tidak boleh melebihi 90 hari.
Contoh Permintaan
curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces"
--data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}'
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces"
--data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}'
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang
Deskripsi Nilai Balikan
| Parameter | Deskripsi |
|---|---|
| count | jumlah bounce yang dihapus |
Contoh Nilai Balikan
Respon-berhasil
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Tampilkan blok kode ini di jendela mengambang
Respon-gagal
HTTP Status :401
{
"code": 30000,
"message": "Tidak berizin."
}
{
"code": 30000,
"message": "Tidak berizin."
}
Tampilkan blok kode ini di jendela mengambang
