Groupes

Sur cette page, nous allons explorer les différents points d'API pour les groupes que vous pouvez utiliser pour gérer les groupes de manière programmatique. Nous verrons comment interroger, créer, mettre à jour et supprimer des groupes.

Le modèle de groupe

Le modèle de groupe contient toutes les informations sur vos groupes.

Propriétés

  • Name
    id
    Type
    integer
    Description

    Identifiant unique du groupe.

  • Name
    name
    Type
    string
    Description

    Le nom du groupe.

  • Name
    members_count
    Type
    integer
    Description

    Le nombre de contacts dans ce groupe.

  • Name
    created
    Type
    timestamp
    Description

    Date de création du groupe.

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

GET/api/groups

Lister tous les groupes

Ce point d'API vous permet de récupérer une liste paginée de tous vos groupes. Par défaut, un maximum de dix groupes est affiché par page.

Paramètres optionnels

  • Name
    limit
    Type
    integer
    Description

    Limitez le nombre de groupes retournés.

  • Name
    offset
    Type
    integer
    Description

    Le point de départ à partir duquel la liste doit être affichée.

Requête

GET
/api/groups
curl -G https://gateway.seven.io/api/groups \
    -H "X-Api-Key: VOTRE_CLÉ_API" \
    -d limit=10

Réponse

{
    "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"
        }
    ]
}

POST/api/groups

Créer un groupe

Ce point de terminaison vous permet de créer un nouveau groupe.

Paramètres requis

  • Name
    name
    Type
    string
    Description

    Le nom du groupe

Requête

POST
/api/groups
curl https://gateway.seven.io/api/groups \
    -H "X-Api-Key: VOTRE_CLÉ_API" \
    -d "name=Un nouveau groupe"

Réponse

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

GET/api/groups/:id

Récupérer un groupe

Ce point de terminaison vous permet de récupérer un groupe en spécifiant l'ID du groupe. Vous pouvez trouver quelles propriétés appartiennent aux objets de groupe dans la liste en haut de cette page.

Requête

GET
/api/groups/17923
curl https://gateway.seven.io/api/groups/17923 \
    -H "X-Api-Key: VOTRE_CLÉ_API"

Réponse

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

PATCH/api/groups/:id

Mettre à jour un groupe

Ce point de terminaison vous permet de mettre à jour un groupe. Des exemples de mises à jour incluent la modification du nom, de la description et de l'avatar ou l'ajout et la suppression de contacts du groupe.

Paramètres optionnels

  • Name
    name
    Type
    string
    Description

    Le nom du groupe.

Requête

PATCH
/api/groups/17923
curl -X PATCH https://gateway.seven.io/api/groups/17923 \
    -H "X-Api-Key: VOTRE_CLÉ_API" \
    -d "name=Nouveau nom de groupe"

Réponse

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

DELETE/api/groups/:id

Supprimer un groupe

Ce point de terminaison vous permet de supprimer des groupes.

Paramètres optionnels

  • Name
    delete_contacts
    Type
    boolean
    Description

    Indique si les contacts membres de ce groupe doivent également être supprimés.

Requête

DELETE
/api/groups/17923
curl -X DELETE https://gateway.seven.io/api/groups/17923 \
    -H "X-Api-Key: VOTRE_CLÉ_API" \
    -d "delete_contacts=false"