Grupos

En esta página, nos ocuparemos de los diferentes puntos finales de grupos que puede utilizar para la gestión programática de grupos. Veremos cómo consultar, crear, actualizar y eliminar grupos.

El modelo de grupo

El modelo de grupo contiene toda la información sobre sus grupos.

Propiedades

Name
id
Type
integer
Description
Identificador único del grupo.
Name
name
Type
string
Description
El nombre del grupo.
Name
members_count
Type
integer
Description
La cantidad de contactos que están en este grupo.
Name
created
Type
timestamp
Description
Momento de la creación del grupo.

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

GET/api/groups

Listar todos los grupos

Este punto final le permite obtener una lista paginada de todos sus grupos. De forma predeterminada, se muestran un máximo de diez grupos por página.

Parámetros opcionales

Name
limit
Type
integer
Description
Limite la cantidad de grupos devueltos.
Name
offset
Type
integer
Description
El punto de inicio desde el cual se debe mostrar la lista.

Solicitud

GET

/api/groups

curl -G https://gateway.seven.io/api/groups \
    -H "X-Api-Key: SU_CLAVE_API" \
    -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"
        }
    ]
}

POST/api/groups

Crear grupo

Con este endpoint, puede crear un nuevo grupo.

Parámetros requeridos

Name
name
Type
string
Description
El nombre del grupo

Anfrage

POST

/api/groups

curl https://gateway.seven.io/api/groups \
    -H "X-Api-Key: SU_CLAVE_API" \
    -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

Obtener un grupo

Con este endpoint, puede obtener un grupo proporcionando el ID del grupo. Puede encontrar qué propiedades pertenecen a los objetos de grupo en la lista arriba en esta página.

Anfrage

GET

/api/groups/17923

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

Antwort

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

PATCH/api/groups/:id

Actualizar un grupo

Con este endpoint, puede actualizar un grupo. Ejemplos de actualizaciones incluyen cambiar el nombre, la descripción y el avatar, o agregar y eliminar contactos del grupo.

Parámetros opcionales

Name
name
Type
string
Description
El nombre del grupo.

Anfrage

PATCH

/api/groups/17923

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

Antwort

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

DELETE/api/groups/:id

Eliminar grupo

Este punto final le permite eliminar grupos.

Parámetros opcionales

Name
delete_contacts
Type
boolean
Description
Indica si también se deben eliminar los contactos que son miembros de este grupo.

Anfrage

DELETE

/api/groups/17923

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