WhatsApp-Konten-API
Verbundene Nummern auflisten (API)
Rufen Sie die WhatsApp-Nummern in Ihrem Arbeitsbereich ab, die gerade verbunden sind. Nutzen Sie die API, damit Nutzer auswählen können, von welcher Nummer gesendet wird, oder um die whatsapp_client-ID für andere API-Aufrufe zu finden.
https://wbiztool.com/api/v1/whatsapp-client/list/Body: JSON oder Formularfelder
Es werden nur verbundene Nummern zurückgegeben. Um auch getrennte Nummern zu sehen, verwenden Sie Konten auflisten.
Kurzes Beispiel#
curl -X POST https://wbiztool.com/api/v1/whatsapp-client/list/ \
-H "Content-Type: application/json" \
-d '{
"client_id": 12345,
"api_key": "YOUR_API_KEY"
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/whatsapp-client/list/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
},
timeout=30,
)
result = response.json() # read the body even when the HTTP code is 400 or 403
if result.get("status") == 1:
for number in result["whatsapp_clients"]:
print(number["whatsapp_client_id"], number["whatsapp_client_number"])
else:
print("Failed:", result.get("message"))// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/whatsapp-client/list/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
}),
});
const result = await response.json(); // read the body even when the HTTP code is 400 or 403
if (result.status === 1) {
for (const number of result.whatsapp_clients) {
console.log(number.whatsapp_client_id, number.whatsapp_client_number);
}
} else {
console.error("Failed:", result.message);
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
];
$ch = curl_init('https://wbiztool.com/api/v1/whatsapp-client/list/');
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) {
foreach ($result['whatsapp_clients'] as $number) {
echo $number['whatsapp_client_id'] . ' ' . $number['whatsapp_client_number'] . PHP_EOL;
}
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}Ersetzen Sie 12345 und YOUR_API_KEY durch Ihre eigenen Werte. Wo Sie diese finden, steht unter Authentifizierung.
Request-Parameter#
client_idintegererforderlichIhre API-Client-ID aus Einstellungen → API-Schlüssel.
api_keystringerforderlichIhr API-Schlüssel von derselben Seite. Die Liste gilt für den Arbeitsbereich, in dem dieser Schlüssel erstellt wurde.
Offizielle Clients verwenden#
Der Python-Client ruft diesen Endpoint für Sie auf.
from wbiztool_client import WbizToolClient
client = WbizToolClient(api_key="YOUR_API_KEY", client_id=12345)
result = client.list_whatsapp_clients()
for number in result.get("whatsapp_clients", []):
print(number["whatsapp_client_id"], number["whatsapp_client_number"])Der Python-Client löst requests.exceptions.HTTPError aus, wenn die API HTTP 400 oder 403 zurückgibt. Umschließen Sie den Aufruf daher mit try/except.
getWhatsAppClients() im Node.js-Client ruft eine Adresse auf, die nicht existiert, und schlägt mit 404 fehl. Verwenden Sie fetch wie im Kurzen Beispiel.
Antwort#
Ein erfolgreicher Request gibt HTTP 200 zurück:
{
"message": "okay",
"whatsapp_clients": [
{
"id": 678,
"whatsapp_client_id": 678,
"whatsapp_client_number": "919876543210",
"is_connected": true
}
],
"status": 1
}
| Feld | Typ | Beschreibung |
|---|---|---|
status | integer | 1 bei Erfolg, 0, wenn der Request fehlgeschlagen ist. |
message | string | okay bei Erfolg, andernfalls der Fehler. |
whatsapp_clients | array | Ihre verbundenen Nummern. Leer, wenn keine verbunden ist. Nur bei Erfolg vorhanden. |
whatsapp_clients[].whatsapp_client_id | integer | Die ID der Nummer. Übergeben Sie sie in anderen API-Aufrufen als whatsapp_client. |
whatsapp_clients[].id | integer | Derselbe Wert wie whatsapp_client_id. |
whatsapp_clients[].whatsapp_client_number | string | Die Telefonnummer, wie sie beim Hinzufügen der Nummer gespeichert wurde. |
whatsapp_clients[].is_connected | boolean | Immer true, da nur verbundene Nummern aufgelistet werden. |
Die Liste hat keine garantierte Reihenfolge. Sortieren Sie nach whatsapp_client_id, wenn die Reihenfolge wichtig ist.
Fehler#
| Meldung | HTTP | Lösung |
|---|---|---|
Auth Error | 200 | Senden Sie client_id und api_key in einem POST-Body, als gültiges JSON oder als Formularfelder. |
Invalid Client Id | 403 | Senden Sie client_id als ganze Zahl, zum Beispiel 12345. |
Auth Error: invalid api key | 400 | Prüfen Sie, ob der Schlüssel existiert, nicht gelöscht wurde und zu dieser client_id gehört. |
Ein Request, der kein POST ist, liefert ein leeres Objekt {}. Ein unerwartetes Serverproblem liefert HTTP 500 mit einem HTML-Body. Prüfen Sie daher, ob die Antwort JSON ist, bevor Sie status auslesen.
Tipps#
- Leere Liste:
"whatsapp_clients": []bedeutet, dass in diesem Arbeitsbereich keine Nummer verbunden ist. Verbinden Sie eine in den WhatsApp-Einstellungen oder mit Nummer verbinden. - Mehrere Arbeitsbereiche: Der API-Schlüssel bestimmt, welcher Arbeitsbereich aufgelistet wird. Verwenden Sie einen Schlüssel, der im gewünschten Arbeitsbereich erstellt wurde.
- Nur eine Nummer: Um eine einzelne Nummer zu prüfen, verwenden Sie Verbindungsstatus.
