Passer au contenu principal

​
Groupes

Gerez les groupes WhatsApp via l’API Wappfy. Vous pouvez creer des groupes, gerer les participants, gerer les liens d’invitation, et bien plus. Tous les endpoints de groupes sont limites a une instance specifique : 
/api/instances/{instanceId}/groups/...

​
Creer un groupe

Creez un nouveau groupe WhatsApp avec des participants initiaux. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Project Alpha",
    "participants": [
      "[email protected]",
      "[email protected]"
    ]
  }'
Reponse : 
{
  "data": {
    "group_id": "[email protected]",
    "name": "Project Alpha",
    "participants": [
      {
        "id": "[email protected]",
        "is_admin": false
      },
      {
        "id": "[email protected]",
        "is_admin": false
      }
    ]
  }
}

​
Lister les groupes

Recuperez tous les groupes dont l’instance est membre. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups \
  -H "X-Api-Key: YOUR_API_KEY"
Reponse : 
{
  "data": [
    {
      "group_id": "[email protected]",
      "name": "Project Alpha",
      "participant_count": 5
    },
    {
      "group_id": "[email protected]",
      "name": "Support Team",
      "participant_count": 12
    }
  ]
}

​
Obtenir les informations d’un groupe

Recuperez les informations detaillees d’un groupe specifique. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY"
Reponse : 
{
  "data": {
    "group_id": "[email protected]",
    "name": "Project Alpha",
    "description": "Team workspace for Project Alpha",
    "owner": "[email protected]",
    "created_at": "2026-01-15T10:00:00Z",
    "participants": [
      {
        "id": "[email protected]",
        "is_admin": true,
        "is_super_admin": true
      },
      {
        "id": "[email protected]",
        "is_admin": false,
        "is_super_admin": false
      }
    ]
  }
}

​
Mettre a jour un groupe

Mettez a jour le nom ou la description du groupe. Vous devez etre administrateur du groupe pour effectuer cette action. 
curl -X PATCH https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Project Alpha v2",
    "description": "Updated workspace for Project Alpha"
  }'
Seuls les administrateurs du groupe peuvent modifier le nom et la description du groupe. Si l’instance n’est pas administrateur, une erreur 403 sera retournee.

​
Quitter un groupe

Retirez l’instance d’un groupe. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/leave \
  -H "X-Api-Key: YOUR_API_KEY"
Apres avoir quitte un groupe, vous aurez besoin d’un lien d’invitation ou qu’un autre administrateur vous ajoute a nouveau.

​
Participants

​
Lister les participants

Obtenez tous les participants d’un groupe. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/participants \
  -H "X-Api-Key: YOUR_API_KEY"
Reponse : 
{
  "data": [
    {
      "id": "[email protected]",
      "is_admin": true,
      "is_super_admin": true
    },
    {
      "id": "[email protected]",
      "is_admin": false,
      "is_super_admin": false
    },
    {
      "id": "[email protected]",
      "is_admin": true,
      "is_super_admin": false
    }
  ]
}

​
Ajouter des participants

Ajoutez un ou plusieurs participants a un groupe. Vous devez etre administrateur du groupe. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/participants \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": [
      "[email protected]",
      "[email protected]"
    ]
  }'

​
Retirer des participants

Retirez un ou plusieurs participants d’un groupe. Vous devez etre administrateur du groupe. 
curl -X DELETE https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/participants \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": [
      "[email protected]"
    ]
  }'

​
Codes d’invitation

​
Obtenir le code d’invitation

Generez ou recuperez le lien d’invitation du groupe. Vous devez etre administrateur du groupe. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/invite-code \
  -H "X-Api-Key: YOUR_API_KEY"
Reponse : 
{
  "data": {
    "invite_code": "https://chat.whatsapp.com/AbCdEfGhIjKlMn"
  }
}

​
Rejoindre via un code d’invitation

Rejoignez un groupe en utilisant un code d’invitation. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/join \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "invite_code": "AbCdEfGhIjKlMn"
  }'
Transmettez uniquement la partie code, pas l’URL complete. Pour https://chat.whatsapp.com/AbCdEfGhIjKlMn, transmettez AbCdEfGhIjKlMn.

​
Envoyer des messages dans les groupes

Pour envoyer un message a un groupe, utilisez l’endpoint standard d’envoi de message avec l’identifiant de conversation du groupe : 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/messages/send \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "chat_id": "[email protected]",
    "type": "text",
    "text": "Hello team!"
  }'
Les identifiants de conversation de groupe se terminent toujours par @g.us.

​
Reference des endpoints

MethodeEndpointDescription
POST/api/instances/{id}/groupsCreer un nouveau groupe
GET/api/instances/{id}/groupsLister tous les groupes
GET/api/instances/{id}/groups/{groupId}Obtenir les infos d’un groupe
PATCH/api/instances/{id}/groups/{groupId}Modifier le nom/la description du groupe
POST/api/instances/{id}/groups/{groupId}/leaveQuitter un groupe
GET/api/instances/{id}/groups/{groupId}/participantsLister les participants
POST/api/instances/{id}/groups/{groupId}/participantsAjouter des participants
DELETE/api/instances/{id}/groups/{groupId}/participantsRetirer des participants
GET/api/instances/{id}/groups/{groupId}/invite-codeObtenir le code d’invitation
POST/api/instances/{id}/groups/joinRejoindre via un code d’invitation

​
Gestion des erreurs

Code de statutDescription
403Vous n’etes pas administrateur de ce groupe.
404Groupe non trouve ou l’instance n’en est pas membre.
409Le participant est deja dans le groupe (lors de l’ajout) ou n’est pas dans le groupe (lors du retrait).
422Format de participant invalide. Utilisez {phone}@s.whatsapp.net.