Gruppen

Auf dieser Seite werden wir uns mit den verschiedenen Gruppenendpunkten beschäftigen, die Sie zur programmatischen Verwaltung von Gruppen verwenden können. Wir werden uns ansehen, wie man Gruppen abfragt, erstellt, aktualisiert und löscht.

Das Gruppenmodell

Das Gruppenmodell enthält alle Informationen über Ihre Gruppen.

Eigenschaften

Name
id
Type
integer
Description
Eindeutiger Identifikator der Gruppe.
Name
name
Type
string
Description
Der Name der Gruppe.
Name
members_count
Type
integer
Description
Die Anzahl der Kontakte, die in dieser Gruppe sind.
Name
created
Type
timestamp
Description
Zeitpunkt der Erstellung der Gruppe.

{
  "id": 17923,
  "name": "Gruppe 1",
  "members_count": 543,
  "created": "2023-12-21 21:59:53"
}

GET/api/groups

Alle Gruppen auflisten

Dieser Endpunkt ermöglicht es Ihnen, eine paginierte Liste aller Ihrer Gruppen abzurufen. Standardmäßig werden maximal zehn Gruppen pro Seite angezeigt.

Optionale Parameter

Name
limit
Type
integer
Description
Begrenzen Sie die Anzahl der zurückgegebenen Gruppen.
Name
offset
Type
integer
Description
Der Startpunkt, ab dem die Liste angezeigt werden soll.

Anfrage

GET

/api/groups

curl -G https://gateway.seven.io/api/groups \
  -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
  -d limit=10

Antwort

{
  "pagingMetadata": {
    "offset": 0,
    "count": 4,
    "total": 40,
    "limit": 30,
    "has_more": false
  },
  "data": [
    {
      "id": 17923,
      "name": "Gruppe 1",
      "members_count": 543,
      "created": "2023-12-21 21:59:53"
    },
    {
      "id": 17924,
      // ...
    }
  ]
}

POST/api/groups

Gruppe erstellen

Mit diesem Endpunkt können Sie eine neue Gruppe erstellen.

Erforderliche Parameter

Name
name
Type
string
Description
Der Name der Gruppe

Anfrage

POST

/api/groups

curl https://gateway.seven.io/api/groups \
  -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
  -d "name=Eine neue Gruppe"

Antwort

{
  "id": 17923,
  "name": "Eine neue Gruppe",
  "members_count": 0,
  "created": "2023-12-21 21:59:53"
}

GET/api/groups/:id

Abrufen einer Gruppe

Mit diesem Endpunkt können Sie eine Gruppe abrufen, indem Sie die Gruppen-ID angeben. Welche Eigenschaften zu Gruppenobjekten gehören, können Sie der Liste oben auf dieser Seite entnehmen.

Anfrage

GET

/api/groups/17923

   curl https://gateway.seven.io/api/groups/17923 \
     -H "X-Api-Key: IHR_API_SCHLÜSSEL"

Antwort

{
  "id": 17923,
  "name": "Eine neue Gruppe",
  "members_count": 0,
  "created": "2023-12-21 21:59:53",
}

PATCH/api/groups/:id

Aktualisieren einer Gruppe

Mit diesem Endpunkt können Sie eine Gruppe aktualisieren. Beispiele für Aktualisierungen sind das Ändern des Namens, der Beschreibung und des Avatars oder das Hinzufügen und Entfernen von Kontakten aus der Gruppe.

Optionale Parameter

Name
name
Type
string
Description
Der Name der Gruppe.

Anfrage

PATCH

/api/groups/17923

curl -X PATCH https://gateway.seven.io/api/groups/17923 \
  -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
  -d "name=Neuer Gruppenname"

Antwort

{
  "id": 17923,
  "name": "Neuer Gruppenname",
  "members_count": 543,
  "created": "2023-12-21 21:59:53"
}

DELETE/api/groups/:id

Gruppe löschen

Dieser Endpunkt ermöglicht es Ihnen, Gruppen zu löschen.

Optionale Parameter

Name
delete_contacts
Type
boolean
Description
Gibt an, ob auch die Kontakte, die Mitglied in dieser Gruppe sind, gelöscht werden sollen.

Anfrage

DELETE

/api/groups/17923

curl -X DELETE https://gateway.seven.io/api/groups/17923 \
  -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
  -d "delete_contacts=false"