Vai al contenuto principale

Gruppi

Gestisci i gruppi WhatsApp tramite l’API Wappfy. Puoi creare gruppi, gestire i partecipanti, gestire i link di invito e altro ancora. Tutti gli endpoint dei gruppi sono associati a un’istanza specifica:
/api/instances/{instanceId}/groups/...

Creare un gruppo

Crea un nuovo gruppo WhatsApp con i partecipanti iniziali.
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]"
    ]
  }'
Risposta:
{
  "data": {
    "group_id": "[email protected]",
    "name": "Project Alpha",
    "participants": [
      {
        "id": "[email protected]",
        "is_admin": false
      },
      {
        "id": "[email protected]",
        "is_admin": false
      }
    ]
  }
}

Elencare i gruppi

Recupera tutti i gruppi di cui l’istanza e membro.
curl https://api.wappfy.io/api/instances/inst_abc123/groups \
  -H "X-Api-Key: YOUR_API_KEY"
Risposta:
{
  "data": [
    {
      "group_id": "[email protected]",
      "name": "Project Alpha",
      "participant_count": 5
    },
    {
      "group_id": "[email protected]",
      "name": "Support Team",
      "participant_count": 12
    }
  ]
}

Ottenere informazioni sul gruppo

Recupera informazioni dettagliate su un gruppo specifico.
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY"
Risposta:
{
  "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
      }
    ]
  }
}

Aggiornare un gruppo

Aggiorna il nome o la descrizione del gruppo. Devi essere un amministratore del gruppo per eseguire questa azione.
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"
  }'
Solo gli amministratori del gruppo possono aggiornare il nome e la descrizione. Se l’istanza non e un amministratore, verra restituito un errore 403.

Abbandonare un gruppo

Rimuovi l’istanza da un gruppo.
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/leave \
  -H "X-Api-Key: YOUR_API_KEY"
Dopo aver abbandonato un gruppo, sara necessario un link di invito o che un altro amministratore ti aggiunga nuovamente.

Partecipanti

Elencare i partecipanti

Ottieni tutti i partecipanti di un gruppo.
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/participants \
  -H "X-Api-Key: YOUR_API_KEY"
Risposta:
{
  "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
    }
  ]
}

Aggiungere partecipanti

Aggiungi uno o piu partecipanti a un gruppo. Devi essere un amministratore del gruppo.
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]"
    ]
  }'

Rimuovere partecipanti

Rimuovi uno o piu partecipanti da un gruppo. Devi essere un amministratore del gruppo.
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]"
    ]
  }'

Codici di invito

Ottenere il codice di invito

Genera o recupera il link di invito del gruppo. Devi essere un amministratore del gruppo.
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/invite-code \
  -H "X-Api-Key: YOUR_API_KEY"
Risposta:
{
  "data": {
    "invite_code": "https://chat.whatsapp.com/AbCdEfGhIjKlMn"
  }
}

Unirsi tramite codice di invito

Unisciti a un gruppo utilizzando un codice di invito.
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"
  }'
Passa solo la parte del codice, non l’URL completo. Per https://chat.whatsapp.com/AbCdEfGhIjKlMn, passa AbCdEfGhIjKlMn.

Inviare messaggi ai gruppi

Per inviare un messaggio a un gruppo, usa l’endpoint standard di invio messaggi con l’ID chat del gruppo:
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!"
  }'
Gli ID chat dei gruppi terminano sempre con @g.us.

Riferimento degli endpoint

MetodoEndpointDescrizione
POST/api/instances/{id}/groupsCrea un nuovo gruppo
GET/api/instances/{id}/groupsElenca tutti i gruppi
GET/api/instances/{id}/groups/{groupId}Ottieni informazioni sul gruppo
PATCH/api/instances/{id}/groups/{groupId}Aggiorna nome/descrizione del gruppo
POST/api/instances/{id}/groups/{groupId}/leaveAbbandona un gruppo
GET/api/instances/{id}/groups/{groupId}/participantsElenca i partecipanti
POST/api/instances/{id}/groups/{groupId}/participantsAggiungi partecipanti
DELETE/api/instances/{id}/groups/{groupId}/participantsRimuovi partecipanti
GET/api/instances/{id}/groups/{groupId}/invite-codeOttieni il codice di invito
POST/api/instances/{id}/groups/joinUnisciti tramite codice di invito

Gestione degli errori

Codice di statoDescrizione
403Non sei un amministratore di questo gruppo.
404Gruppo non trovato o l’istanza non e un membro.
409Il partecipante e gia nel gruppo (in caso di aggiunta) o non e nel gruppo (in caso di rimozione).
422Formato del partecipante non valido. Usa {phone}@s.whatsapp.net.