> 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

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.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FOgu4AGjR3F63OMn6EMuP%2F01-visao-geral-canvas.png?alt=media&amp;token=c81f0510-f8d1-43e7-8645-5d740646c0df" alt=""><figcaption><p>Imagem 1 - Visão geral do nó Verificar Protocolo no canvas do Builder.</p></figcaption></figure>

***

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

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FNRcYWuD6CY4T7W83syPZ%2F02-lista-modulos-destacado.png?alt=media&amp;token=ccfe93e7-4c05-413a-8cae-0aefeb29c401" alt=""><figcaption><p>Imagem 2 - Lista de módulos com o item Verificar Protocolo destacado.</p></figcaption></figure>

***

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

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2F1eD8A8jCLK1XETbOVQxw%2F03-painel-descricao-saidas.png?alt=media&amp;token=cebc88c2-fa65-4588-8453-dab44db6f5be" alt=""><figcaption><p>Imagem 3 - Painel do módulo Verificar Protocolo aberto, mostrando a descrição e as saídas disponíveis.</p></figcaption></figure>

***

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

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FMMEonjrz00vbX1jrsfGs%2F04-saidas-sucesso-erro-visiveis.png?alt=media&amp;token=ec3f35ab-3aa6-4219-9b3b-535cfb71b748" alt=""><figcaption><p>Imagem 4 - Nó Verificar Protocolo no canvas com as saídas Sucesso e Erro visíveis.</p></figcaption></figure>

***

### 🔀 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 %}

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FnmIcmJbQ7Dpue4HHGBij%2F05-conectado-dois-nos.png?alt=media&amp;token=5940f77d-1ef3-442d-b10f-f212ab12f47e" alt=""><figcaption><p>Imagem 5 - Nó Verificar Protocolo conectado a dois nós distintos pelas saídas Sucesso e Erro.</p></figcaption></figure>

***

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