API pengesahan nombor
Cipta pengesahan nombor WhatsApp (API)
Semak sama ada senarai nombor telefon berdaftar di WhatsApp sebelum anda menghantar mesej kepada mereka. Gunakannya untuk membersihkan senarai kenalan yang diimport, mengesahkan nombor pendaftaran atau membuang nombor yang hanya akan gagal.
https://wbiztool.com/api/v1/verification/create/Body: JSON (application/json)
Permintaan ini mencipta tugas pengesahan dan memulangkan campaign_id serta-merta. Nombor kemudiannya disemak di latar belakang oleh salah satu nombor WhatsApp anda yang disambungkan. Gunakan campaign_id dengan Status pengesahan untuk memantau kemajuan, atau dengan Keputusan pengesahan untuk membaca keputusan.
Contoh ringkas#
curl -X POST https://wbiztool.com/api/v1/verification/create/ \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"campaign_name": "Website leads - September",
"numbers": ["919876543210", "+91 98765 43211", "14155550123"]
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/verification/create/",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={
"campaign_name": "Website leads - September",
"numbers": ["919876543210", "+91 98765 43211", "14155550123"],
},
timeout=60,
)
result = response.json() # read the body even when the HTTP code is 4xx or 5xx
if result["status"] == "success":
print("Task created, campaign_id", result["campaign_id"])
print("Accepted numbers:", result["numbers_submitted"])
else:
print(f"Failed ({response.status_code}):", result["message"])// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/verification/create/", {
method: "POST",
headers: {
Authorization: "Bearer YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({
campaign_name: "Website leads - September",
numbers: ["919876543210", "+91 98765 43211", "14155550123"],
}),
});
const result = await response.json(); // read the body even when the HTTP code is 4xx or 5xx
if (result.status === "success") {
console.log("Task created, campaign_id", result.campaign_id);
console.log("Accepted numbers:", result.numbers_submitted);
} else {
console.error(`Failed (${response.status}):`, result.message);
}<?php
$payload = [
'campaign_name' => 'Website leads - September',
'numbers' => ['919876543210', '+91 98765 43211', '14155550123'],
];
$ch = curl_init('https://wbiztool.com/api/v1/verification/create/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_API_KEY',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
if (($result['status'] ?? '') === 'success') {
echo 'Task created, campaign_id ' . $result['campaign_id'];
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}Gantikan YOUR_API_KEY dengan kunci dari Settings → API keys (Tetapan → Kunci API). Kunci menentukan ruang kerja yang memiliki tugas ini.
Parameter permintaan#
Pengepala
AuthorizationheaderwajibBearer YOUR_API_KEY. Kunci mesti aktif dan belum dipadam.client_idtidak diperlukan untuk API ini.Content-TypestringwajibMesti
application/json. Dengan jenis kandungan lain,numberstidak dibaca dan anda akan menerimaNumbers array is required.
Badan
numbersarray of stringswajibNombor telefon yang hendak disemak, setiap satu dengan kod negaranya, contohnya
919876543210untuk nombor India. Sebelum disemak, setiap nombor dibersihkan:- ruang,
+,-dan kurungan dibuang - satu
0di hadapan dibuang - hasilnya mesti mengandungi digit sahaja dan sekurang-kurangnya 10 digit panjang
Nombor yang tidak lulus ditinggalkan tanpa pemberitahuan. Pendua tidak dibuang, jadi setiap salinan disemak secara berasingan.
- ruang,
campaign_namestringpilihanNama untuk mencari tugas ini dalam papan pemuka. Jika anda tidak menyertakannya, namanya ialah
API Verificationdiikuti tarikh dan masa pelayan dalam IST (UTC+5:30), contohnyaAPI Verification 20260916_154500. Nama boleh sehingga 500 aksara. Jangan hantarnull: nama yang lebih panjang atau null gagal dengan HTTP500.
Respons#
Permintaan yang berjaya memulangkan HTTP 200:
{
"status": "success",
"message": "Verification task created successfully",
"campaign_id": 4521,
"numbers_count": 3,
"numbers_submitted": ["919876543210", "919876543211", "14155550123"]
}
| Medan | Jenis | Penerangan |
|---|---|---|
status | string | "success". Ralat memulangkan "error". |
message | string | Verification task created successfully. |
campaign_id | integer | ID tugas pengesahan. Gunakannya dengan Status pengesahan dan Keputusan pengesahan. |
numbers_count | integer | Bilangan nombor yang diterima selepas pembersihan. |
numbers_submitted | tatasusunan rentetan | Nombor yang telah dibersihkan dan akan disemak. Bandingkan dengan apa yang anda hantar untuk melihat nombor yang digugurkan. |
Setiap nombor yang diterima bermula sebagai pending. Tugas ini juga muncul di halaman Number verification (Pengesahan nombor) dalam papan pemuka anda. Kadnya di sana mungkin terus memaparkan Processing selepas tugas selesai, jadi gunakan Status pengesahan untuk keadaan sebenar.
Ralat#
Ralat memulangkan badan JSON dengan status ditetapkan kepada "error" dan kod ralat HTTP:
{ "status": "error", "message": "No valid phone numbers found" }
| HTTP | Mesej | Cara membetulkannya |
|---|---|---|
405 | Only POST method allowed | Hantar permintaan POST. |
401 | API key required | Tambah pengepala Authorization: Bearer YOUR_API_KEY. |
401 | Invalid API key | Pastikan kunci wujud dan belum dipadam atau dinyahdayakan. |
403 | Verification feature not available for your plan | Pelan anda tidak termasuk pengesahan nombor. Naik taraf pelan anda. |
400 | Numbers array is required | Hantar numbers sebagai tatasusunan JSON yang tidak kosong, dengan Content-Type: application/json. |
400 | No valid phone numbers found | Tiada nombor yang mempunyai 10 digit atau lebih selepas pembersihan. Sertakan kod negara. |
400 | Request contains N numbers but your plan allows only M verifications | Pelan anda mengehadkan bilangan nombor dalam satu permintaan. Pecahkan senarai kepada permintaan yang lebih kecil. |
500 | Internal server error: … | Biasanya badan JSON tidak sah, contohnya kerana koma di hujung. |
Cara nombor disemak#
Tugas dimasukkan ke dalam baris gilir
API menyimpan setiap nombor yang diterima sebagai
pendingdan memberi respons serta-merta.Nombor WhatsApp yang disambungkan menyemaknya
Nombor disemak sehingga 10 pada satu masa menggunakan nombor WhatsApp yang disambungkan di tetapan WhatsApp. Setiap nombor menjadi
verifiedjika ia berdaftar di WhatsApp, atauinvalidjika tidak. Semakan hanya dijalankan pada nombor yang disambungkan dan tidak sibuk menghantar mesej, jadi semasa kempen besar, semakan mungkin menunggu sehingga penghantaran selesai.Anda membaca keputusannya
Tinjau Status pengesahan sehingga
overall_statusialahcompleted, kemudian baca nombor daripada respons yang sama atau daripada Keputusan pengesahan.
Petua#
- Sentiasa sertakan kod negara. Nombor tempatan 10 digit tanpanya lulus semakan panjang, tetapi ia disemak tepat seperti yang ditulis, jadi keputusannya bukan untuk nombor yang anda maksudkan.
- Jangan gunakan awalan antarabangsa
00. Hanya satu0di hadapan dibuang, jadi00919876543210disemak sebagai0919876543210. Hantar919876543210. - Buang pendua sendiri sebelum menghantar, supaya anda tidak membazirkan had setiap permintaan pelan anda untuk nombor berulang.
- Semak
numbers_submitteduntuk mencari nombor yang digugurkan kerana terlalu pendek atau mengandungi huruf. - Senarai besar: jika anda mencapai had setiap permintaan, hantar beberapa tugas yang lebih kecil dan jejaki setiap
campaign_id.
Baru menggunakan pengesahan nombor? Lihat panduan Pengesahan nombor.
