Breadcrumbs

Dashboard e Filas

Uma "regra de distribuição" (ou fila) é a lógica configurada na plataforma para decidir qual agente recebe qual atendimento. Esta página traz um único endpoint, que serve para consultar, em tempo real, como está essa fila agora: quantos agentes estão disponíveis, quantos estão ocupados, e quantos atendimentos estão esperando.

Todas as requisições exigem o cabeçalho Authorization veja Autenticação e Segurança se ainda não souber como conseguir e usar o token.

Índice desta página


Recuperar estado de uma fila de atendimento

Permite entender como está uma regra de distribuição e tomar decisões de priorização e reclassificação de caso.

Request

GET https://api.cvortex.com/v1/dashboard/resume?distributionRuleId={ID}

Header: Authorization

Parâmetros de URI

Nome

Tipo

Descrição

Obrigatório

distributionRuleId

string

ID Hash da regra

Não distributionRuleId ou distributionRuleName deve ser informado

distributionRuleName

string

Nome da regra

Não distributionRuleId ou distributionRuleName deve ser informado

Exemplo

GET https://api.cvortex.com/v1/dashboard/resume?distributionRuleId=818588c8-8edb-4038-b311-a4c5a99b4e55

Response

JSON
{
    "agentsAvailable": 0,
    "agentsAvailableVoice": 0,
    "agentsNotReady": 0,
    "agentsBusy": 1,
    "agentsBusyVoice": 0,
    "agentsTalking": 0,
    "inAttendanceVoice": 0,
    "inQueueVoice": 0,
    "inAttendanceChat": 0,
    "inQueueChat": 1
}

Explicação dos campos de resposta

Campo

Descrição

agentsAvailable

Agentes disponíveis (canais de chat/texto)

agentsAvailableVoice

Agentes disponíveis para voz

agentsNotReady

Agentes indisponíveis/não prontos

agentsBusy

Agentes ocupados (chat/texto)

agentsBusyVoice

Agentes ocupados em ligação

agentsTalking

Agentes em ligação ativa

inAttendanceVoice

Atendimentos de voz em andamento

inQueueVoice

Atendimentos de voz aguardando na fila

inAttendanceChat

Atendimentos de chat em andamento

inQueueChat

Atendimentos de chat aguardando na fila