Compartir a través de

getAgentAvailability

La Plataforma omnicanal para Customer Service ofrece un conjunto de funciones que extienden la potencia de Dynamics 365 Customer Service Enterprise con el que las organizaciones pueden conectarse e interactuar de forma instantánea con sus clientes en distintos canales de mensajería digital. Se necesitan una licencia adicional para acceder a la Plataforma omnicanal para Customer Service. Para más información, consulte las páginas Descripción general de precios de Dynamics 365 Customer Service y Plan de precios de Dynamics 365 Customer Service.

Recupera la disponibilidad del agente para una cola en función de las reglas de enrutamiento. El desarrollador omnicanal puede usar esta API para determinar si la opción de iniciar conversación debe ser visible para el cliente y también para mostrar información como el tiempo de espera y la posición en las colas.

Nota:

  • Escuche el evento lcw:ready generado por un chat en vivo antes de llamar a los métodos del SDK de chat en vivo. Los métodos de chat en vivo se pueden invocar después de que se genere el evento lcw:ready . Puede escuchar este evento agregando su propio detector de eventos en el objeto window.
  • Se puede llamar a este método varias veces desde el lado del cliente cuando cambia la entrada del cliente. La caché del lado cliente se actualiza cada 2 minutos o cuando cambian los parámetros de contexto del cliente.
  • Este método se puede llamar 100 veces por minuto solo por organización. Si supera el límite, verá el código de estado de respuesta http 429 que indica que envió demasiadas solicitudes en un período de tiempo especificado.

Syntax

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

Parámetros

Ninguno

Valor devuelto

Nombre Tipo Description
queueId String La cola de destino donde se enruta la solicitud en función de la configuración de la regla de enrutamiento y los datos de entrada (se proporciona el valor de la entidad y el contexto que forman parte de la regla de enrutamiento).
isQueueAvailable Boolean Muestra:
- TRUE si la cola está dentro del horario de atención.
- FALSO si la cola está fuera del horario de atención.
StartTimeOfNextOperatingHour DateTime La hora de inicio (UTC) del horario de atención de la cola si está fuera del horario de atención. Durante el horario de atención, se devuelve un valor de 01-01-0001.
EndTimeOfNextOperatingHour DateTime La hora (UTC) en la que finaliza el horario de atención de la cola si está fuera del horario de atención. Durante el horario de atención, se devuelve un valor de 01-01-0001.
nexttransitiontime DateTime La hora (UTC) en la que la cola vuelve a estar operativa si está fuera del horario de atención. La hora en que la cola no está operativa se muestra durante las horas de funcionamiento.
positionInQueue Number La posición en la cola para un cliente que espera detrás de otros clientes en la misma cola.
isAgentAvailable Boolean Muestra:
- TRUE si los agentes de la cola están disponibles actualmente para recibir solicitudes en función de las reglas de enrutamiento y asignación configuradas para el flujo de trabajo. La API también devuelve true si un bot está asociado al flujo de trabajo o a una cola. Se recomienda que esta API no se use cuando haya un bot presente.
- FALSE si los agentes no están disponibles para recibir solicitudes.
averageWaitTime Number Tiempo de espera promedio en minutos para los clientes en la cola de destino basado en datos de las últimas 48 horas.

Example

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

Pasar valores de contexto personalizados para la función para asegurarse de que se recibe el contexto

Este método realiza una llamada interna a la función setContextProvider y, a continuación, llama a getAgentAvailability de forma sincrónica para asegurarse de que el contexto se establece antes de continuar. Debido a la naturaleza asincrónica de las funciones cuando se usan por separado, es posible que el contexto no esté listo cuando el agente consultor esté disponible.

Nota:

No es necesario llamar al método setContextProvider antes de llamar a getAgentAvailability.

Este es un código de ejemplo que muestra cómo usar el 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
Referencia de las SDK de chat activo

  • Last updated on