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

# BC Correios no Cabine

> A área de trabalho do Lerian BC Correios no Lerian Cabine.

O Lerian Cabine tem uma área de trabalho para o Lerian BC Correios.

A área de trabalho do Lerian BC Correios no Lerian Cabine é onde os operadores leem as correspondências do BC Correio da instituição, respondem ao BACEN, acompanham a trilha de auditoria e configuram a conexão. Grupos do Access Manager definem o que cada operador pode fazer. [Integrando com o Lerian BC Correios](https://docs.lerian.studio/pt/rails/bc-correios/bc-correios-integration.md) lista os grupos.

## Visão geral

***

**Visão geral** mostra as correspondências não lidas dos últimos 30 dias.

* A linha de destaque conta as correspondências não lidas e as que estão não lidas há mais de 15 dias. **Abrir caixa de entrada** abre as correspondências não lidas.
* **Não lidos há mais de 3 dias**, **Não lidos há mais de 7 dias** e **Não lidos há mais de 15 dias** abrem, cada um, as correspondências não lidas correspondentes em **Caixa de entrada**.
* A seção **Recebidos por tipo** mostra as correspondências por tipo, a atividade por dia e **Remetentes no período**.

O Cabine chama [`GET /api/v1/correios/dashboard/summary`](https://docs.lerian.studio/pt/reference/rails/bc-correios/dashboard-summary) e [`GET /api/v1/correios/dashboard/categories`](https://docs.lerian.studio/pt/reference/rails/bc-correios/dashboard-category-breakdown). As duas exigem `plugin-bc-correios-viewer-group`.

## Pastas de correspondência

***

**Caixa de entrada**, **Enviados**, **Arquivados** e **Cancelados** listam as correspondências de uma pasta.

* As colunas incluem **Assunto**, **Tipo**, **Remetente** ou **Destino**, **Anexos** e a data. **Enviados** mostra também **Transmissão**.
* **Buscar correios** busca no assunto, no remetente e no conteúdo.
* Filtre por **Tipo** (**Resolução**, **Circular**, **Comunicado** ou **Outro**), **Leitura** (exceto em **Enviados**) e período.
* **Restaurar** no menu de uma linha de **Arquivados** devolve a correspondência para **Caixa de entrada**. **Enviados** e **Cancelados** não oferecem ação em uma linha.

O Cabine chama [`GET /api/v1/correios/mails`](https://docs.lerian.studio/pt/reference/rails/bc-correios/list-or-search-mails), que exige `plugin-bc-correios-viewer-group`.

## Detalhe da correspondência

***

Uma linha abre a correspondência. A tela tem três abas.

* **Conteúdo** mostra o corpo da correspondência.
* **Anexos** lista os anexos. Um clique baixa um deles com [`GET /api/v1/correios/mails/{id}/attachments/{attachmentId}`](https://docs.lerian.studio/pt/reference/rails/bc-correios/download-attachment).
* **Resumo IA** mostra o status e o resumo da análise de IA. **Reanalisar** pede uma nova análise com [`POST /api/v1/correios/mails/{id}/reanalyze`](https://docs.lerian.studio/pt/reference/rails/bc-correios/trigger-ai-re-analysis). Ela exige um provedor de IA em **Configurações**.

O histórico abaixo da correspondência lista os eventos de auditoria dela.

* Abrir uma correspondência não lida a marca como lida com [`PUT /api/v1/correios/mails/{id}/read`](https://docs.lerian.studio/pt/reference/rails/bc-correios/mark-mail-as-read).
* **Responder** abre **Escrever correio** como resposta à correspondência. Uma mensagem enviada não tem **Responder**.
* **Arquivar** move uma correspondência de **Caixa de entrada** para **Arquivados** com [`PUT /api/v1/correios/mails/{id}/archive`](https://docs.lerian.studio/pt/reference/rails/bc-correios/archive-mail). **Restaurar** a devolve com [`PUT /api/v1/correios/mails/{id}/restore`](https://docs.lerian.studio/pt/reference/rails/bc-correios/restore-mail). As duas mudam apenas a cópia local da correspondência.

[`GET /api/v1/correios/mails/{id}`](https://docs.lerian.studio/pt/reference/rails/bc-correios/get-mail-by-id) e [`GET /api/v1/correios/mails/{id}/ai-status`](https://docs.lerian.studio/pt/reference/rails/bc-correios/get-ai-analysis-status) leem a correspondência. `plugin-bc-correios-viewer-group` pode ler, baixar e marcar como lida. **Arquivar**, **Restaurar** e **Reanalisar** exigem `plugin-bc-correios-contributor-group`.

## Escrever

***

**Escrever correio** envia uma mensagem a um departamento do BACEN. Preencha **Assunto** e **Mensagem**. **Destino (opcional)** substitui o destino padrão, e **Palavras-chave (opcional)** aceita até 10 palavras-chave, separadas por vírgulas.

**Revisar envio** abre a revisão. Depois que você confirma, o Cabine envia a mensagem com [`POST /api/v1/correios/mails/send`](https://docs.lerian.studio/pt/reference/rails/bc-correios/send-message-to-bcb). Ela exige `plugin-bc-correios-contributor-group`.

## Auditoria

***

**Auditoria** lista a trilha de auditoria da instituição com as colunas **Quando**, **Ação**, **Correio** e **Operador**. Filtre por **Ação** e **Período**.

**Exportar CSV** e **Exportar PDF** baixam a trilha do período selecionado. Elas exigem um período.

O Cabine chama [`GET /api/v1/correios/audit`](https://docs.lerian.studio/pt/reference/rails/bc-correios/query-audit-trail) e [`GET /api/v1/correios/audit/export`](https://docs.lerian.studio/pt/reference/rails/bc-correios/export-audit-trail). As duas exigem `plugin-bc-correios-viewer-group`.

## Configurações

***

**Configurações** tem quatro seções.

* **Credenciais**: **Usuário Sisbacen**, **Senha Sisbacen** e **Destino padrão (BCB)**. Para um segredo armazenado, escolha **Manter**, **Substituir** ou **Remover**. **Testar credenciais** testa as credenciais salvas com [`POST /api/v1/correios/settings/test-connection`](https://docs.lerian.studio/pt/reference/rails/bc-correios/test-bcb-connection) e mostra as **Pastas autorizadas**.
* **Coleta**: **Intervalo de coleta** é de 5, 15, 30 ou 60 minutos.
* **IA**: **Provedor**, **Modelo**, **Endpoint**, **Prompt de sistema** e **Chave da API (BYOK)**. **Testar provedor** chama [`POST /api/v1/correios/settings/test-ai-connection`](https://docs.lerian.studio/pt/reference/rails/bc-correios/test-ai-provider-connection).
* **Retenção**: **Retenção (dias)** aceita de 1825 a 36500 dias. Um período menor permite que o Lerian BC Correios apague os correios e anexos mais antigos que o novo período na próxima execução da retenção. O Cabine a salva com [`PATCH /api/v1/correios/settings/retention`](https://docs.lerian.studio/pt/reference/rails/bc-correios/update-retention-policy).

**Salvar** grava as outras seções com [`PATCH /api/v1/correios/settings`](https://docs.lerian.studio/pt/reference/rails/bc-correios/update-tenant-settings). Quando não há configuração, a tela mostra um formulário de primeiro uso, e **Criar configuração** a cria com [`POST /api/v1/correios/settings`](https://docs.lerian.studio/pt/reference/rails/bc-correios/create-tenant-settings).

O Cabine lê a configuração com [`GET /api/v1/correios/settings`](https://docs.lerian.studio/pt/reference/rails/bc-correios/get-tenant-settings), que exige `plugin-bc-correios-viewer-group`. Salvar ou criar a configuração e os dois testes exigem `plugin-bc-correios-editor-group`.

## Relacionados

***

* [Operando o Lerian BC Correios](https://docs.lerian.studio/pt/rails/bc-correios/bc-correios-operations.md)
* [Acesso e papéis no Lerian Cabine](https://docs.lerian.studio/pt/rails/cabine/cabine-access-and-roles.md)


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