Langkau ke kandungan
WbizTool

API v2 (beta)

Semakan nombor

Semakan nombor mengetahui nombor telefon mana yang mempunyai akaun WhatsApp, tanpa menghantar apa-apa kepadanya. Bersihkan senarai sebelum kempen, atau semak nombor pendaftar sebelum anda menghantar mesej kepadanya. Semakan yang dicipta dengan API sama seperti senarai di halaman Pengesahan nombor dalam papan pemuka.

OperasiEndpointSkop
Mulakan semakanPOST /api/v2/number-checkscontacts
Senaraikan semakanGET /api/v2/number-checkscontacts
Dapatkan semakanGET /api/v2/number-checks/{id}contacts
Dapatkan keputusanGET /api/v2/number-checks/{id}/resultscontacts

Memulakan semakan memerlukan pelan yang merangkumi pengesahan nombor; jika tidak, ia menjawab 403 plan_required. Membaca semakan berfungsi pada mana-mana pelan.

Mulakan semakan#

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

Body: JSON (application/json)

Nombor dimasukkan ke dalam baris gilir, dan responsnya ialah 201 dengan semakan berstatus pending. Nombor WhatsApp ruang kerja anda yang disambungkan menyemaknya dalam beberapa minit seterusnya. Tinjau semakan sehingga status ialah completed, kemudian baca keputusannya.

Badan

numbersarray of stringswajib

Nombor untuk disemak, 1 hingga 10,000 entri. Tulisnya dalam format antarabangsa dengan + (+919876543210). Nombor tanpa kod negaranya mendapat kod negara ruang kerja. Nombor berulang disemak sekali, dan entri yang bukan nombor telefon dilangkau.

namestringpilihan

Nama untuk semakan, sehingga 500 aksara, seperti yang dipaparkan di halaman Pengesahan nombor. Lalai: API check diikuti tarikh dan masa 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 ialah bilangan entri yang bukan nombor telefon (teks, kurang daripada 7 atau lebih daripada 15 digit): ia tidak disemak dan tidak dikira dalam pelan anda.

Had pelan#

Pelan anda menetapkan berapa banyak nombor yang boleh anda semak (lihat Had pelan):

  • Bagi setiap semakan: satu semakan tidak boleh mempunyai lebih banyak nombor daripada had pelan. Jika melebihinya, semakan ditolak dengan too_many_numbers, bersama count dan limit.
  • Bagi setiap tempoh pengebilan: semua semakan bersama-sama, dari API dan papan pemuka, juga tidak boleh melebihinya. Semakan yang akan melebihinya ditolak dengan number_check_quota_reached, bersama requested, used dan limit.
  • Pelan tanpa had tidak mempunyai kedua-duanya. API menerima paling banyak 10,000 nombor bagi setiap permintaan, tidak kira pelannya.
  • Semakan yang ditolak tidak memasukkan apa-apa ke dalam baris gilir. Pecahkan senarai, tunggu tempoh seterusnya, atau naik taraf.

Ralat semasa memulakan semakan#

HTTPKodBila
400validation_failednumbers tiada, kosong atau bukan senarai rentetan, atau name kosong atau terlalu panjang
403plan_requiredPelan tidak merangkumi pengesahan nombor
422no_valid_numbersTiada satu pun entri ialah nombor telefon; skipped menyatakan berapa banyak entri yang ada
422too_many_numbersLebih daripada 10,000 entri, atau lebih banyak nombor daripada yang dibenarkan oleh pelan bagi setiap semakan
422number_check_quota_reachedSemakan akan melebihi kuota nombor pelan untuk tempoh pengebilan ini

Senaraikan semakan#

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

Semakan ruang kerja, yang terbaharu dahulu, dalam halaman (limit 1 hingga 100, lalai 25, dan cursor), termasuk yang dimulakan dalam papan pemuka. Setiap satu ialah Number check.

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

Dapatkan semakan#

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

Semakan dan kemajuannya. Tinjaunya kira-kira setiap 30 saat sehingga status ialah 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"
}

Semakan yang tidak wujud menjawab 404 number_check_not_found.

Semakan memerlukan nombor WhatsApp ruang kerja yang disambungkan dengan kod QR atau kod pautan, dan menunggu semasa nombor anda sedang menghantar. Semakan boleh kekal pending atau processing untuk seketika; lihat Cara semakan berfungsi.

Dapatkan keputusan#

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

Nombor dalam semakan dan apa yang ditemui, dalam halaman (limit 1 hingga 100, lalai 25, dan cursor). Anda boleh membacanya semasa semakan berjalan: nombor yang belum disemak ialah 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
}
MedanJenisPenerangan
numberstringNombor yang disemak: digitnya dengan kod negara, tanpa +.
on_whatsappboolean or nulltrue atau false setelah disemak; null semasa menunggu atau apabila dibatalkan.
statusstringpending, on_whatsapp, not_on_whatsapp atau cancelled (dihentikan sebelum disemak).
checked_atstring or nullBila ia disemak.

Objek Number check#

MedanJenisPenerangan
idintegerID semakan.
namestringNamanya.
statusstringpending (belum ada yang disemak), processing (sebahagian telah disemak) atau completed (tiada lagi yang perlu disemak).
countsobjecttotal, pending, on_whatsapp, not_on_whatsapp dan cancelled.
created_atstringBila ia dimulakan.
skippedintegerHanya dalam respons kepada Mulakan semakan: entri yang bukan nombor telefon.

Berkaitan#