API des comptes WhatsApp
API de liste des comptes WhatsApp
Utilisez cette API pour obtenir en un seul appel la liste complète de tous vos numéros WhatsApp et leur statut de connexion. Contrairement à Lister les numéros connectés, elle inclut les numéros déconnectés.
https://wbiztool.com/api/v1/whatsapp/accounts/Corps: JSON ou champs de formulaire
| Différence | Lister les comptes | Lister les numéros connectés |
|---|---|---|
| Inclut les numéros déconnectés et supprimés | Oui | Non |
| Clés des éléments | whatsapp_client_id, whatsapp_number, status | id, whatsapp_client_id, whatsapp_client_number, is_connected |
message en cas de succès | Absent | okay |
Exemple rapide#
curl -X POST https://wbiztool.com/api/v1/whatsapp/accounts/ \
-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/accounts/",
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 account in result["whatsapp_clients"]:
print(account["whatsapp_client_id"], account["whatsapp_number"], account["status"])
else:
print("Failed:", result.get("message", "no response"))// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/whatsapp/accounts/", {
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 account of result.whatsapp_clients) {
console.log(account.whatsapp_client_id, account.whatsapp_number, account.status);
}
} else {
console.error("Failed:", result.message ?? "no response");
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
];
$ch = curl_init('https://wbiztool.com/api/v1/whatsapp/accounts/');
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 $account) {
echo $account['whatsapp_client_id'] . ' ' . $account['whatsapp_number'] . ' ' . $account['status'] . 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.
Aucun des deux clients officiels n'a de méthode pour cet endpoint : appelez-le donc directement, comme dans les exemples.
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.
Réponse#
Une requête réussie renvoie le code HTTP 200 :
{
"whatsapp_clients": [
{
"whatsapp_client_id": 678,
"whatsapp_number": "919876543210",
"status": "connected"
},
{
"whatsapp_client_id": 702,
"whatsapp_number": "919812345678",
"status": "not_connected"
}
],
"status": 1
}
| Champ | Type | Description |
|---|---|---|
status | integer | 1 en cas de succès, 0 si la requête a échoué. |
whatsapp_clients | array | Tous les numéros WhatsApp ajoutés à cet espace de travail depuis sa création. 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[].whatsapp_number | string | Le numéro de téléphone tel qu'il a été enregistré lors de son ajout. |
whatsapp_clients[].status | string | connected ou not_connected. |
L'ordre de la liste n'est pas garanti. Triez par whatsapp_client_id si l'ordre compte.
Une réponse réussie ne contient pas de champ message : lisez-la donc avec une valeur de repli, comme dans les exemples.
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. |
Si le serveur rencontre un problème inattendu, ou si la requête n'est pas un POST, la réponse est un objet vide : {}. Considérez l'absence de status comme un échec.
Conseils#
- Reconnecter un numéro : un numéro
not_connectedpeut être reconnecté dans les paramètres WhatsApp ou avec Connecter un numéro. - Un seul numéro : pour vérifier un seul numéro, utilisez Statut de connexion.
- 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é.
