Manual de Configuração do AgentWatcher

O AgentWatcher monitora a inatividade do seu computador e altera automaticamente o status de presença do seu ramal no Yeastar P-Series. Quando você bloqueia sua máquina ou fica inativo, o status muda para "Ausente"; quando você retorna, volta para "Disponível". A partir da versão 1.0.3 ele também permite trocar o status à mão pela bandeja do sistema e pausar ou retomar o seu ramal em cada fila, inclusive por horário programado. Este manual cobre todo o processo de configuração e uso.

Novidades da versão 1.0.3

  • Troca manual do status do ramal pelo menu da bandeja
  • Lista das filas do ramal, com pausa e retomada individuais
  • Pausas programadas por fila, com dias da semana
  • Correções de segurança importantes — atualização recomendada em todas as máquinas
  • Correção da instalação silenciosa, usada pelo winget install --silent

1. Pré-requisitos

Antes de começar, certifique-se de que você possui:

  • Acesso de administrador ao portal web do seu Yeastar P-Series
  • AgentWatcher instalado no seu computador
  • Número do ramal que será monitorado
  • Conexão de rede entre o computador e o Yeastar P-Series
  • .NET Desktop Runtime 6.0 (x64) — se não estiver instalado, o próprio instalador oferece baixá-lo
  • Para usar a pausa em filas, o ramal precisa estar cadastrado como agente de pelo menos uma fila no Yeastar

2. Configuração no Yeastar P-Series

2.1. Habilitando a API

Para que o AgentWatcher possa se comunicar com o seu PABX, você precisa primeiro habilitar a API no Yeastar. Siga os passos abaixo:

  1. Acesse o portal web do seu Yeastar P-Series com credenciais de administrador
  2. Navegue até Integração > API
  3. Ative a chave API clicando no toggle
  4. (Opcional) Se desejar restringir o acesso, habilite a Restrição de IP e adicione o endereço IP do computador onde o AgentWatcher será executado
  5. Na seção Configurações Avançadas, vá para a aba Monitor de Status da Extensão e habilite o monitoramento para os ramais desejados
  6. Clique em Salvar

Dica: O monitoramento de status da extensão é essencial para que o AgentWatcher funcione corretamente. Sem isso, o sistema não conseguirá alterar o status do seu ramal.

2.2. Obtendo as Credenciais da API

Após habilitar a API, você precisará do Client ID e do Client Secret para configurar o AgentWatcher. Esses valores são essenciais para autenticação.

  1. Na mesma tela de configuração da API (Integrações > API)
  2. Localize os campos Client ID e Client Secret
  3. Copie esses valores e guarde-os em um local seguro
  4. Você utilizará esses valores na configuração do AgentWatcher

3. Configuração no AgentWatcher

Com as informações do Yeastar em mãos, agora você pode configurar o AgentWatcher. Siga os passos abaixo:

  1. Abra o aplicativo AgentWatcher no seu computador
  2. Clique no botão Configurações ou acesse o menu de configuração
  3. Preencha os seguintes campos:
    • FQDN do iPBX: O endereço do seu Yeastar P-Series (exemplo: pbx.suaempresa.com ou suaempresa.ras.yeastar.com)
    • Client ID: O Client ID que você copiou do Yeastar
    • Client Secret: O Client Secret que você copiou do Yeastar
    • Ramal: O número do ramal que será monitorado (exemplo: 1001)
    • Tempo de inatividade: O tempo em minutos que o AgentWatcher irá esperar antes de alterar o status do seu ramal para ausente (recomendado: 10 minutos)
  4. Clique em Testar para verificar se as informações estão corretas. Você deve receber uma mensagem de sucesso: "Conexão com a API foi bem-sucedida!"
  5. Se o teste for bem-sucedido, clique em Salvar para guardar as configurações

Sucesso! Após salvar as configurações, o AgentWatcher começará a monitorar a inatividade do seu computador e alterará automaticamente o status do seu ramal.

4. Menu da Bandeja: Status e Filas

Clique com o botão direito no ícone do AgentWatcher, ao lado do relógio do Windows. O menu traz duas coisas distintas — e vale entender a diferença, porque elas são independentes:

Status do ramal é o seu estado de presença: Disponível, Ausente, Viagem de Negócios, Não Perturbe, Pausa Almoço ou Fora do Trabalho. Vale para quem liga diretamente para você. O estado atual aparece marcado.

Pausa na fila é por fila, uma a uma. Você pode estar Disponível e mesmo assim pausado na fila de Suporte — ou o contrário. Pausar na fila não muda o seu status, e mudar o status não tira você da fila.

4.1. Trocando o status à mão

Basta clicar no status desejado. A troca vale imediatamente no PABX, e o monitoramento automático de inatividade continua funcionando normalmente — se você ficar inativo depois, o status irá para "Ausente" como sempre.

4.2. Pausando e voltando para a fila

Abaixo dos status, o menu lista as filas de que o seu ramal participa. Cada item diz o que vai acontecer ao clicar — "pausar" ou "voltar para a fila" — e mostra uma marca quando você está pausado nela.

  • Só aparecem filas em que o ramal está cadastrado como agente.
  • Se o item aparecer como "fora da fila" e desabilitado, significa que o agente está deslogado daquela fila no PABX — não há o que pausar.
  • A lista é atualizada ao abrir o menu. Se quiser forçar, use Atualizar.

5. Pausas Programadas

Em vez de lembrar de pausar o almoço todo dia, você pode programar. No menu da bandeja, clique em Programar pausa...

Cada pausa tem:

  • Fila: uma das filas de que o ramal participa
  • Rótulo: um nome livre para você se localizar (Almoço, Café, Reunião...)
  • Início e fim: o horário, em hora e minuto
  • Dias da semana: com atalhos para "Seg a Sex", "Todos" e "Nenhum"
  • Ativa: permite desligar uma pausa sem apagá-la

Você pode criar várias pausas para a mesma fila — por exemplo, um café às 10:00 e o almoço às 12:00 — e pausas diferentes para filas diferentes. As regras ficam gravadas no seu computador, em %LOCALAPPDATA%\AgentWatcher.

A regra da tela bloqueada — importante

A pausa entra no horário programado mesmo com a tela bloqueada. Se você saiu para almoçar, a fila não deve chamá-lo justamente nesse momento.

Já a retomada não acontece com a tela bloqueada. Se o horário de voltar chegar e você ainda não estiver no computador, a volta fica pendente — e o AgentWatcher devolve você à fila assim que você desbloquear a máquina. Assim a fila nunca passa a chamar um lugar vazio.

Se você mexer à mão durante uma pausa programada

O programado nunca briga com a sua decisão. Se você voltar do almoço mais cedo e sair da pausa pelo menu, o AgentWatcher não torna a pausar até aquela janela terminar. No dia seguinte, a programação volta a valer normalmente.

Detalhes de funcionamento

  • A verificação acontece a cada 30 segundos, então a pausa pode entrar alguns segundos depois do horário exato.
  • Se o computador estiver desligado ou suspenso na hora de entrar a pausa, ela é aplicada assim que a máquina voltar, desde que ainda esteja dentro do horário.
  • Pausas que atravessam a meia-noite (por exemplo, 22:00 às 02:00) funcionam e seguem o dia em que a pausa começou.
  • O AgentWatcher só retira pausas que ele mesmo colocou — uma pausa que você pôs à mão permanece até você tirá-la.

6. Como Funciona o AgentWatcher

Após a configuração, o AgentWatcher funcionará automaticamente em segundo plano:

Quando você bloqueia o computador: O AgentWatcher detecta o bloqueio e altera o status do seu ramal para "Ausente".

Tempo de inatividade: O AgentWatcher detecta o tempo de inatividade de acordo com o tempo configurado (5, 10 ou 15 min). Após esse período, altera o status do seu ramal para "Ausente".

Quando você retorna: Assim que você desbloquear o computador ou retomar a atividade, o AgentWatcher altera o status do seu ramal para "Disponível".

Pausas programadas: Nos horários que você programou, o AgentWatcher pausa o seu ramal nas filas escolhidas e o devolve a elas no fim do período — respeitando a regra da tela bloqueada descrita na seção 5.

Monitoramento contínuo: O AgentWatcher continua monitorando em segundo plano, mesmo que você minimize a janela. O ícone na bandeja do sistema indica que a aplicação está ativa.

7. Solução de Problemas

Erro: "Ramal não encontrado ou erro na conexão"

Se você receber essa mensagem ao testar a conexão, verifique:

  • FQDN do iPBX: Certifique-se de que o endereço está correto e acessível. Teste digitando o endereço em um navegador.
  • Client ID e Client Secret: Verifique se você copiou os valores corretamente do Yeastar. Certifique-se de que não há espaços em branco extras.
  • Número do ramal: Confirme que o número do ramal está correto e que ele existe no Yeastar.
  • API habilitada: Verifique se a API está realmente habilitada no Yeastar em Integrações > API.
  • Permissões do ramal: Certifique-se de que o ramal tem permissões para alteração de status via API.
  • Firewall: Se estiver usando um firewall, certifique-se de que a porta 8088 (ou a porta configurada) está aberta para comunicação com o Yeastar.

O status não muda automaticamente

Se o status do seu ramal não está mudando mesmo após a configuração:

  • Verifique se o Monitor de Status da Extensão está habilitado no Yeastar para o seu ramal.
  • Certifique-se de que o AgentWatcher está rodando (verifique o ícone na bandeja do sistema).
  • Tente fechar e reabrir o AgentWatcher.
  • Verifique os logs em %LOCALAPPDATA%\AgentWatcher (cole esse caminho na barra do Explorador de Arquivos).

As filas não aparecem no menu da bandeja

  • Confirme que o ramal está cadastrado como agente de alguma fila no Yeastar. O AgentWatcher só lista filas das quais o ramal participa.
  • Se aparecer "Filas indisponíveis no momento", o PABX não respondeu: confira a conexão e use Atualizar no menu.

A pausa programada não entrou ou não retomou

  • A verificação é a cada 30 segundos — aguarde um minuto antes de concluir que falhou.
  • Confira se o dia da semana está marcado na regra e se ela está Ativa.
  • Se a retomada não aconteceu, veja se o computador não estava com a tela bloqueada: nesse caso a volta é adiada de propósito, até o desbloqueio. O menu da bandeja mostra "Retomada pendente" quando isso acontece.
  • Se você pausou ou retomou à mão dentro do horário programado, o AgentWatcher não insiste até a janela terminar.

Onde ficam os logs e as configurações

A partir da versão 1.0.3, os logs e as pausas programadas ficam em %LOCALAPPDATA%\AgentWatcher, e não mais na pasta de instalação.

Não altere as permissões da pasta de instalação. A pasta C:\Program Files\Convectiva\AgentWatcher é propositalmente somente-leitura para usuários comuns. Até a versão 1.0.2 ela era gravável por qualquer usuário do computador, o que permitia substituir os arquivos do programa e capturar as credenciais de outras pessoas que usassem a mesma máquina. Dar permissão de escrita ali reabre essa falha, e não é necessário para nada.

8. Suporte e Documentação

Para mais informações sobre a API do Yeastar P-Series, consulte a documentação oficial do Yeastar.

Se você tiver dúvidas ou problemas que não foram resolvidos por este manual, entre em contato com a equipe de suporte da Convectiva.

Nota: Este manual corresponde à versão 1.0.3 do AgentWatcher, com o Yeastar P-Series. Algumas telas ou opções podem variar dependendo da sua versão específica. As notas de cada versão estão em github.com/ederpardeiro/AgentWatcher/releases.