Bermula
API Semak Kelayakan
Gunakan API ini untuk mengesahkan kelayakan anda sebelum membuat panggilan API lain. Ia memastikan bahawa client_id dan api_key anda berfungsi bersama dan, secara pilihan, bahawa ID nombor WhatsApp milik ruang kerja anda. Ia tidak menghantar apa-apa dan tidak dikira sebagai mesej.
https://wbiztool.com/api/v1/me/Body: JSON atau medan borang
Contoh ringkas#
curl -X POST https://wbiztool.com/api/v1/me/ \
-H "Content-Type: application/json" \
-d '{
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"whatsapp_client": 678
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/me/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"whatsapp_client": 678,
},
timeout=30,
)
result = response.json() # read the body even when the HTTP code is 400
if result["status"] == 1:
print("Credentials OK for", result["name"])
else:
print("Failed:", 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/me/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
whatsapp_client: 678,
}),
});
const result = await response.json(); // read the body even when the HTTP code is 400
if (result.status === 1) {
console.log("Credentials OK for", result.name);
} else {
console.error("Failed:", result.message);
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
'whatsapp_client' => 678,
];
$ch = curl_init('https://wbiztool.com/api/v1/me/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
if (($result['status'] ?? 0) === 1) {
echo 'Credentials OK for ' . $result['name'];
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}Gantikan 12345, YOUR_API_KEY dan 678 dengan nilai anda sendiri. Jangan sertakan whatsapp_client jika anda hanya mahu menguji kunci. Lihat Pengesahan identiti untuk mengetahui di mana nilai ini boleh didapati.
Parameter permintaan#
AuthorizationheaderDisyorkanBearer YOUR_API_KEY: kunci API anda dari Tetapan → Kunci API. Dengan pengepala ini,client_iddanapi_keyboleh ditinggalkan daripada badan; jika kedua-duanya dihantar, kunci sah dalam pengepala yang digunakan. Lihat Hantar kunci dalam pengepala.client_idintegerTanpa pengepala AuthorizationAPI Client ID anda dari Tetapan → Kunci API. Pilihan dengan pengepala; jika anda menghantarnya, ia mestilah Client ID ruang kerja kunci itu.
api_keystringTanpa pengepala AuthorizationKunci API anda dari halaman yang sama, apabila anda tidak menghantarnya dalam pengepala.
whatsapp_clientintegerpilihanID salah satu nombor WhatsApp anda, dari tetapan WhatsApp. Hantarkannya untuk turut menyemak bahawa ID itu milik ruang kerja kunci API ini. Nombor yang telah anda padam dari papan pemuka tetap lulus semakan ini. Ia hanya menyemak ID; ia tidak memberitahu anda sama ada nombor itu disambungkan. Gunakan Status sambungan untuk itu.
Respons#
Permintaan yang berjaya memulangkan HTTP 200:
{
"status": 1,
"message": "Okay",
"name": "[email protected] - 919876543210"
}
| Medan | Jenis | Penerangan |
|---|---|---|
status | integer | 1 jika kelayakan sah, 0 jika tidak. |
message | string | Okay jika berjaya, jika tidak, mesej ralat. |
name | string | Nama pengguna orang yang mencipta ruang kerja. Jika anda menghantar whatsapp_client, nombor telefon nombor itu ditambah selepas -. Hanya ada jika berjaya. |
Ralat#
Setiap kegagalan pada endpoint ini memulangkan HTTP 400 (permintaan GET mendapat 405, ralat dalaman 500). Badan respons sentiasa mempunyai status ditetapkan kepada 0:
{ "status": 0, "message": "Auth Error: invalid api key" }
| Mesej | Cara membetulkannya |
|---|---|
Auth Error - Please send correct API key and Client id | Hantar kedua-dua client_id dan api_key dalam badan POST, sebagai JSON atau medan borang yang sah. |
Invalid client id. | Hantar client_id sebagai nombor, seperti 12345. |
Auth Error: invalid api key | Pastikan kunci wujud, belum dipadam dan milik client_id ini: Client ID pada tab Kunci API. |
This API key is not linked to a workspace. Create a new API key in WbizTool. | Kunci itu berasal daripada persediaan akaun lama. Cipta kunci baharu pada tab Kunci API. |
Invalid WhatsApp Client ID | whatsapp_client itu bukan nombor, atau bukan nombor dalam ruang kerja kunci ini. Salin ID … ⧉ nombor itu dari Nombor WhatsApp. |
Method not allowed, use POST | Hantar permintaan POST (HTTP 405). |
Menyemak sama ada API aktif#
/api/v1/status/ ialah semakan keaktifan yang ringkas. Ia tidak memerlukan kelayakan, menerima apa-apa kaedah dan sentiasa memulangkan:
{ "status": 200, "data": {} }
Ia hanya memberitahu anda bahawa API boleh dicapai. Ia tidak menyemak kelayakan anda atau sama ada nombor WhatsApp anda disambungkan.
curl https://wbiztool.com/api/v1/status/
health_check() klien Python memanggil endpoint ini.
Petua#
- Semak sekali semasa persediaan: panggil endpoint ini apabila pengguna menyimpan kelayakan mereka dalam aplikasi anda, bukan sebelum setiap mesej. Semakan yang berjaya tidak bermaksud anda boleh menghantar: ia tidak melihat mesej pelan anda atau sama ada nombor anda disambungkan.
- Baca badan respons apabila berlaku ralat: kegagalan dipulangkan sebagai HTTP
400, jadi pastikan klien HTTP anda masih menghuraikan badan JSON. - Kunci yang dipadam berhenti berfungsi serta-merta: jika kunci telah dipadam di halaman kunci API, anda akan menerima
Auth Error: invalid api key. - Langkah seterusnya: setelah kelayakan anda berfungsi, hantar mesej.

