👤 Kontakte verwalten – /contacts API

Die contacts-API erlaubt das Erstellen, Bearbeiten, Abrufen und Löschen einzelner Kontakte, die z. B. als Nachrichtenempfänger verwendet werden. Kontakte können Gruppen zugeordnet werden.

🔐 Authentifizierung

• Erforderlich für alle Endpunkte

• Unterstützt: Bearer Auth oder HTTP Basic Auth

📤 POST /contacts – Neuen Kontakt anlegen

Beschreibung

Legt einen neuen Kontakt im System an. Optional kann dieser direkt einer oder mehreren Gruppen zugewiesen werden.

Request Body

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

Antwort 201 Created

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

📥 GET /contacts – Alle Kontakte abrufen

Beschreibung

Gibt eine Liste aller Kontakte im System zurück, optional gefiltert nach Gruppen.

Query-Parameter

Antwort 200 OK

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

🔍 GET /contacts/{id} – Einzelnen Kontakt abrufen

Beschreibung

Ruft die vollständigen Kontaktdaten eines spezifischen Kontakts per ID ab.

Pfadparameter

Antwort 200 OK

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

✏️ POST /contacts/{id} – Kontakt aktualisieren

Beschreibung

Aktualisiert die Daten eines bestehenden Kontakts (z. B. Telefonnummer, E-Mail, Gruppen).

Request Body (wie bei POST /contacts)

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

Antwort 200 OK

Identisch zur Erstellung:

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

🗑️ DELETE /contacts/{id} – Kontakt löschen

Beschreibung

Entfernt einen bestehenden Kontakt aus dem System.

Antwort 204 No Content

Keine Rückgabe bei erfolgreichem Löschvorgang.

❗ Fehlercodes für alle /contacts-Endpunkte

Beispiel-Fehlermeldung

{
  "code": 0,
  "message": "Validation failed",
  "reasons": ["Invalid phone number format"]
}

📌 Best Practices

• Verwende für Telefonnummern das internationale Format (z. B. +49).

• Gruppenzugehörigkeiten ermöglichen gezielten Massenversand.

• Nutze Pagination in UIs ab 20+ Kontakten zur Performanceoptimierung.