Langsung ke konten
WbizTool

API v2 (beta)

Pemeriksaan nomor

Pemeriksaan nomor mencari tahu nomor telepon mana yang memiliki akun WhatsApp, tanpa mengirim apa pun ke nomor-nomor tersebut. Bersihkan daftar sebelum kampanye, atau periksa nomor pendaftar sebelum Anda mengirim pesan. Pemeriksaan yang dibuat dengan API sama dengan daftar di halaman Verifikasi nomor di dashboard.

OperasiEndpointScope
Memulai pemeriksaanPOST /api/v2/number-checkscontacts
Daftar pemeriksaanGET /api/v2/number-checkscontacts
Mengambil pemeriksaanGET /api/v2/number-checks/{id}contacts
Mengambil hasilGET /api/v2/number-checks/{id}/resultscontacts

Memulai pemeriksaan memerlukan paket yang mencakup verifikasi nomor; jika tidak, dijawab dengan 403 plan_required. Membaca pemeriksaan berfungsi di paket apa pun.

Memulai pemeriksaan#

POSThttps://wbiztool.com/api/v2/number-checks

Body: JSON (application/json)

Nomor-nomor masuk antrean, dan responsnya 201 dengan pemeriksaan berstatus pending. Nomor WhatsApp yang terhubung di workspace Anda memeriksanya dalam beberapa menit berikutnya. Lakukan polling pemeriksaan sampai status bernilai completed, lalu baca hasilnya.

Body

numbersarray of stringswajib

Nomor yang akan diperiksa, 1 hingga 10.000 entri. Tulis dalam format internasional dengan + (+919876543210). Nomor tanpa kode negara mendapat kode negara workspace. Nomor yang berulang diperiksa sekali, dan entri yang bukan nomor telepon dilewati.

namestringopsional

Nama pemeriksaan, hingga 500 karakter, seperti yang tampil di halaman Verifikasi nomor. Default: API check diikuti tanggal dan waktu dalam UTC, seperti API check 2026-10-18 10:40.

curl -X POST https://wbiztool.com/api/v2/number-checks \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: october-leads" \
  -d '{
    "name": "October leads",
    "numbers": ["+919876543210", "+447700900123", "+14155550123"]
  }'

Respons (201):

{
  "id": 51207,
  "name": "October leads",
  "status": "pending",
  "counts": { "total": 3, "pending": 3, "on_whatsapp": 0, "not_on_whatsapp": 0, "cancelled": 0 },
  "created_at": "2026-10-18T10:40:02.511Z",
  "skipped": 0
}

skipped adalah jumlah entri yang bukan nomor telepon (teks, kurang dari 7 atau lebih dari 15 digit): entri ini tidak diperiksa dan tidak dihitung dalam paket Anda.

Batas paket#

Paket Anda menentukan berapa banyak nomor yang dapat Anda periksa (lihat Batas paket):

  • Per pemeriksaan: satu pemeriksaan tidak boleh berisi lebih banyak nomor daripada batas paket. Jika melewatinya, pemeriksaan ditolak dengan too_many_numbers, beserta count dan limit.
  • Per periode penagihan: semua pemeriksaan bersama-sama, dari API dan dashboard, juga tidak boleh melewatinya. Pemeriksaan yang akan melewatinya ditolak dengan number_check_quota_reached, beserta requested, used, dan limit.
  • Paket tanpa batas tidak memiliki keduanya. API menerima paling banyak 10.000 nomor per request, apa pun paketnya.
  • Pemeriksaan yang ditolak tidak memasukkan apa pun ke antrean. Pecah daftarnya, tunggu periode berikutnya, atau tingkatkan paket.

Error saat memulai pemeriksaan#

HTTPKodeKapan
400validation_failednumbers tidak ada, kosong, atau bukan daftar string, atau name kosong atau terlalu panjang
403plan_requiredPaket tidak mencakup verifikasi nomor
422no_valid_numbersTidak ada entri yang berupa nomor telepon; skipped menunjukkan jumlah entrinya
422too_many_numbersLebih dari 10.000 entri, atau lebih banyak nomor daripada yang diizinkan paket per pemeriksaan
422number_check_quota_reachedPemeriksaan akan melewati jatah nomor paket untuk periode penagihan ini

Daftar pemeriksaan#

GEThttps://wbiztool.com/api/v2/number-checks

Pemeriksaan workspace, yang terbaru lebih dulu, dalam halaman (limit 1 hingga 100, default 25, dan cursor), termasuk yang dimulai di dashboard. Masing-masing berupa Number check.

curl https://wbiztool.com/api/v2/number-checks \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"

Mengambil pemeriksaan#

GEThttps://wbiztool.com/api/v2/number-checks/{id}

Pemeriksaan beserta progresnya. Lakukan polling kira-kira setiap 30 detik sampai status bernilai completed.

curl https://wbiztool.com/api/v2/number-checks/51207 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "id": 51207,
  "name": "October leads",
  "status": "processing",
  "counts": { "total": 3, "pending": 1, "on_whatsapp": 1, "not_on_whatsapp": 1, "cancelled": 0 },
  "created_at": "2026-10-18T10:40:02.511Z"
}

Pemeriksaan yang tidak ada dijawab dengan 404 number_check_not_found.

Pemeriksaan memerlukan nomor WhatsApp workspace yang terhubung dengan kode QR atau kode penautan, dan menunggu selama nomor Anda sedang mengirim. Pemeriksaan dapat tetap pending atau processing selama beberapa waktu; lihat Cara kerja pemeriksaan.

Mengambil hasil#

GEThttps://wbiztool.com/api/v2/number-checks/{id}/results

Nomor-nomor dalam pemeriksaan dan hasilnya, dalam halaman (limit 1 hingga 100, default 25, dan cursor). Anda dapat membacanya selama pemeriksaan berjalan: nomor yang belum diperiksa bernilai pending.

curl "https://wbiztool.com/api/v2/number-checks/51207/results?limit=100" \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "data": [
    { "number": "14155550123", "on_whatsapp": null, "status": "pending", "checked_at": null },
    { "number": "447700900123", "on_whatsapp": false, "status": "not_on_whatsapp", "checked_at": "2026-10-18T10:42:57.204Z" },
    { "number": "919876543210", "on_whatsapp": true, "status": "on_whatsapp", "checked_at": "2026-10-18T10:42:51.880Z" }
  ],
  "next_cursor": null
}
FieldJenisKeterangan
numberstringNomor yang diperiksa: digitnya dengan kode negara, tanpa +.
on_whatsappboolean or nulltrue atau false setelah diperiksa; null selama masih menunggu atau jika dibatalkan.
statusstringpending, on_whatsapp, not_on_whatsapp, atau cancelled (dihentikan sebelum diperiksa).
checked_atstring or nullKapan nomor diperiksa.

Objek Number check#

FieldJenisKeterangan
idintegerID pemeriksaan.
namestringNamanya.
statusstringpending (belum ada yang diperiksa), processing (sebagian sudah diperiksa), atau completed (tidak ada lagi yang perlu diperiksa).
countsobjecttotal, pending, on_whatsapp, not_on_whatsapp, dan cancelled.
created_atstringKapan pemeriksaan dimulai.
skippedintegerHanya di respons Memulai pemeriksaan: entri yang bukan nomor telepon.

Terkait#