Gruppen

Verwalten Sie WhatsApp-Gruppen ueber die Wappfy API. Sie koennen Gruppen erstellen, Teilnehmer verwalten, Einladungslinks handhaben und vieles mehr. Alle Gruppen-Endpunkte beziehen sich auf eine bestimmte Instanz:

/api/instances/{instanceId}/groups/...

Gruppe erstellen

Erstellen Sie eine neue WhatsApp-Gruppe mit ersten Teilnehmern.

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": [
      "5511999998888@s.whatsapp.net",
      "5511888887777@s.whatsapp.net"
    ]
  }'

const response = await fetch(
  "https://api.wappfy.io/api/instances/inst_abc123/groups",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Project Alpha",
      participants: [
        "5511999998888@s.whatsapp.net",
        "5511888887777@s.whatsapp.net",
      ],
    }),
  }
);

const group = await response.json();
console.log(group.data.group_id);

Antwort:

{
  "data": {
    "group_id": "120363012345678901@g.us",
    "name": "Project Alpha",
    "participants": [
      {
        "id": "5511999998888@s.whatsapp.net",
        "is_admin": false
      },
      {
        "id": "5511888887777@s.whatsapp.net",
        "is_admin": false
      }
    ]
  }
}

Gruppen auflisten

Rufen Sie alle Gruppen ab, in denen die Instanz Mitglied ist.

curl https://api.wappfy.io/api/instances/inst_abc123/groups \
  -H "X-Api-Key: YOUR_API_KEY"

const response = await fetch(
  "https://api.wappfy.io/api/instances/inst_abc123/groups",
  {
    headers: { "X-Api-Key": "YOUR_API_KEY" },
  }
);

const { data } = await response.json();
console.log(`Found ${data.length} groups`);

Antwort:

{
  "data": [
    {
      "group_id": "120363012345678901@g.us",
      "name": "Project Alpha",
      "participant_count": 5
    },
    {
      "group_id": "120363098765432109@g.us",
      "name": "Support Team",
      "participant_count": 12
    }
  ]
}

Gruppeninformationen abrufen

Rufen Sie detaillierte Informationen zu einer bestimmten Gruppe ab.

curl https://api.wappfy.io/api/instances/inst_abc123/groups/120363012345678901@g.us \
  -H "X-Api-Key: YOUR_API_KEY"

Antwort:

{
  "data": {
    "group_id": "120363012345678901@g.us",
    "name": "Project Alpha",
    "description": "Team workspace for Project Alpha",
    "owner": "5511999998888@s.whatsapp.net",
    "created_at": "2026-01-15T10:00:00Z",
    "participants": [
      {
        "id": "5511999998888@s.whatsapp.net",
        "is_admin": true,
        "is_super_admin": true
      },
      {
        "id": "5511888887777@s.whatsapp.net",
        "is_admin": false,
        "is_super_admin": false
      }
    ]
  }
}

Gruppe aktualisieren

Aktualisieren Sie den Gruppennamen oder die Beschreibung. Sie muessen Gruppenadmin sein, um diese Aktion durchzufuehren.

curl -X PATCH https://api.wappfy.io/api/instances/inst_abc123/groups/120363012345678901@g.us \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Project Alpha v2",
    "description": "Updated workspace for Project Alpha"
  }'

Nur Gruppenadmins koennen den Gruppennamen und die Beschreibung aktualisieren. Wenn die Instanz kein Admin ist, wird ein 403-Fehler zurueckgegeben.

Gruppe verlassen

Entfernen Sie die Instanz aus einer Gruppe.

curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/120363012345678901@g.us/leave \
  -H "X-Api-Key: YOUR_API_KEY"

Nach dem Verlassen einer Gruppe benoetigen Sie einen Einladungslink oder einen anderen Admin, der Sie wieder hinzufuegt.

Teilnehmer

Teilnehmer auflisten

Rufen Sie alle Teilnehmer einer Gruppe ab.

curl https://api.wappfy.io/api/instances/inst_abc123/groups/120363012345678901@g.us/participants \
  -H "X-Api-Key: YOUR_API_KEY"

Antwort:

{
  "data": [
    {
      "id": "5511999998888@s.whatsapp.net",
      "is_admin": true,
      "is_super_admin": true
    },
    {
      "id": "5511888887777@s.whatsapp.net",
      "is_admin": false,
      "is_super_admin": false
    },
    {
      "id": "5511777776666@s.whatsapp.net",
      "is_admin": true,
      "is_super_admin": false
    }
  ]
}

Teilnehmer hinzufuegen

Fuegen Sie einen oder mehrere Teilnehmer zu einer Gruppe hinzu. Sie muessen Gruppenadmin sein.

curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/120363012345678901@g.us/participants \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": [
      "5511666665555@s.whatsapp.net",
      "5511555554444@s.whatsapp.net"
    ]
  }'

await fetch(
  "https://api.wappfy.io/api/instances/inst_abc123/groups/120363012345678901@g.us/participants",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      participants: [
        "5511666665555@s.whatsapp.net",
        "5511555554444@s.whatsapp.net",
      ],
    }),
  }
);

Teilnehmer entfernen

Entfernen Sie einen oder mehrere Teilnehmer aus einer Gruppe. Sie muessen Gruppenadmin sein.

curl -X DELETE https://api.wappfy.io/api/instances/inst_abc123/groups/120363012345678901@g.us/participants \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": [
      "5511666665555@s.whatsapp.net"
    ]
  }'

Einladungscodes

Einladungscode abrufen

Erstellen oder rufen Sie den Einladungslink der Gruppe ab. Sie muessen Gruppenadmin sein.

curl https://api.wappfy.io/api/instances/inst_abc123/groups/120363012345678901@g.us/invite-code \
  -H "X-Api-Key: YOUR_API_KEY"

Antwort:

{
  "data": {
    "invite_code": "https://chat.whatsapp.com/AbCdEfGhIjKlMn"
  }
}

Per Einladungscode beitreten

Treten Sie einer Gruppe ueber einen Einladungscode bei.

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"
  }'

Uebergeben Sie nur den Code-Teil, nicht die vollstaendige URL. Fuer https://chat.whatsapp.com/AbCdEfGhIjKlMn uebergeben Sie AbCdEfGhIjKlMn.

Nachrichten an Gruppen senden

Um eine Nachricht an eine Gruppe zu senden, verwenden Sie den Standard-Endpunkt zum Nachrichten senden mit der Chat-ID der Gruppe:

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": "120363012345678901@g.us",
    "type": "text",
    "text": "Hello team!"
  }'

Gruppenchat-IDs enden immer mit @g.us.

Endpunkt-Referenz

Methode	Endpunkt	Beschreibung
`POST`	`/api/instances/{id}/groups`	Neue Gruppe erstellen
`GET`	`/api/instances/{id}/groups`	Alle Gruppen auflisten
`GET`	`/api/instances/{id}/groups/{groupId}`	Gruppeninformationen abrufen
`PATCH`	`/api/instances/{id}/groups/{groupId}`	Gruppenname/Beschreibung aktualisieren
`POST`	`/api/instances/{id}/groups/{groupId}/leave`	Gruppe verlassen
`GET`	`/api/instances/{id}/groups/{groupId}/participants`	Teilnehmer auflisten
`POST`	`/api/instances/{id}/groups/{groupId}/participants`	Teilnehmer hinzufuegen
`DELETE`	`/api/instances/{id}/groups/{groupId}/participants`	Teilnehmer entfernen
`GET`	`/api/instances/{id}/groups/{groupId}/invite-code`	Einladungscode abrufen
`POST`	`/api/instances/{id}/groups/join`	Per Einladungscode beitreten

Fehlerbehandlung

Statuscode	Beschreibung
`403`	Sie sind kein Admin dieser Gruppe.
`404`	Gruppe nicht gefunden oder Instanz ist kein Mitglied.
`409`	Teilnehmer ist bereits in der Gruppe (beim Hinzufuegen) oder nicht in der Gruppe (beim Entfernen).
`422`	Ungueltiges Teilnehmerformat. Verwenden Sie `{phone}@s.whatsapp.net`.

Erste Schritte

Anleitungen

Gruppen

Gruppen

Gruppe erstellen

Gruppen auflisten

Gruppeninformationen abrufen

Gruppe aktualisieren

Gruppe verlassen

Teilnehmer

Teilnehmer auflisten

Teilnehmer hinzufuegen

Teilnehmer entfernen

Einladungscodes

Einladungscode abrufen

Per Einladungscode beitreten

Nachrichten an Gruppen senden

Endpunkt-Referenz

Fehlerbehandlung

​Gruppen

​Gruppe erstellen

​Gruppen auflisten

​Gruppeninformationen abrufen

​Gruppe aktualisieren

​Gruppe verlassen

​Teilnehmer

​Teilnehmer auflisten

​Teilnehmer hinzufuegen

​Teilnehmer entfernen

​Einladungscodes

​Einladungscode abrufen

​Per Einladungscode beitreten

​Nachrichten an Gruppen senden

​Endpunkt-Referenz

​Fehlerbehandlung

Gruppen

Gruppe erstellen

Gruppen auflisten

Gruppeninformationen abrufen

Gruppe aktualisieren

Gruppe verlassen

Teilnehmer

Teilnehmer auflisten

Teilnehmer hinzufuegen

Teilnehmer entfernen

Einladungscodes

Einladungscode abrufen

Per Einladungscode beitreten

Nachrichten an Gruppen senden

Endpunkt-Referenz

Fehlerbehandlung