> ## Documentation Index
> Fetch the complete documentation index at: https://docs.messagefy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar Grupos

> Lista os grupos do WhatsApp conectado ao canal com páginacao

# Listar Grupos

O comando **Grupos** retorna a lista de grupos do dispositivo WhatsApp conectado ao canal.
Suporta busca por nome e páginacao.

## Requisição

```
POST /api/v1/message/SendCommand
```

```json theme={null}
{
  "channelId": "uuid-do-canal",
  "content": {
    "type": "GROUPS",
    "commandType": "GROUPS",
    "query": "Equipe",
    "page": 1,
    "pageSize": 10
  }
}
```

### Campos

| Campo      | Tipo      | Obrigatório | Padrão | Descrição                         |
| ---------- | --------- | ----------- | ------ | --------------------------------- |
| `query`    | `string`  | Não         | -      | Filtro de busca por nome do grupo |
| `page`     | `integer` | Não         | `1`    | Número da página (inicio em 1)    |
| `pageSize` | `integer` | Não         | `10`   | Quantidade de grupos por página   |

## Resposta da API

```json theme={null}
{
  "packageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

## Webhook de resposta

O resultado é entregue via webhook do tipo `GROUPS_RESPONSE`:

```json theme={null}
{
  "packageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "channelId": "uuid-do-canal",
  "content": {
    "type": "GROUPS_RESPONSE",
    "groups": [
      {
        "jid": "120363012345678901@g.us",
        "name": "Equipe de Vendas",
        "participants": 15,
        "owner": "5511999887766@s.whatsapp.net",
        "created": "2023-05-10T14:30:00Z",
        "isCommunity": false,
        "isCommunityMember": false
      },
      {
        "jid": "120363098765432109@g.us",
        "name": "Comunidade MessageFy",
        "participants": 250,
        "owner": "5521988776655@s.whatsapp.net",
        "created": "2024-01-15T09:00:00Z",
        "isCommunity": true,
        "isCommunityMember": true
      }
    ],
    "count": 2
  }
}
```

### Campos da resposta

| Campo                        | Tipo      | Descrição                                      |
| ---------------------------- | --------- | ---------------------------------------------- |
| `groups`                     | `array`   | Lista de grupos encontrados                    |
| `groups[].jid`               | `string`  | Identificador único do grupo no WhatsApp (JID) |
| `groups[].name`              | `string`  | Nome do grupo                                  |
| `groups[].participants`      | `integer` | Número de participantes do grupo               |
| `groups[].owner`             | `string`  | JID do dono/criador do grupo                   |
| `groups[].created`           | `string`  | Data de criação do grupo                       |
| `groups[].isCommunity`       | `boolean` | Indica se o grupo é uma comunidade             |
| `groups[].isCommunityMember` | `boolean` | Indica se o grupo pertence a uma comunidade    |
| `count`                      | `integer` | Total de grupos retornados                     |

## Exemplo completo

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST https://api-dev.messagefy.io/api/v1/message/SendCommand \
    -H "Content-Type: application/json" \
    -H "X-API-KEY: sua-api-key" \
    -d '{
      "channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "content": {
        "type": "GROUPS",
        "commandType": "GROUPS",
        "query": "Equipe",
        "page": 1,
        "pageSize": 10
      }
    }'
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      "https://api-dev.messagefy.io/api/v1/message/SendCommand",
      headers={
          "Content-Type": "application/json",
          "X-API-KEY": "sua-api-key"
      },
      json={
          "channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "content": {
              "type": "GROUPS",
              "commandType": "GROUPS",
              "query": "Equipe",
              "page": 1,
              "pageSize": 10
          }
      }
  )

  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api-dev.messagefy.io/api/v1/message/SendCommand",
    {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "X-API-KEY": "sua-api-key",
      },
      body: JSON.stringify({
        channelId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        content: {
          type: "GROUPS",
          commandType: "GROUPS",
          query: "Equipe",
          page: 1,
          pageSize: 10,
        },
      }),
    }
  );

  const data = await response.json();
  console.log(data);
  ```
</CodeGroup>

<Tip>
  Para obter informações detalhadas de um grupo específico (membros, descrição, dono),
  use o comando [Info do Grupo](/comandos/info-grupo).
</Tip>