API des comptes WhatsApp
API de liste des numéros WhatsApp connectés
Obtenez les numéros WhatsApp de votre espace de travail qui sont actuellement connectés. Utilisez-la pour permettre aux utilisateurs de choisir le numéro d'envoi, ou pour trouver l'ID whatsapp_client à utiliser dans les autres appels API.
https://wbiztool.com/api/v1/whatsapp-client/list/Corps: JSON ou champs de formulaire
Seuls les numéros connectés sont renvoyés. Pour voir aussi les numéros déconnectés, utilisez Lister les comptes.
Exemple rapide#
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');
}Remplacez 12345 et YOUR_API_KEY par vos propres valeurs. Consultez Authentification pour savoir où les trouver.
Paramètres de la requête#
client_idintegerobligatoireVotre ID client API, dans Paramètres → Clés API.
api_keystringobligatoireVotre clé API, sur cette même page. La liste porte sur l'espace de travail dans lequel cette clé a été créée.
Utiliser les clients officiels#
Le client Python appelle cet endpoint pour vous.
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"])Le client Python lève requests.exceptions.HTTPError lorsque l'API renvoie le code HTTP 400 ou 403 : encapsulez donc l'appel dans un bloc try/except.
getWhatsAppClients() du client Node.js appelle une adresse qui n'existe pas et échoue avec une erreur 404. Utilisez fetch comme dans l'exemple rapide.
Réponse#
Une requête réussie renvoie le code HTTP 200 :
{
"message": "okay",
"whatsapp_clients": [
{
"id": 678,
"whatsapp_client_id": 678,
"whatsapp_client_number": "919876543210",
"is_connected": true
}
],
"status": 1
}
| Champ | Type | Description |
|---|---|---|
status | integer | 1 en cas de succès, 0 si la requête a échoué. |
message | string | okay en cas de succès, sinon l'erreur. |
whatsapp_clients | array | Vos numéros connectés. Vide si aucun n'est connecté. Présent uniquement en cas de succès. |
whatsapp_clients[].whatsapp_client_id | integer | L'ID du numéro. Transmettez-le comme whatsapp_client dans les autres appels API. |
whatsapp_clients[].id | integer | Même valeur que whatsapp_client_id. |
whatsapp_clients[].whatsapp_client_number | string | Le numéro de téléphone tel qu'il a été enregistré lors de l'ajout du numéro. |
whatsapp_clients[].is_connected | boolean | Toujours true, car seuls les numéros connectés sont listés. |
La liste n'est triée dans aucun ordre garanti. Triez-la par whatsapp_client_id si l'ordre compte.
Erreurs#
| Message | HTTP | Comment corriger |
|---|---|---|
Auth Error | 200 | Envoyez à la fois client_id et api_key dans le corps d'une requête POST, en JSON valide ou en champs de formulaire. |
Invalid Client Id | 403 | Envoyez client_id sous forme de nombre entier, par exemple 12345. |
Auth Error: invalid api key | 400 | Vérifiez que la clé existe, n'a pas été supprimée et appartient à ce client_id. |
Une requête qui n'est pas un POST renvoie un objet vide {}. Un problème serveur inattendu renvoie le code HTTP 500 avec un corps HTML : vérifiez donc que la réponse est du JSON avant de lire status.
Conseils#
- Liste vide :
"whatsapp_clients": []signifie qu'aucun numéro n'est connecté dans cet espace de travail. Connectez-en un dans les paramètres WhatsApp ou avec Connecter un numéro. - Plusieurs espaces de travail : la clé API détermine l'espace de travail listé. Utilisez une clé créée dans l'espace de travail souhaité.
- Un seul numéro : pour vérifier un seul numéro, utilisez Statut de connexion.
