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

# Visão Geral dos Comandos

> Todos os comandos disponíveis para controlar sessões, consultar contatos, grupos e mais

# Comandos

Comandos são operações especiais que você envia para controlar a sessão do WhatsApp conectada ao seu canal.
Diferente de mensagens (que enviam conteúdo para contatos), comandos executam ações como consultar contatos,
verificar o status da conexão, iniciar ou encerrar sessões, entre outros.

## Como enviar um comando

Todos os comandos são enviados através do mesmo endpoint:

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

O corpo da requisição segue o formato padrão do **Package**:

```json theme={null}
{
  "channelId": "uuid-do-canal",
  "content": {
    "type": "TIPO_DO_COMANDO",
    "commandType": "TIPO_DO_COMANDO",
    ...campos_especificos
  }
}
```

Os campos `type` e `commandType` determinam qual comando será executado.

## Resposta da API

A API retorna imediatamente um `packageId` confirmando que o comando foi recebido:

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

<Warning>
  A resposta da API **não** contém o resultado do comando. O resultado real é entregue de forma assíncrona
  via [webhook](/recebendo-eventos), associado ao `packageId` retornado.
</Warning>

## Comandos disponíveis

| Comando                                          | type / commandType                                                         | Descrição                                       |
| ------------------------------------------------ | -------------------------------------------------------------------------- | ----------------------------------------------- |
| [Status](/comandos/status)                       | `STATUS`                                                                   | Consulta o estado da conexão                    |
| [Iniciar Sessão](/comandos/iniciar-sessao)       | `SESSION_START_QR_CODE` / `SESSION_START_PAIR_CODE` / `SESSION_START_LINK` | Inicia a conexão com WhatsApp                   |
| [Importar Sessão](/comandos/importar-sessao)     | `SESSION_IMPORT`                                                           | Importa uma sessão WhatsApp Web já autenticada  |
| [Confirmar Passkey](/comandos/confirmar-passkey) | `PASSKEY_CONFIRM`                                                          | Confirma o pareamento por passkey do WhatsApp   |
| [Contatos](/comandos/contatos)                   | `CONTACTS`                                                                 | Lista os contatos do dispositivo                |
| [Grupos](/comandos/grupos)                       | `GROUPS`                                                                   | Lista os grupos do dispositivo                  |
| [Info do Contato](/comandos/info-contato)        | `CONTACT_INFO`                                                             | Obtem detalhes de um contato                    |
| [Info do Grupo](/comandos/info-grupo)            | `GROUP_INFO`                                                               | Obtem detalhes de um grupo                      |
| [Conversas](/comandos/conversas)                 | `GET_CHATS`                                                                | Lista as conversas recentes                     |
| [Últimas Mensagens](/comandos/ultimas-mensagens) | `GET_LAST_MESSAGES`                                                        | Obtem mensagens de uma conversa                 |
| [Marcar como Lido](/comandos/marcar-lido)        | `MARK_READ`                                                                | Marca mensagens como lidas                      |
| [Presença](/comandos/presenca)                   | `PRESENCE_SUBSCRIPTION`                                                    | Inscreve-se para receber presença de um contato |
| [Digitação](/comandos/digitacao)                 | `START_TYPING` / `STOP_TYPING`                                             | Simula indicador de digitação                   |
| [Desconectar](/comandos/desconectar)             | `DISCONNECT`                                                               | Encerra a sessão do WhatsApp                    |

## Autenticação

Todas as requisicoes devem incluir o header `X-API-KEY` com sua chave de API valida.

```bash 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": "uuid-do-canal",
    "content": {
      "type": "STATUS",
      "commandType": "STATUS"
    }
  }'
```

<Tip>
  Certifique-se de configurar a URL de webhook no seu canal para receber as respostas dos comandos.
  Consulte a secao [Webhooks](/recebendo-eventos) para mais detalhes.
</Tip>