x-api-key et sont préfixées par /sessions/:sessionId/.
Lister les groupes
GET /v1/sessions/:sessionId/groups
Liste tous les groupes WhatsApp de la session.
cURL
Réponse 200
Nombre de groupes
GET /v1/sessions/:sessionId/groups-count
Retourne uniquement le nombre de groupes.
cURL
Réponse 200
Créer un groupe
POST /v1/sessions/:sessionId/groups
Crée un nouveau groupe WhatsApp.
Nom du groupe
Numéros de téléphone (sans
+) des membres à ajoutercURL
Rejoindre
POST /v1/sessions/:sessionId/groups/join
Rejoindre un groupe via son code d’invitation.
Code d’invitation du groupe (sans le lien complet)
cURL
Détails
GET /v1/sessions/:sessionId/groups/:groupId
Retourne les métadonnées complètes d’un groupe.
JID du groupe (ex :
1203630XXXXXXXX@g.us)cURL
Membres
GET /v1/sessions/:sessionId/groups/:groupId/members
Liste les membres d’un groupe.
cURL
Réponse 200
Modifier
PATCH /v1/sessions/:sessionId/groups/:groupId
Modifie le sujet ou la description du groupe.
Nouveau nom du groupe
Nouvelle description du groupe
cURL
Quitter
DELETE /v1/sessions/:sessionId/groups/:groupId
Quitter un groupe WhatsApp.
cURL
Gérer les participants
POST /v1/sessions/:sessionId/groups/:groupId/participants
Ajouter, retirer, promouvoir ou rétrograder des membres.
Numéros de téléphone des membres concernés
Action à effectuer :
add, remove, promote, demote| Valeur | Description |
|---|---|
add | Ajouter des membres |
remove | Retirer des membres |
promote | Donner les droits admin |
demote | Retirer les droits admin |
cURL
Réponse 200
Mode admins
PATCH /v1/sessions/:sessionId/groups/:groupId/privacy
Active ou désactive le mode “admins uniquement” pour l’envoi de messages.
true = seuls les admins peuvent écrire dans le groupecURL
Promouvoir
POST /v1/sessions/:sessionId/groups/:groupId/promote
Promouvoir des membres comme admin.
Numéros de téléphone des membres à promouvoir
cURL
Rétrograder
POST /v1/sessions/:sessionId/groups/:groupId/demote
Retirer les droits admin de membres.
Numéros de téléphone des membres à rétrograder
cURL
Code d’invitation
GET /v1/sessions/:sessionId/groups/:groupId/invite-code
Récupère le code d’invitation du groupe.
cURL
Réponse 200
Envoyer dans le groupe
POST /v1/sessions/:sessionId/groups/:groupId/send
Envoie un message texte dans un groupe.
Texte à envoyer dans le groupe
cURL
Envoyer un média
POST /v1/sessions/:sessionId/groups/:groupId/send-media
Envoie un média dans un groupe.
Type :
image, video, audio, documentURL publique du média
Type MIME du fichier
Légende affichée sous le média
Nom du fichier (pour
document)Message interactif
POST /v1/sessions/:sessionId/groups/:groupId/send-interactive
Envoie un message interactif (boutons ou liste) dans un groupe.
Même structure que POST /sessions/:sessionId/send-interactive, sans le champ chatId (remplacé par :groupId dans l’URL).
Réponse 200

