Laporkan Hasil Verifikasi
Setelah EngageLab mengirim kode verifikasi, jika Anda menyelesaikan verifikasi di sistem sendiri, Anda dapat memanggil API ini untuk melaporkan hasil verifikasi yang berhasil untuk statistik backfill.
API ini gratis dan hanya menerima hasil verifikasi yang berhasil.
Endpoint
POST https://otp.api.engagelab.cc/v1/backfill
Autentikasi
Lihat Autentikasi untuk memahami cara melakukan autentikasi API.
Gunakan API Key yang dikonfigurasi untuk aplikasi yang mengirim pesan tersebut, dan pastikan API Key memiliki izin verifikasi (verify).
Contoh request
Header request
POST /v1/backfill HTTP/1.1
Content-Type: application/json
Authorization: Basic ${base64_auth_string}
Body request
{
"message_id": "1725407449772531712",
"verified_at": 1793116800
}
Parameter request
Body request menggunakan format JSON. Atur header request Content-Type: application/json.
| Parameter | Tipe | Opsi | Keterangan |
|---|---|---|---|
| message_id | String | Wajib | ID pesan yang sesuai dengan kode verifikasi, dikembalikan oleh API pengiriman |
| verified_at | Integer | Wajib | Waktu verifikasi berhasil, berupa Unix timestamp dalam detik |
Parameter respons
Respons sukses
Kode status HTTP 200 berarti platform telah mencatat hasil verifikasi berhasil ini.
| Field | Tipe | Opsi | Deskripsi |
|---|---|---|---|
| code | Integer | Wajib | 0 saat berhasil |
| message | String | Wajib | Keterangan hasil. success saat berhasil |
{
"code": 0,
"message": "success"
}
Respons gagal
Kode status HTTP adalah 4xx atau 5xx, dan body respons berisi kode error serta keterangan error. Misalnya, jika pesan sudah berhasil diverifikasi, API mengembalikan HTTP 400:
| Field | Tipe | Opsi | Deskripsi |
|---|---|---|---|
| code | Integer | Wajib | Kode error. Lihat keterangan kode error di bawah |
| message | String | Wajib | Keterangan error |
{
"code": 3012,
"message": "verify code has already validated"
}
Kode error
| Kode error | http code | Keterangan |
|---|---|---|
| 1000 | 500 | Kesalahan internal layanan. Coba lagi nanti |
| 2001 | 401 | Informasi autentikasi tidak ada atau tidak valid |
| 2002 | 401 | API Key telah kedaluwarsa atau dinonaktifkan |
| 2002 | 403 | Aplikasi saat ini tidak tersedia |
| 2004 | 403 | API Key tidak memiliki izin untuk memanggil API ini |
| 3001 | 400 | JSON request tidak valid atau tipe parameter salah |
| 3002 | 400 | Nilai parameter tidak valid, waktu di luar rentang yang diizinkan, atau pesan tidak mendukung backfill |
| 3012 | 400 | Pesan sudah berhasil diverifikasi dan tidak perlu dilaporkan lagi |
| 4001 | 400 | Pesan tidak ada atau bukan milik aplikasi saat ini |
Tangani error berdasarkan code. message menjelaskan alasan yang spesifik.
Petunjuk penggunaan
- Hanya pesan kode verifikasi yang berhasil terkirim yang didukung. Pesan yang sebelumnya gagal atau habis waktu saat diverifikasi di platform tetap dapat dilaporkan jika Anda berhasil memverifikasinya sendiri.
- Laporan pertama harus diselesaikan kurang dari 30 hari setelah pesan asli dikirim. Acuannya adalah waktu platform menerima request.
- Waktu verifikasi berhasil tidak boleh lebih awal dari waktu pengiriman pesan asli, dan tidak boleh lebih lambat dari waktu platform menerima request ini.
- Setelah pesan tercatat sebagai berhasil diverifikasi melalui API ini atau API Verifikasi OTP, laporan atau verifikasi berikutnya mengembalikan
3012.
Setelah backfill berhasil, platform akan mendorong status pesan yang sesuai menurut Konfigurasi Callback aplikasi.
