Referencia: Grupos

Generada desde el contrato OpenAPI

Esta referencia se genera directamente del contrato de la API, por lo que sus descripciones están en inglés. Puedes descargarlo en openapi.json. Las guías explican cómo usar estos endpoints.

Groups

Groups known to a connected instance.

Operaciones

GET/instances/{instance}/groups

---

List the groups of an instance

GET

/instances/{instance}/groups

Groups synchronised from the connected number, by name. Use a group id as the to field of a message.

Autorizaciones

bearerAuth

An API key created in the dashboard (Authorization: Bearer ). The scopes listed on each operation must be granted to the key: instances:read, instances:write, messages:read, messages:send, webhooks:read, webhooks:write.

Tipo

HTTP (bearer)

Respuestas

The groups.

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"id": "string",

  

  

  

"name": "string",

  

  

  

"participants_count": 0,

  

  

  

"synced_at": "string"

  

  

}

  

]

}

GET

/instances/{instance}/groups

Ejemplos

---