> ## 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.

# Info do Grupo

> Obtem informações detalhadas de um grupo específico do WhatsApp

# Info do Grupo

O comando **Info do Grupo** retorna informações detalhadas de um grupo,
incluindo membros, descrição, nome e dono do grupo.

## Requisição

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

```json theme={null}
{
  "channelId": "uuid-do-canal",
  "content": {
    "type": "GROUP_INFO",
    "commandType": "GROUP_INFO",
    "groupJid": "120363012345678901@g.us"
  }
}
```

### Campos

| Campo      | Tipo     | Obrigatório | Descrição                                                           |
| ---------- | -------- | ----------- | ------------------------------------------------------------------- |
| `groupJid` | `string` | **Sim**     | JID do grupo (obtido via comando [Listar Grupos](/comandos/grupos)) |

## Resposta da API

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

## Webhook de resposta

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

```json theme={null}
{
  "packageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "channelId": "uuid-do-canal",
  "content": {
    "type": "GROUP_INFO_RESPONSE",
    "groupJid": "120363012345678901@g.us",
    "groupName": "Equipe de Vendas",
    "groupDescription": "Grupo para discussao de estrategias de vendas e metas mensais.",
    "owner": "5511999887766@s.whatsapp.net",
    "count": 3,
    "contacts": [
      {
        "jid": "5511999887766@s.whatsapp.net",
        "lid": "199887766@lid",
        "phoneNumber": "5511999887766",
        "fullName": "Joao Silva",
        "pushName": "Joao",
        "isAdmin": true,
        "isSuperAdmin": true
      },
      {
        "jid": "5521988776655@s.whatsapp.net",
        "lid": "218877665@lid",
        "phoneNumber": "5521988776655",
        "fullName": "Maria Santos",
        "pushName": "Maria",
        "isAdmin": false,
        "isSuperAdmin": false
      },
      {
        "jid": "5531977665544@s.whatsapp.net",
        "lid": "317766554@lid",
        "phoneNumber": "5531977665544",
        "fullName": "Pedro Oliveira",
        "pushName": "Pedro",
        "isAdmin": false,
        "isSuperAdmin": false
      }
    ]
  }
}
```

### Campos da resposta

| Campo                     | Tipo      | Descrição                                                   |
| ------------------------- | --------- | ----------------------------------------------------------- |
| `groupJid`                | `string`  | JID do grupo (sempre presente na resposta)                  |
| `groupName`               | `string`  | Nome do grupo                                               |
| `groupDescription`        | `string`  | Descrição do grupo                                          |
| `owner`                   | `string`  | JID do dono/criador do grupo                                |
| `count`                   | `integer` | Total de membros retornados                                 |
| `contacts`                | `array`   | Lista de membros do grupo                                   |
| `contacts[].jid`          | `string`  | JID do membro                                               |
| `contacts[].lid`          | `string`  | LID (LinkedID) do membro                                    |
| `contacts[].phoneNumber`  | `string`  | Telefone do membro                                          |
| `contacts[].fullName`     | `string`  | Nome completo do membro                                     |
| `contacts[].pushName`     | `string`  | Nome público (push name) do membro                          |
| `contacts[].isAdmin`      | `boolean` | Indica se o membro e administrador do grupo                 |
| `contacts[].isSuperAdmin` | `boolean` | Indica se o membro e super administrador (criador) do grupo |

## 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": "GROUP_INFO",
        "commandType": "GROUP_INFO",
        "groupJid": "120363012345678901@g.us"
      }
    }'
  ```

  ```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": "GROUP_INFO",
              "commandType": "GROUP_INFO",
              "groupJid": "120363012345678901@g.us"
          }
      }
  )

  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: "GROUP_INFO",
          commandType: "GROUP_INFO",
          groupJid: "120363012345678901@g.us",
        },
      }),
    }
  );

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

<Tip>
  Você pode obter o `groupJid` usando o comando [Listar Grupos](/comandos/grupos).
  O JID de grupos sempre termina com `@g.us`.
</Tip>

***

## Webhook GROUP\_ACTION\_INFO

Alem da resposta ao comando, você recebe automaticamente webhooks do tipo `GROUP_ACTION_INFO`
sempre que uma acao e realizada em um grupo do WhatsApp onde o canal participa. Isso inclui
adicionar/remover membros, promover/rebaixar administradores e alteracoes no grupo.

### Campos

| Campo          | Tipo               | Descrição                                                                 |
| -------------- | ------------------ | ------------------------------------------------------------------------- |
| `action`       | `string`           | Tipo da acao realizada (ver tabela abaixo)                                |
| `actionBy`     | `string` ou `null` | JID do membro que realizou a acao                                         |
| `actionByName` | `string` ou `null` | Nome do membro que realizou a acao                                        |
| `groupId`      | `string` ou `null` | JID do grupo onde a acao ocorreu                                          |
| `chatId`       | `string` ou `null` | Chave da conversa (igual ao `groupId`, padronizada com os demais eventos) |
| `jid`          | `string` ou `null` | JID de quem executou a acao                                               |
| `lid`          | `string` ou `null` | LID (LinkedID) de quem executou a acao                                    |
| `participant`  | `array` ou `null`  | Lista de JIDs dos membros afetados pela acao                              |
| `newName`      | `string` ou `null` | Novo nome do grupo (apenas para acao `rename`)                            |
| `newTopic`     | `string` ou `null` | Nova descrição do grupo (apenas para acao `topic`)                        |

### Acoes disponíveis

| Acao      | Descrição                         |
| --------- | --------------------------------- |
| `add`     | Membro adicionado ao grupo        |
| `remove`  | Membro removido do grupo          |
| `promote` | Membro promovido a administrador  |
| `demote`  | Membro rebaixado de administrador |
| `rename`  | Nome do grupo alterado            |
| `topic`   | Descrição do grupo alterada       |

### Exemplos por acao

<AccordionGroup>
  <Accordion title="add - Membro adicionado">
    ```json theme={null}
    {
      "packageId": null,
      "channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "content": {
        "type": "GROUP_ACTION_INFO",
        "action": "add",
        "actionBy": "5511999887766@s.whatsapp.net",
        "actionByName": "Joao Silva",
        "groupId": "120363012345678901@g.us",
        "chatId": "120363012345678901@g.us",
        "jid": "5511999887766@s.whatsapp.net",
        "lid": "199887766@lid",
        "participant": ["5531977665544@s.whatsapp.net"],
        "newName": null,
        "newTopic": null
      }
    }
    ```

    O membro `5511999887766` adicionou `5531977665544` ao grupo.
  </Accordion>

  <Accordion title="remove - Membro removido">
    ```json theme={null}
    {
      "packageId": null,
      "channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "content": {
        "type": "GROUP_ACTION_INFO",
        "action": "remove",
        "actionBy": "5511999887766@s.whatsapp.net",
        "actionByName": "Joao Silva",
        "groupId": "120363012345678901@g.us",
        "chatId": "120363012345678901@g.us",
        "jid": "5511999887766@s.whatsapp.net",
        "lid": "199887766@lid",
        "participant": ["5531977665544@s.whatsapp.net"],
        "newName": null,
        "newTopic": null
      }
    }
    ```

    O membro `5511999887766` removeu `5531977665544` do grupo.

    <Note>
      Quando um membro sai voluntariamente do grupo, `actionBy` e o `participant` terao o mesmo valor.
    </Note>
  </Accordion>

  <Accordion title="promote - Membro promovido">
    ```json theme={null}
    {
      "packageId": null,
      "channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "content": {
        "type": "GROUP_ACTION_INFO",
        "action": "promote",
        "actionBy": "5511999887766@s.whatsapp.net",
        "actionByName": "Joao Silva",
        "groupId": "120363012345678901@g.us",
        "chatId": "120363012345678901@g.us",
        "jid": "5511999887766@s.whatsapp.net",
        "lid": "199887766@lid",
        "participant": ["5521988776655@s.whatsapp.net"],
        "newName": null,
        "newTopic": null
      }
    }
    ```

    O membro `5511999887766` promoveu `5521988776655` a administrador do grupo.
  </Accordion>

  <Accordion title="demote - Membro rebaixado">
    ```json theme={null}
    {
      "packageId": null,
      "channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "content": {
        "type": "GROUP_ACTION_INFO",
        "action": "demote",
        "actionBy": "5511999887766@s.whatsapp.net",
        "actionByName": "Joao Silva",
        "groupId": "120363012345678901@g.us",
        "chatId": "120363012345678901@g.us",
        "jid": "5511999887766@s.whatsapp.net",
        "lid": "199887766@lid",
        "participant": ["5521988776655@s.whatsapp.net"],
        "newName": null,
        "newTopic": null
      }
    }
    ```

    O membro `5511999887766` rebaixou `5521988776655` de administrador para membro comum.
  </Accordion>

  <Accordion title="rename - Nome do grupo alterado">
    ```json theme={null}
    {
      "packageId": null,
      "channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "content": {
        "type": "GROUP_ACTION_INFO",
        "action": "rename",
        "actionBy": "5511999887766@s.whatsapp.net",
        "actionByName": "Joao Silva",
        "groupId": "120363012345678901@g.us",
        "chatId": "120363012345678901@g.us",
        "jid": "5511999887766@s.whatsapp.net",
        "lid": "199887766@lid",
        "participant": null,
        "newName": "Equipe de Vendas 2025",
        "newTopic": null
      }
    }
    ```

    O membro `5511999887766` renomeou o grupo para "Equipe de Vendas 2025".

    <Note>
      Na acao `rename`, o campo `participant` e `null` pois não ha um membro afetado diretamente.
    </Note>
  </Accordion>
</AccordionGroup>

### Casos de uso

<Tip>
  Use eventos de grupo para:

  * **Manter uma lista atualizada de membros** sem precisar consultar periodicamente com o comando Info do Grupo
  * **Detectar quando seu canal e removido** de um grupo (acao `remove` onde `participant` contem o JID do canal)
  * **Auditar acoes administrativas** em grupos gerenciados pela sua aplicação
  * **Enviar mensagens de boas-vindas** quando novos membros sao adicionados
</Tip>