👥 Kontaktgruppen-Management – /contactgroups API

Die contactgroups-API ermöglicht das Erstellen, Verwalten, Abrufen und Löschen von Kontaktgruppen. Diese Gruppen lassen sich z. B. beim Nachrichtensenden als Empfängerziel angeben.

🔐 Authentifizierung

• Erforderlich für alle Endpunkte

• Unterstützt: Bearer Auth oder Basic Auth

📤 POST /contactgroups – Neue Gruppe erstellen

Beschreibung

Erzeugt eine neue Kontaktgruppe mit dem angegebenen Namen.

Request Body

{
  "name": "monitoring"
}

Antwort 201 Created

{
  "id": 59218,
  "name": "monitoring"
}

📥 GET /contactgroups – Alle Gruppen abrufen

Beschreibung

Listet alle vorhandenen Kontaktgruppen – paginiert.

Query-Parameter

Antwort 200 OK

[
  {
    "id": 59218,
    "name": "monitoring"
  }
]

Wichtige Header

📄 GET /contactgroups/{id} – Einzelne Gruppe abrufen

Beschreibung

Liefert Detailinformationen über eine bestimmte Kontaktgruppe anhand ihrer ID.

Pfadparameter

Antwort 200 OK

{
  "id": 59218,
  "name": "monitoring"
}

✏️ POST /contactgroups/{id} – Gruppe aktualisieren

Beschreibung

Ändert den Namen einer bestehenden Kontaktgruppe.

Request Body

{
  "name": "monitoring"
}

Antwort 200 OK

{
  "id": 59218,
  "name": "monitoring"
}

🗑️ DELETE /contactgroups/{id} – Gruppe löschen

Beschreibung

Löscht die angegebene Kontaktgruppe dauerhaft.

Antwort 204 No Content

Keine Rückgabedaten – erfolgreicher Löschvorgang.

📇 GET /contactgroups/{id}/contacts – Kontakte einer Gruppe abrufen

Beschreibung

Listet alle Kontakte, die zu einer bestimmten Gruppe gehören.

Query-Parameter

Antwort 200 OK

[
  {
    "id": 1474,
    "type": "user",
    "name": "John Doe",
    "number": "004915711122233",
    "email": "john@doe.com",
    "groups": [
      {
        "id": 59218,
        "name": "monitoring"
      }
    ]
  }
]

❗ Fehlercodes für alle Endpunkte

Fehlerbeispiel

{
  "code": 0,
  "message": "Invalid request",
  "reasons": ["Missing group name"]
}

📌 Best Practices

• Nutze sprechende Gruppennamen, z. B. sales_eu, admin_alerts.

• Gruppenzugehörigkeit einzelner Kontakte kann über den Kontakt-Endpunkt gepflegt werden.

• Verwende Pagination sinnvoll, z. B. beim Scrollen großer Gruppenlisten im UI.