Aller au contenu
WbizTool

Premiers pas

Premiers pas avec l'API WbizTool

L'API REST de WbizTool permet à votre logiciel d'envoyer des messages WhatsApp depuis votre propre numéro WhatsApp connecté. Utilisez-la pour envoyer des suivis de commande, des rappels et des alertes depuis votre application, votre CRM, votre site web ou votre outil d'automatisation.

Cette page présente ce dont chaque requête a besoin. Pour envoyer votre premier message, passez directement à Envoyer un message.

URL de base#

Tous les endpoints se trouvent sous :

https://wbiztool.com/api/v1/

La plupart des endpoints acceptent les requêtes POST. Vous pouvez envoyer le corps en JSON (application/json) ou sous forme de champs de formulaire (application/x-www-form-urlencoded). Pour téléverser un fichier, utilisez multipart/form-data. Quelques endpoints de lecture utilisent GET ; la page de chaque endpoint indique sa méthode.

Avant de commencer#

  1. Créez un compte sur wbiztool.com/signup. Les nouveaux comptes incluent 50 messages gratuits.
  2. Connectez un numéro WhatsApp. Ouvrez Numéros WhatsApp, cliquez sur Ajouter un numéro et scannez le QR code depuis WhatsApp sur votre téléphone.
  3. Créez une clé API. Rendez-vous dans Paramètres → Clés API. Seul le propriétaire d'un espace de travail peut créer des clés. Chaque espace de travail peut avoir jusqu'à 10 clés.

Authentification#

Envoyez votre clé API dans un en-tête Authorization: Bearer sur chaque requête (recommandé). La clé désigne son espace de travail, donc client_id n'est alors pas nécessaire. Les identifiants dans le corps (client_id et api_key en JSON ou en champs de formulaire) continuent de fonctionner sur tous les endpoints. Si les deux sont envoyés, une clé valide dans l'en-tête est utilisée. Consultez Envoyer la clé dans un en-tête.

Authorization: Bearer YOUR_API_KEY
api_keystringobligatoire

L'une de vos clés API, dans Paramètres → Clés API, dans l'en-tête Authorization: Bearer ou dans le corps. Gardez-la secrète : toute personne disposant de la clé peut envoyer des messages depuis vos numéros.

client_idintegerSeulement avec la clé dans le corps

Votre ID client API, affiché sur cette même page.

whatsapp_clientintegerLa plupart des endpoints de messagerie

L'ID du numéro WhatsApp depuis lequel envoyer, affiché sous la forme ID … ⧉ sur la carte du numéro dans Numéros WhatsApp (cliquez dessus pour le copier). La page de chaque endpoint indique s'il est nécessaire.

La clé API détermine l'espace de travail sur lequel agit une requête. Si vous appartenez à plusieurs espaces de travail, utilisez une clé créée dans l'espace de travail depuis lequel vous souhaitez envoyer.

Si une clé est divulguée, supprimez-la sur la page des clés API. Les clés supprimées cessent immédiatement de fonctionner.

Votre première requête#

Cette requête envoie un message texte depuis votre numéro connecté. Remplacez les ID, la clé et le numéro de téléphone par les vôtres.

curl -X POST https://wbiztool.com/api/v1/send_msg/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Hi Aman, your order #4821 has shipped and will arrive on Thursday."
  }'

Une réponse "status": 1 avec un msg_id signifie que le message est en file d'attente. Envoyer un message explique chaque paramètre et propose des versions Python, Node.js et PHP.

Réponses et erreurs#

Chaque réponse est un objet JSON comportant un champ status (sauf le contrôle de disponibilité /api/v1/status/, qui renvoie "status": 200) :

  • "status": 1 signifie que la requête a réussi.
  • "status": 0 signifie qu'elle a échoué. Le champ message en indique la raison.
{ "status": 0, "message": "Auth Error: invalid api key" }

Erreurs d'authentification courantes :

MessageSignification
Auth Errorclient_id ou api_key est absent, le corps n'est ni du JSON valide ni des données de formulaire, ou la requête n'était pas un POST.
Auth Error - Please send correct API key and Client idapi_key est absent ou vide.
Invalid client id. ou Invalid Client Idclient_id n'est pas un nombre entier (ou, sur certains endpoints, est absent). Envoyez-le sous forme de nombre, par exemple 12345.
Auth Error: invalid api keyLa clé n'existe pas, a été supprimée ou n'appartient pas à ce client_id.
Demo Account can not access apisLes comptes de démonstration ne peuvent pas utiliser l'API.
Not enough creditsL'espace de travail est sur le forfait gratuit et n'a plus de messages : les forfaits payants envoient des messages illimités. Voir Quand il ne reste plus de messages.
Daily limit reached: … (HTTP 429, "code": "daily_limit_reached")Le numéro WhatsApp a pris 1 000 messages au cours des dernières 24 heures (usage raisonnable). Envoyez le reste plus tard ou depuis un autre numéro.

Cycle de vie d'un message#

Les messages que vous envoyez via l'API sont d'abord mis en file d'attente, puis envoyés depuis votre numéro WhatsApp. Chaque message a l'un des statuts suivants :

StatutNomSignification
0Created (créé)En file d'attente, en attente d'envoi.
1Sent (envoyé)Envoyé depuis votre numéro WhatsApp.
2Failed (échec)N'a pas pu être envoyé, par exemple parce que le numéro n'est pas sur WhatsApp.
3Cancelled (annulé)Annulé avant d'être envoyé.
4Expired (expiré)Non envoyé avant son délai expire_after_seconds.

Votre numéro WhatsApp doit rester connecté pour que les messages en file d'attente partent. 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. Les messages non envoyés d'un numéro déconnecté sont supprimés au bout de 90 jours.

Pour suivre un message, enregistrez le msg_id de la réponse, puis transmettez une URL webhook lors de l'envoi ou appelez Statut du message.

Bibliothèques clientes officielles#

Des wrappers pour Python et Node.js gèrent pour vous l'authentification et le téléversement de fichiers. Ils ne couvrent pas encore correctement tous les endpoints : vérifiez donc la page de chaque endpoint avant de vous fier à une méthode d'un client.

pip install wbiztool-client

Vous préférez une configuration sans code ? Consultez Applications et intégrations pour Zapier, n8n, Make, Pabbly Connect, Google Sheets, Shopify et WordPress.

Parcourir la documentation#