Aller au contenu
Wbiztool

API des comptes WhatsApp

API de statut de connexion WhatsApp

Vérifiez si l'un de vos numéros WhatsApp est connecté et prêt à envoyer des messages. Utilisez-le avant une campagne, ou en attendant qu'un numéro nouvellement connecté termine son association. Utilisez cet endpoint plutôt que /api/v1/whatsapp/status/<id>/, qui ne fonctionne pas.

POSThttps://wbiztool.com/api/v1/whatsapp-client/status/

Corps: JSON ou champs de formulaire

Exemple rapide#

curl -X POST https://wbiztool.com/api/v1/whatsapp-client/status/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678
  }'

Remplacez 12345, YOUR_API_KEY et 678 par vos propres valeurs. Consultez Authentification pour savoir où les trouver.

Paramètres de la requête#

client_idintegerobligatoire

Votre ID client API, dans Paramètres → Clés API.

api_keystringobligatoire

Votre clé API, sur cette même page.

whatsapp_clientintegerobligatoire

ID du numéro WhatsApp à vérifier, issu des paramètres WhatsApp, de Lister les comptes ou du whatsapp_client_id renvoyé par Connecter un numéro.

Utiliser les clients officiels#

Le client Python appelle cet endpoint pour vous.

Python
from wbiztool_client import WbizToolClient

client = WbizToolClient(api_key="YOUR_API_KEY", client_id=12345)

result = client.get_whatsapp_client_status(678)
print(result)

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.

getWhatsAppClientStatus() 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#

Lorsque vos identifiants sont valides, la requête renvoie le code HTTP 200 avec l'un des corps suivants.

Le numéro est connecté :

{ "message": "Connected", "status": 1 }

Le numéro n'est pas connecté :

{ "message": "Disconnected", "status": 0 }
ChampTypeDescription
statusinteger1 si le numéro est connecté. 0 s'il n'est pas connecté ou si la requête a échoué.
messagestringConnected, Disconnected ou l'erreur.

Un numéro que vous avez supprimé des paramètres WhatsApp renvoie également Disconnected.

Erreurs#

MessageHTTPComment corriger
Auth Error200Envoyez client_id, api_key et un whatsapp_client numérique dans le corps d'une requête POST, en JSON valide ou en champs de formulaire.
Invalid Client Id403Envoyez client_id sous forme de nombre entier, par exemple 12345.
Auth Error: invalid api key400Vérifiez que la clé existe, n'a pas été supprimée et appartient à ce client_id.
Auth Error 2200Cet ID whatsapp_client ne fait pas partie de l'espace de travail de cette clé API.
Demo Account can not access apis200Utilisez un compte standard.

Conseils#

  • Avant l'envoi : si le numéro depuis lequel vous envoyez est déconnecté, ses messages restent dans la file d'attente jusqu'à ce qu'il se reconnecte ou qu'ils expirent ; vérifiez donc le statut avant les envois importants. Les messages non envoyés sur un numéro déconnecté sont supprimés au bout de 90 jours.
  • Après la connexion d'un numéro : interrogez cet endpoint toutes les quelques secondes jusqu'à ce qu'il renvoie Connected. Le webhook connected peut arriver quelques secondes avant que cet endpoint ne renvoie Connected : continuez donc à interroger l'endpoint pendant une minute au maximum après l'événement. Consultez Connecter un numéro.
  • Tous les numéros à la fois : pour obtenir le statut de tous vos numéros en un seul appel, utilisez Lister les comptes.