Kode error
Kode error API voice (skema kode enam digit terpadu platform) dan penjelasan kode status HTTP autentikasi.
Kode Error Bisnis
API voice mengikuti spesifikasi kode error terpadu platform InnoPaas (enam digit PPNNNN): dua digit pertama adalah domain error, empat digit berikutnya adalah nomor urut. Status HTTP respons adalah 200 dan hasil bisnis ditentukan oleh code pada body respons (000000 berarti sukses); kecuali kegagalan validasi batasan parameter (lihat HTTP 400 di bawah).
Kode umum platform
| code | Penjelasan | Skenario Voice |
|---|---|---|
| 010002 | Parameter wajib tidak disertakan | Permintaan kekurangan field wajib sesuai konteks |
| 010003 | Nilai parameter tidak valid | Format/nilai field ilegal, validasi lintas field tidak lolos (waktu jendela terjadwal tidak valid, tugas non-terjadwal menyertakan field waktu, field SMS hang-up tidak lengkap, destinations melebihi batas, negara template tanpa pemetaan, dll.) |
| 010005 | Resource tidak ditemukan atau tidak dapat diakses | Template tidak ditemukan atau bukan milik akun saat ini |
| 010006 | Konflik status resource | Penambahan duplikat, dll. |
| 010012 | Jumlah batch melebihi batas | Lebih dari 1000 penerima per permintaan |
| 020002 | API Key tidak valid atau kedaluwarsa | Autentikasi tidak lolos |
| 030001 | Saldo tersedia tidak cukup | Pra-potongan biaya penagihan gagal (saldo) |
| 030002 | Kredit tersedia tidak cukup | Pra-potongan biaya penagihan gagal (kredit) |
| 040001 | Frekuensi permintaan API melebihi batas | Permintaan kueri terlalu sering (kueri catatan 30 QPS) |
| 050001 | Error internal platform | Error pada rantai panggilan/query (message mungkin memuat informasi mentah dari gateway dengan prefiks [gateway]) |
| 050002 | Layanan sementara tidak tersedia | Layanan belum tersedia; silakan coba lagi nanti |
Kode khusus Voice (12xxxx)
| code | Penjelasan | Tindakan yang Disarankan |
|---|---|---|
| 120001 | Jumlah whitelist pengujian melebihi batas | Bersihkan whitelist pengujian lalu coba lagi |
| 120002 | Nomor tidak ada di whitelist pengujian | Tambahkan nomor ke whitelist pengujian (alur quick-start Console) |
| 120003 | Nomor tidak cocok dengan kode negara template | Nomor penerima harus diawali kode panggilan negara template (format E.164); lihat Kode Negara/Wilayah |
| 120004 | Template belum lolos review | Gunakan template yang telah disetujui (cek status review di Manajemen Template) |
| 120005 | Negara tidak memiliki rute yang tersedia | Belum ada rute tersedia untuk negara/wilayah; hubungi tim operasional untuk mengaktifkan |
Kode Status HTTP
Kegagalan autentikasi dan kontrol akses langsung mengembalikan kode status HTTP (tanpa envelope respons seperti di atas):
| Kode Status HTTP | Skenario | Penjelasan |
|---|---|---|
| 400 | Gagal validasi batasan parameter | Format/nilai field melanggar batasan (mis. destinations kosong, messages lebih dari 1 entri, body permintaan tidak dapat diparsing); mengembalikan body error standar tanpa envelope code |
| 401 | Kredensial tidak disertakan | Permintaan tidak menyertakan header Authorization |
| 401 | API Key tidak valid | API Key tidak ditemukan atau sudah dihapus |
| 401 | CheckSum belum dibuka | Memanggil dengan metode tanda tangan CheckSum (belum dibuka) |
| 403 | API Key belum berlaku | Akun, API Key, atau otorisasi produk — salah satunya tidak berada dalam status berlaku |
| 403 | IP tidak ada di whitelist | IP egress permintaan tidak ada dalam whitelist API Key; semua permintaan ditolak bila whitelist tidak dikonfigurasi (beberapa catatan whitelist digabungkan/union) |
- HTTP 400 (batasan di tingkat field) dan kode bisnis
010003(aturan lintas field/bisnis) adalah dua bentuk kegagalan yang berbeda; klien harus menangani keduanya. - Whitelist IP wajib ada: tanpa whitelist, semua permintaan ditolak; beberapa catatan digabungkan (union); perubahan berlaku paling lambat 60 detik.
Terakhir diperbarui pada