Numéros
API avancée
Groupes, chaînes, sondages, contacts, étiquettes : tout ce que permet votre numéro WhatsApp, depuis une seule route.
L'API avancée donne accès à toutes les fonctions de votre numéro dédié : créer et gérer des groupes, publier sur une chaîne, envoyer un sondage ou une position, vérifier qu'un numéro a WhatsApp, gérer vos contacts et vos étiquettes, et bien plus.
Elle est incluse dans les forfaits qui comprennent un numéro dédié, et ne fonctionne qu'avec vos numéros : les numéros Flare n'y sont jamais exposés.
Le principe
Une seule route, qui relaie votre requête vers votre numéro :
https://flare.zola-labs.com/v1/senders/{id}/wa/{chemin}
{id}: l'identifiant de votre numéro, donné parGET /v1/senders.{chemin}: l'opération voulue, par exemplegroupsoumessages/send-poll.- La méthode HTTP (
GET,POST,PUT,PATCH,DELETE), les paramètres et le corps JSON sont transmis tels quels ; la réponse vous revient telle quelle, avec son code HTTP.
Les familles d'opérations ouvertes sont : messages, groups, chats, contacts, labels, channels, profile, presence, status, media, catalog, calls et automation-rules.
Note : les messages envoyés par l'API avancée ne passent pas par le relais entre numéros ni par le suivi de livraison de Flare. Pour un message à suivre, utilisez
POST /v1/messages.
Exemples
Dans ces exemples, votre numéro a l'identifiant 12. Les identifiants de conversation se terminent par @c.us pour une personne et @g.us pour un groupe.
Lister vos groupes
curl https://flare.zola-labs.com/v1/senders/12/wa/groups \
-H "Authorization: Bearer flr_live_VOTRE_CLE"
Chaque groupe est renvoyé avec son identifiant (id) et son nom (name). Utilisez cet identifiant comme destinataire de POST /v1/messages pour écrire au groupe.
Créer un groupe
curl https://flare.zola-labs.com/v1/senders/12/wa/groups \
-H "Authorization: Bearer flr_live_VOTRE_CLE" \
-H "Content-Type: application/json" \
-d '{"name": "Livreurs Douala", "participants": ["237699001122@c.us", "237677003344@c.us"]}'
Envoyer un sondage
curl https://flare.zola-labs.com/v1/senders/12/wa/messages/send-poll \
-H "Authorization: Bearer flr_live_VOTRE_CLE" \
-H "Content-Type: application/json" \
-d '{
"chatId": "237699001122@c.us",
"name": "Quel créneau de livraison vous convient ?",
"options": ["Matin", "Après-midi", "Soir"],
"allowMultipleAnswers": false
}'
Envoyer une position
curl https://flare.zola-labs.com/v1/senders/12/wa/messages/send-location \
-H "Authorization: Bearer flr_live_VOTRE_CLE" \
-H "Content-Type: application/json" \
-d '{
"chatId": "237699001122@c.us",
"latitude": 4.0511,
"longitude": 9.7679,
"description": "Point relais Bonapriso"
}'
Vérifier qu'un numéro a WhatsApp
curl https://flare.zola-labs.com/v1/senders/12/wa/contacts/check/237699001122 \
-H "Authorization: Bearer flr_live_VOTRE_CLE"
La réponse indique si le numéro existe sur WhatsApp (exists) et son identifiant de conversation (whatsappId).
Ce qu'il faut savoir
- Les réponses de l'API avancée viennent directement de WhatsApp : leur format peut évoluer, et certaines opérations ne sont pas disponibles sur tous les comptes (une fonction réservée à WhatsApp Business, par exemple).
- Les règles d'usage acceptable s'appliquent : pas d'ajout de personnes à un groupe sans leur accord, pas d'envois de masse.
- La limite de requêtes de votre clé s'applique aussi à ces appels.
Erreurs propres à l'API avancée
| Code HTTP | Code d'erreur | Signification |
|---|---|---|
| 403 | full_api_not_allowed |
Votre forfait n'inclut pas l'API avancée. |
| 404 | sender_not_found |
Ce numéro n'existe pas sur votre compte. |
| 409 | sender_not_connected |
Le numéro n'est pas connecté : reliez-le depuis l'espace client. |
| 404 | route_not_available |
Cette famille d'opérations n'est pas ouverte. |
| 503 | engine_unreachable |
Le service d'envoi est momentanément indisponible. |
Les autres réponses d'erreur (400, 404…) proviennent de l'opération elle-même et vous sont transmises telles quelles.