> For the complete documentation index, see [llms.txt](https://help.hyperflow.global/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/atendimento/verificar-protocolo.md).

# Verificar protocolo

## 🔍 Módulo Verificar Protocolo

O módulo **Verificar Protocolo** consulta automaticamente se há um protocolo de atendimento ativo para a conversa em andamento. Com base nessa verificação, o fluxo pode seguir dois caminhos: continuar com os dados do atendimento em mãos (sucesso) ou tratar o caso em que não há protocolo aberto (erro).

Esse módulo é útil quando você precisa condicionar ações do bot à existência de um atendimento ativo — por exemplo, buscar informações do protocolo antes de transferir para um agente ou exibir detalhes do chamado para o cliente.

**📷 Inserir print:** visão geral do nó Verificar Protocolo no canvas do Builder

***

### 🗂️ Como acessar

1. No menu lateral, clique em **Aplicativo**.
2. Em seguida, clique em **Fluxos**.
3. Abra o fluxo desejado ou crie um novo.
4. No canvas do Builder, clique no botão **+** para adicionar um novo nó.
5. Localize e selecione **Verificar Protocolo** na lista de módulos disponíveis.

**📷 Inserir print:** lista de módulos com o item "Verificar Protocolo" destacado

***

### 🧩 Conhecendo o módulo

Ao adicionar o módulo ao fluxo, um painel de informações é exibido. Diferente de outros módulos, o **Verificar Protocolo** não possui campos de configuração — ele age automaticamente com base na sessão ativa do usuário.

O painel apresenta uma descrição do que o módulo faz e as duas saídas possíveis: **Sucesso** e **Erro**.

**📷 Inserir print:** painel do módulo Verificar Protocolo aberto, mostrando a descrição e as saídas disponíveis

***

### ⚙️ O que o módulo faz

Ao ser executado no fluxo, o módulo verifica se existe um protocolo de atendimento aberto para a conversa atual.

* **Se um protocolo ativo for encontrado**, o módulo segue pelo caminho **Sucesso** e disponibiliza os dados do atendimento como variáveis para uso nos próximos nós do fluxo.
* **Se nenhum protocolo ativo for encontrado**, o módulo segue pelo caminho **Erro**.

#### 📦 Dados retornados em caso de sucesso

Quando um protocolo ativo é encontrado, o módulo disponibiliza as seguintes informações para o fluxo:

| Dado                    | O que representa                                         |
| ----------------------- | -------------------------------------------------------- |
| **Número do protocolo** | Identificador único do atendimento em andamento.         |
| **Departamento**        | Setor ou fila responsável pelo atendimento.              |
| **Agente**              | Nome do agente humano vinculado ao protocolo, se houver. |
| **Data de criação**     | Quando o protocolo foi aberto.                           |

**📷 Inserir print:** nó Verificar Protocolo no canvas com as saídas "Sucesso" e "Erro" visíveis

***

### 🔀 Saídas do módulo no fluxo

O módulo possui duas saídas que direcionam o fluxo com base no resultado da verificação:

| Saída       | Quando acontece                                                                                                          |
| ----------- | ------------------------------------------------------------------------------------------------------------------------ |
| **Sucesso** | Existe um protocolo de atendimento ativo. Os dados do atendimento ficam disponíveis como variáveis para os próximos nós. |
| **Erro**    | Não existe protocolo ativo na sessão atual.                                                                              |

{% hint style="info" %}
Ao passar pela saída **Sucesso**, os dados do protocolo ficam disponíveis como variáveis no fluxo. Você pode usá-los nos nós seguintes com a sintaxe `{{nome.da.variavel}}` para exibir informações ao usuário ou condicionar outras ações.
{% endhint %}

**📷 Inserir print:** nó Verificar Protocolo conectado a dois nós distintos pelas saídas "Sucesso" e "Erro"

***

### 💡 Dicas úteis

* **Sem configuração necessária:** Este módulo não exige nenhum preenchimento. Basta adicioná-lo ao fluxo e conectar as saídas.
* **Decisões condicionais:** Use este módulo sempre que uma ação do bot depender da existência de um atendimento ativo — como redirecionar para o agente responsável, exibir informações do protocolo ou bloquear certas funcionalidades para usuários sem atendimento aberto.
* **Dados para personalização:** Após o caminho de Sucesso, utilize os dados retornados (número do protocolo, departamento, agente) para personalizar mensagens ao usuário com a sintaxe `{{nome.da.variavel}}`.
* **Caminho de Erro:** Sempre conecte a saída **Erro** a um nó de tratamento — por exemplo, uma mensagem informando que não há atendimento ativo ou um nó que inicia um novo protocolo.

***

### 📋 Caso de uso

**Cenário:** Uma empresa de telecomunicações usa um chatbot de autoatendimento. Quando o cliente retorna ao chat, o bot verifica se já existe um protocolo aberto para aquela conversa. Se sim, exibe um resumo do atendimento em andamento e oferece a opção de falar com o agente responsável. Se não, apresenta o menu inicial para abertura de um novo chamado.

**Configuração principal:**

1. **Adicionar o módulo ao fluxo:**
   * Logo após o nó de identificação do cliente, adicione o módulo **Verificar Protocolo** ao fluxo.
   * Nenhuma configuração adicional é necessária.
2. **Conectar a saída Sucesso:**
   * Conecte a saída **Sucesso** a um nó de mensagem com o texto:

     ```
     Olá! Encontrei um atendimento ativo para você.
     Protocolo: {{protocol.number}}
     Departamento: {{protocol.department}}
     Deseja continuar com esse atendimento?
     ```
   * Em seguida, conecte a um nó de escolha para o cliente selecionar entre "Falar com o agente" ou "Encerrar protocolo".
3. **Conectar a saída Erro:**
   * Conecte a saída **Erro** ao nó de menu principal, onde o cliente pode abrir um novo chamado ou escolher outra opção de atendimento.

**Resultado esperado no fluxo:** Clientes que retornam ao chat com um protocolo ativo são reconhecidos imediatamente e recebem informações personalizadas sobre o atendimento em andamento. Clientes sem protocolo ativo são direcionados ao fluxo padrão de abertura de chamado.

***

### ✅ Resumo

* O módulo **Verificar Protocolo** verifica automaticamente se existe um protocolo de atendimento ativo na sessão atual — sem necessidade de configuração.
* Em caso de **Sucesso**, disponibiliza os dados do protocolo (número, departamento, agente e data de criação) como variáveis para os próximos nós do fluxo.
* Em caso de **Erro**, indica que não há protocolo ativo e direciona para o caminho alternativo configurado.
* Ideal para fluxos que precisam condicionar ações à existência de um atendimento aberto, como exibir resumos de chamados ou bloquear funcionalidades exclusivas para usuários com protocolo ativo.
* Sempre conecte ambas as saídas (**Sucesso** e **Erro**) para garantir que o fluxo tenha um caminho definido em qualquer situação.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/atendimento/verificar-protocolo.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.