Compartilhar via


verificarDisponibilidadeDoAgente

O Omnichannel for Customer Service oferece um conjunto de recursos que ampliam o poder do Dynamics 365 Customer Service Enterprise para permitir que as organizações se conectem e interajam instantaneamente com clientes em canais de mensagens digitais. É necessária uma licença adicional para acessar o Omnichannel for Customer Service. Para obter mais informações, consulte as páginas Visão geral de preços do Dynamics 365 Customer Service e Plano de preços do Dynamics 365 Customer Service.

Recupera a disponibilidade do agente para uma fila com base nas regras de roteamento. O desenvolvedor omnichannel pode usar essa API para determinar se a opção de início de conversa deve estar visível para o cliente e também para exibir informações como tempo de espera e posição nas filas.

Observação

  • Ouça o evento lcw:ready gerado por um chat ao vivo antes de chamar os métodos do SDK do chat ao vivo. Os métodos de chat ao vivo podem ser invocados depois que o evento lcw:ready é gerado. Você pode escutar esse evento adicionando seu próprio ouvinte de eventos no objeto window.
  • Esse método pode ser chamado várias vezes do lado do cliente quando a entrada do cliente é alterada. O cache do lado do cliente é atualizado a cada 2 minutos ou quando os parâmetros de contexto do cliente são alterados.
  • Esse método pode ser chamado 100 vezes por minuto somente por organização. Se você exceder o limite, verá o código de status de resposta http 429 indicando que você enviou muitas solicitações em um período de tempo especificado.

Sintaxe

Microsoft.Omnichannel.LiveChatWidget.SDK.getAgentAvailability();

Parâmetros

None

Valor de retorno

Nome Tipo Description
queueId String A fila de destino em que a solicitação é roteada com base na configuração da regra de roteamento e nos dados de entrada (o valor da entidade e o contexto que fazem parte da regra de roteamento são fornecidos).
isQueueAvailable booleano Exibe:
- TRUE se a fila estiver dentro do horário de funcionamento.
- FALSE se a fila estiver fora do horário de funcionamento.
StartTimeOfNextOperatingHour DateTime A hora de início (UTC) do horário de funcionamento da fila se estiver fora do horário de funcionamento. Durante o horário de funcionamento, um valor de 01-01-0001 é retornado.
EndTimeOfNextOperatingHour DateTime A hora (UTC) em que o horário de operação termina para a fila se estiver fora do horário de operação. Durante o horário de funcionamento, um valor de 01-01-0001 é retornado.
nexttransitiontime DateTime A hora (UTC) em que a fila está operacional novamente se estiver fora do horário de funcionamento. A hora em que a fila não está operacional é exibida durante o horário de funcionamento.
positionInQueue Número A posição na fila de um cliente aguardando atrás de outros clientes na mesma fila.
isAgentAvailable booleano Exibe:
- TRUE se os agentes na fila estiverem disponíveis no momento para receber solicitações com base nas regras de roteamento e atribuição configuradas para o fluxo de trabalho. A API também retornará true se um bot estiver anexado ao fluxo de trabalho ou a uma fila. Recomendamos que essa API não seja usada quando um bot estiver presente.
- FALSE se os agentes não estiverem disponíveis para receber solicitações.
averageWaitTime Número Tempo médio de espera em minutos para clientes na fila de destino com base nos dados das últimas 48 horas.

Example

window.addEventListener("lcw:ready", function handleLivechatReadyEvent(){
               // Gets the agent availability
               Microsoft.Omnichannel.LiveChatWidget.SDK.getAgentAvailability();
});

Passe valores de contexto personalizados para a função para garantir que o contexto seja recebido

Esse método executa uma chamada interna para a função setContextProvider e, em seguida, chama getAgentAvailability de forma síncrona, para garantir que o contexto seja definido antes de continuar. Devido à natureza assíncrona das funções quando elas são usadas separadamente, o contexto pode não estar pronto quando o agente de consultoria estiver disponível.

Observação

Você não precisa chamar o método setContextProvider antes de chamar getAgentAvailability.

Aqui está um código de exemplo que mostra como usar o setContextProvider método.

// To set the custom context, pass the custom context object as input parameter to agent availability

    // provider as part of the logic, so there is no need to set custom context before this call.

    Microsoft.Omnichannel.LiveChatWidget.SDK.getAgentAvailability({

        customContext : {

                'jwtToken': {'value':'token','isDisplayable':true},

                'Email': {'value':'test@test.com','isDisplayable':true},

                'client': {'value':'true','isDisplayable':true},

                'Emailing': {'value':'true','isDisplayable':true}

        }

    }

    );

startChat
setContextProvider
Referência de SDK do chat ao vivo