Pengembang

GET/v3/lnp/project/{uniqueid}/status

Periksa status proyek pemindahan nomor

Baca ringkasan proyek dan jumlah nomor untuk setiap status tanpa mengambil kredensial penagihan.

Di halaman ini
  1. Akses akun dan proyek
  2. Permintaan
  3. Respons
  4. Ringkasan bukan hasil untuk semua nomor
  5. Memahami status pemindahan nomor
  6. Kesalahan dan batasan
  7. Dampak

Akses akun dan proyek

Gunakan akun API yang diaktifkan melalui HTTPS dari alamat IP yang diizinkan. Proyek harus dimiliki oleh akun tersebut dan tidak boleh sudah dihapus. Gunakan ID unik proyek dari alur pemesanan pemindahan nomor, bukan ID numeriknya di basis data atau nomor telepon. Terapkan pengodean URL pada ID proyek saat menyusun permintaan.

Permintaan

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"

Titik akhir ini tidak membaca isi permintaan, parameter paginasi, atau filter tanggal.

Respons

Contoh respons fiktif.

{
  "status": {
    "code": 200,
    "msg": "Project Status"
  },
  "response": {
    "uniqueid": "PROJECT_EXAMPLE",
    "status": 2,
    "status_str": "Completed",
    "counts": {
      "total": 2,
      "pending": 0,
      "in_progress": 0,
      "completed": 1,
      "rejected": 1
    }
  }
}

Bagian luar status.code melaporkan hasil API. Bagian terpisah response.status merupakan ringkasan pemindahan nomor yang diturunkan dari data proyek. Jangan tertukar antara keduanya.

Ringkasan bukan hasil untuk semua nomor

Ringkasan memilih In Progress jika ada nomor dengan status tersebut; jika tidak, Pending; jika tidak, Completed; dan jika tidak, Rejected. Jika tidak ada status dikenal yang cocok, nilai bawaannya adalah Pending. Karena itu, proyek yang berisi nomor yang pemindahannya selesai sekaligus nomor yang ditolak melaporkan Completed meskipun masih memiliki nomor yang ditolak.

Selalu periksa jumlah dan daftar setiap nomor sebelum menyimpulkan bahwa seluruh proyek telah selesai. counts.total mencakup setiap baris nomor dalam proyek; penghitung lainnya hanya mencakup empat nilai status yang dikenal, sehingga penjumlahannya mungkin tidak sama dengan jumlah total jika ada nilai lain. Proyek tanpa nomor melaporkan semua penghitung bernilai nol dan ringkasan Pending.

Memahami status pemindahan nomor

Nilai status nomor yang dikenal
NilaiLabel
0Pending
1In Progress
2Completed
9Rejected

Pertahankan status numerik dan pastikan nilai yang tidak dikenal tetap dapat ditangani. Untuk label yang tidak dikenal, nilai yang tersimpan digunakan sebagai pengganti; tidak ada jaminan bahwa label baru akan diberikan. Status selesai atau tanggal terjadwal yang tersimpan tidak dengan sendirinya menguji perutean masuk atau setiap layanan pada nomor tersebut.

Kesalahan dan batasan

Periksa respons HTTP serta status.code/status.msg. Proyek yang tidak ada, telah dihapus, atau tidak dimiliki akun tersebut mengembalikan kode API 404 dengan pesan bahwa proyek tidak ditemukan. Autentikasi dan pembatasan alamat IP sumber juga berlaku. Contoh-contoh ini tidak mengirim permintaan secara langsung, dan respons yang berhasil bukan bukti bahwa operator telekomunikasi telah menerima atau menyelesaikan pemindahan nomor.

Dampak

Titik akhir ini membaca jumlah proyek yang tersimpan. Dalam penangan yang telah ditinjau, titik akhir ini tidak mengajukan pemindahan nomor, mengubah status, memulai panggilan, atau mendebit akun. Titik akhir ini tidak menyediakan pemeriksaan berkala ke operator secara waktu nyata maupun langganan webhook.