Respons Pengiriman
Alamat Panggilan
| Pusat Data | URL |
|---|---|
| Singapura | https://email.api.engagelab.cc |
| Turki | https://emailapi-tr.engagelab.com |
Saat menggunakan REST API, pastikan pusat data yang dipilih sesuai dengan base URL yang benar.
POST/v1/email_status
Permintaan
Daftar status email.
Anda dapat memeriksa status email Anda di daftar ini.
URL
https://email.api.engagelab.cc/v1/email_status
https://email.api.engagelab.cc/v1/email_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(api_user:api_key) |
Deskripsi Parameter Permintaan
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| offset | string | tidak | posisi awal, [0-], default 0 |
| limit | int | tidak | jumlah, [0-100], default 100 |
| send_date | string | ya | format tanggal kirim yyyy-MM-dd |
| string | tidak | alamat penerima | |
| email_ids | string | tidak | emailId, dikembalikan setelah email berhasil dikirim via API; dipisahkan titik koma, contoh: email_ids=a;b;c |
| api_user | string | tidak | nama api_user |
| domain_name | string | tidak | domain penerima, contoh: gmail.com |
| label_id | string | tidak | ID label yang sesuai |
| status | string | tidak | status. 18 = mengirim, 1 = terkirim, 5 = soft bounce, 4 = email tidak valid |
| sub_status | string | tidak | beberapa sub_status, dipisahkan titik koma, contoh: sub_status=a;b;c. Jika diisi, parameter status diabaikan. |
Tips:
- Default 100 data per pencarian. Tentukan limit dan offset jika data lebih dari 100.
- Data hasil pencarian akan di-cache selama 10 menit.
- Setiap akun dibatasi 60 kali panggilan per menit. Jika butuh lebih, gunakan WebHook.
- Jika parameter email diisi, detail pengiriman ke alamat terkait dalam 30 hari setelah send_date dapat dicari. Jika parameter email tidak diisi, hanya data pada send_date yang dapat dicari.
| sub_status | deskripsi sub_status |
|---|---|
| 401 | Email Tidak Valid - Daftar Hitam |
| 402 | Email Tidak Valid - Berhenti Berlangganan |
| 403 | Email Tidak Valid - Kesalahan Server |
| 404 | Email Tidak Valid - Kesalahan Format |
| 405 | Email Tidak Valid - Penolakan IP |
| 406 | Email Tidak Valid - Tidak Ada |
| 407 | Email Tidak Valid - Email Spam |
| 408 | Email Tidak Valid - Ditolak |
| 409 | Email Tidak Valid - Lainnya |
| 503 | Soft bounce - Kesalahan Server |
| 505 | Soft bounce - Penolakan IP |
| 506 | Soft bounce - Tidak Ada |
| 507 | Soft bounce - Ditolak Spam |
| 508 | Soft bounce - Ditolak |
| 509 | Soft bounce - Lainnya |
Contoh Permintaan:
curl "https://email.api.engagelab.cc/v1/email_status?send_date=2022-11-21&email_ids=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/email_status?send_date=2022-11-21&email_ids=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang
Deskripsi Nilai Balik
| Field | Deskripsi |
|---|---|
| alamat penerima | |
| email_id | emailId, dikembalikan setelah email berhasil dikirim via API |
| api_user | nama api_user |
| status | status email |
| status_desc | deskripsi status |
| sub_status | kode status tidak valid 401-509 |
| sub_status_desc | deskripsi sub_status tidak valid atau soft bounce |
| request_time | waktu permintaan |
| update_time | waktu pembaruan |
| response_message | respons |
Contoh Nilai Balik
{
"result": [
{
"email_id": "1668065941982_15_2032_7460.sc-10_2_226_96-test0$1720f4a1d6af047181@hotmail.com",
"api_user": "zymtest4",
"email": "1720f4a1d6af047181@hotmail.com",
"request_time": "2022-11-10T15:39:01+0800",
"update_time": "2022-11-10T17:34:16+0800",
"status": 4,
"sub_status": 409,
"status_desc": "Email Tidak Valid",
"sub_status_desc": "Lainnya",
"response_message": "Lainnya(scheduler: deleted)"
}
],
"total": "48675",
"count": 1
}
{
"result": [
{
"email_id": "1668065941982_15_2032_7460.sc-10_2_226_96-test0$1720f4a1d6af047181@hotmail.com",
"api_user": "zymtest4",
"email": "1720f4a1d6af047181@hotmail.com",
"request_time": "2022-11-10T15:39:01+0800",
"update_time": "2022-11-10T17:34:16+0800",
"status": 4,
"sub_status": 409,
"status_desc": "Email Tidak Valid",
"sub_status_desc": "Lainnya",
"response_message": "Lainnya(scheduler: deleted)"
}
],
"total": "48675",
"count": 1
}
Tampilkan blok kode ini di jendela mengambang










