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

# Caixa de entrada

> Gerencie conversas, respostas e respostas salvas entre plataformas

Os comandos da caixa de entrada permitem fazer a triagem da caixa de entrada social unificada pelo terminal: listar conversas, ler threads de mensagens, marcá-las como lidas/resolvidas, responder com texto e mídia, ativar ou desativar as inscrições da caixa de entrada por conta e gerenciar respostas salvas reutilizáveis.

> [!NOTE]
>
> Todos os comandos aceitam as [flags globais](/pt-BR/cli/overview.md#opções-globais): `--json` (padrão) / `--table`, `--verbose`, `--api-key <key>` e `--api-url <url>`. Você também pode definir `SOME_API_KEY` e `SOME_API_URL` no seu ambiente.

## Conversas

### inbox:list

Lista as conversas da caixa de entrada.

```bash theme={null}
so-me inbox:list [options]
```

O endpoint da API (`GET /v1/inbox/conversations`) só faz paginação; todos os outros filtros (`--status`, `--platform`, `--type`, `--read`, `--unread`, `--search`) são aplicados no cliente à página atual. Aumente `--limit` se quiser que os filtros abranjam mais conversas.

| Opção | Descrição | Padrão |
| - | - | - |
| `--status <status>` | Filtra por status: `resolved`, `unresolved`, `archived` | — |
| `--platform <platform>` | Filtra por plataforma: `facebook`, `instagram`, `twitter`, `linkedin`, `tiktok`, `youtube`, `threads`, `whatsapp` | — |
| `--type <type>` | Filtra por tipo: `message`, `comment`, `mention` | — |
| `--read` | Mostra somente as conversas lidas | — |
| `--unread` | Mostra somente as conversas não lidas | — |
| `--search <query>` | Busca pelo nome do remetente, texto da mensagem ou nome da página | — |
| `--limit <number>` | Conversas por página | `50` |
| `--page <number>` | Número da página | `1` |

```bash Exemplos theme={null}
# Conversas não resolvidas
so-me inbox:list --status unresolved

# Somente comentários do Facebook
so-me inbox:list --platform facebook --type comment

# Somente conversas não lidas
so-me inbox:list --unread

# Combinar filtros: mensagens não lidas do Instagram
so-me inbox:list --platform instagram --unread --type message

# Buscar pelo remetente / mensagem / nome da página
so-me inbox:list --search "john"

# Ampliar a página para que os filtros do cliente cubram mais threads
so-me inbox:list --limit 100

# Percorrer os resultados, em tabela
so-me inbox:list --page 2 --limit 50 --table
```

### inbox:messages

Obtém as mensagens de uma thread de conversa.

```bash theme={null}
so-me inbox:messages <thread-id>
```

**thread-id** `string` *required*

ID da thread da conversa cujas mensagens você quer buscar.

```bash Exemplos theme={null}
# Buscar as mensagens de uma thread
so-me inbox:messages 550e8400-e29b-41d4-a716-446655440000

# Extrair somente o corpo das mensagens via jq
so-me inbox:messages 550e8400-... | jq '.[].message'
```

### inbox:read

Marca uma conversa como lida (define `isSeen: true`).

```bash theme={null}
so-me inbox:read <thread-id>
```

**thread-id** `string` *required*

ID da thread da conversa a marcar como lida.

```bash Exemplos theme={null}
# Marcar uma única conversa como lida
so-me inbox:read 550e8400-e29b-41d4-a716-446655440000

# Marcar todas as conversas não lidas como lidas
so-me inbox:list --unread --limit 100 \
  | jq -r '.[].id' \
  | xargs -I {} so-me inbox:read {}
```

### inbox:resolve

Marca uma conversa como resolvida, não resolvida ou arquivada.

```bash theme={null}
so-me inbox:resolve <thread-id> --status <status>
```

**thread-id** `string` *required*

ID da thread da conversa a atualizar.

| Opção | Descrição |
| - | - |
| `--status <status>` | Novo status: `resolved`, `unresolved`, `archived` **(obrigatório)** |

```bash Exemplos theme={null}
# Resolver uma conversa
so-me inbox:resolve 550e8400-... --status resolved

# Reabrir uma conversa
so-me inbox:resolve 550e8400-... --status unresolved

# Arquivar uma conversa
so-me inbox:resolve 550e8400-... --status archived
```

### inbox:delete

Exclui uma ou mais conversas. Pede confirmação, a menos que `--yes` seja passada. Cada thread é excluída individualmente e as falhas parciais são informadas.

```bash theme={null}
so-me inbox:delete <thread-ids...> [options]
```

**thread-ids** `string[]` *required*

Um ou mais IDs de thread a excluir (separados por espaço).

| Opção | Descrição |
| - | - |
| `-y, --yes` | Ignora a confirmação |

```bash Exemplos theme={null}
# Excluir uma única conversa (pede confirmação)
so-me inbox:delete 550e8400-e29b-41d4-a716-446655440000

# Excluir várias conversas sem confirmação
so-me inbox:delete 550e8400-... 660e8400-... 770e8400-... --yes

# Excluir todas as conversas arquivadas
so-me inbox:list --status archived --limit 100 \
  | jq -r '.[].id' \
  | xargs so-me inbox:delete --yes
```

***

## Respostas

### inbox:reply

Responde a uma conversa com texto, arquivos ou ambos. É obrigatório informar pelo menos um entre `--message`, `--image`, `--video`, `--audio` ou `--file`. As flags de mídia são enviadas como anexos tipados (`image`, `video`, `audio`, `document`).

```bash theme={null}
so-me inbox:reply <thread-id> [options]
```

**thread-id** `string` *required*

ID da thread da conversa a ser respondida.

| Opção | Descrição |
| - | - |
| `--message <text>` | Texto da resposta |
| `--image <urls...>` | URL(s) de imagem a anexar (separadas por espaço) |
| `--video <url>` | URL de vídeo a anexar |
| `--audio <url>` | URL de áudio a anexar |
| `--file <url>` | URL de documento a anexar |

```bash Exemplos theme={null}
# Resposta somente com texto
so-me inbox:reply 550e8400-... --message "Thanks!"

# Texto com uma imagem
so-me inbox:reply 550e8400-... --message "Check this" --image https://cdn.example.com/photo.jpg

# Várias imagens
so-me inbox:reply 550e8400-... --image https://cdn.example.com/1.jpg https://cdn.example.com/2.jpg

# Anexo de vídeo
so-me inbox:reply 550e8400-... --video https://cdn.example.com/clip.mp4

# Anexo de documento
so-me inbox:reply 550e8400-... --file https://cdn.example.com/doc.pdf

# Responder com um emoji
so-me inbox:reply 550e8400-... --message "Here you go 😊"
```

***

## Inscrições

Estes comandos aceitam um ID de conta (UUID) ou o nome de uma plataforma (por exemplo, `twitter`, `facebook`). Quando o nome de uma plataforma corresponde a várias contas conectadas, a CLI pede que você escolha uma. Se não existir nenhuma conta correspondente, `inbox:subscribe` / `inbox:unsubscribe` terminam com sucesso e com uma dica para conectar uma primeiro.

### inbox:subscribe

Ativa a caixa de entrada de uma conta social para que ela comece a receber mensagens, comentários e menções.

```bash theme={null}
so-me inbox:subscribe <id-or-platform>
```

**id-or-platform** `string` *required*

ID da conta (UUID) ou nome da plataforma (`twitter`, `facebook` etc.).

```bash Exemplos theme={null}
# Ativar pelo nome da plataforma
so-me inbox:subscribe facebook

# Ativar pelo ID da conta
so-me inbox:subscribe 550e8400-e29b-41d4-a716-446655440000
```

### inbox:unsubscribe

Desativa a caixa de entrada de uma conta social.

```bash theme={null}
so-me inbox:unsubscribe <id-or-platform>
```

**id-or-platform** `string` *required*

ID da conta (UUID) ou nome da plataforma (`twitter`, `facebook` etc.).

```bash Exemplos theme={null}
# Desativar pelo nome da plataforma
so-me inbox:unsubscribe twitter

# Desativar pelo ID da conta
so-me inbox:unsubscribe 550e8400-e29b-41d4-a716-446655440000
```

### inbox:enable

Alias de [`inbox:subscribe`](#inboxsubscribe).

```bash theme={null}
so-me inbox:enable <id-or-platform>
```

**id-or-platform** `string` *required*

ID da conta (UUID) ou nome da plataforma.

```bash Exemplo theme={null}
so-me inbox:enable instagram
```

### inbox:disable

Alias de [`inbox:unsubscribe`](#inboxunsubscribe).

```bash theme={null}
so-me inbox:disable <id-or-platform>
```

**id-or-platform** `string` *required*

ID da conta (UUID) ou nome da plataforma.

```bash Exemplo theme={null}
so-me inbox:disable instagram
```

***

## Respostas salvas

As respostas salvas são modelos de resposta reutilizáveis, aos quais você pode anexar arquivos e que pode usar na caixa de entrada.

### inbox:saved-replies

Lista todas as respostas salvas ou obtém uma única resposta salva pelo ID.

```bash theme={null}
so-me inbox:saved-replies [id]
```

**id** `string`

ID opcional de uma resposta salva. Quando informado, retorna os detalhes dessa resposta; caso contrário, lista todas as respostas salvas.

```bash Exemplos theme={null}
# Listar todas as respostas salvas
so-me inbox:saved-replies

# Obter uma resposta salva pelo ID
so-me inbox:saved-replies 7c2d4e8f-1234-5678-9abc-def012345678

# Listar como tabela
so-me inbox:saved-replies --table
```

### inbox:create-reply

Cria uma resposta salva com texto, arquivos ou ambos. É obrigatório informar pelo menos um entre `--text` ou `--file`.

```bash theme={null}
so-me inbox:create-reply [options]
```

| Opção | Descrição |
| - | - |
| `--text <text>` | Texto da resposta |
| `--file <file-ids...>` | IDs de arquivos a anexar (máx. 4 imagens, separados por espaço) |

```bash Exemplos theme={null}
# Resposta salva somente com texto
so-me inbox:create-reply --text "Thanks for reaching out!"

# Texto com um arquivo anexado
so-me inbox:create-reply --text "Check this out" --file 7c2d4e8f-...

# Vários arquivos anexados
so-me inbox:create-reply --file 7c2d4e8f-... 8d3e5f9a-...
```

### inbox:edit-reply

Edita uma resposta salva. É obrigatório informar pelo menos um entre `--text` ou `--file`.

```bash theme={null}
so-me inbox:edit-reply <id> [options]
```

**id** `string` *required*

ID da resposta salva a atualizar.

| Opção | Descrição |
| - | - |
| `--text <text>` | Novo texto da resposta |
| `--file <file-ids...>` | Novos IDs de arquivos (substituem os existentes, máx. 4 imagens, separados por espaço) |

```bash Exemplos theme={null}
# Atualizar o texto
so-me inbox:edit-reply 7c2d4e8f-... --text "Updated response"

# Substituir os arquivos anexados
so-me inbox:edit-reply 7c2d4e8f-... --file 8d3e5f9a-... 9e4f6a0b-...
```

### inbox:delete-reply

Exclui uma ou mais respostas salvas. Pede confirmação, a menos que `--yes` seja passada. Cada resposta é excluída individualmente e as falhas parciais são informadas.

```bash theme={null}
so-me inbox:delete-reply <ids...> [options]
```

**ids** `string[]` *required*

Um ou mais IDs de respostas salvas a excluir (separados por espaço).

| Opção | Descrição |
| - | - |
| `-y, --yes` | Ignora a confirmação |

```bash Exemplos theme={null}
# Excluir uma única resposta salva (pede confirmação)
so-me inbox:delete-reply 7c2d4e8f-...

# Excluir várias sem confirmação
so-me inbox:delete-reply 7c2d4e8f-... 8d3e5f9a-... --yes

# Excluir todas as respostas salvas
so-me inbox:saved-replies \
  | jq -r '.[].id' \
  | xargs so-me inbox:delete-reply --yes
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.