Partager via


getAgentAvailability

Omnicanal pour Customer Service contient une suite de capacités qui étendent la puissance de Dynamics 365 Customer Service Enterprise pour permettre aux organisations de se connecter et d’interagir instantanément avec leurs clients sur les canaux de messagerie numérique. Une licence supplémentaire est requise pour accéder à Omnichannel pour Customer Service. Pour plus d’informations, voir les pages Vue d’ensemble de la tarification de Dynamics 365 Customer Service et Plan de tarification de Dynamics 365 Customer Service.

Récupère la disponibilité de l’agent pour une file d’attente en fonction des règles de routage. Le développeur omnicanal peut utiliser cette API pour déterminer si l’option de démarrage de la conversation doit être visible par le client, ainsi que pour afficher des informations telles que le temps d’attente et la position dans les files d’attente.

Note

  • Écoutez l’événement lcw :ready déclenché par un chat en direct avant d’appeler les méthodes SDK de chat en direct. Les méthodes de chat en direct peuvent être appelées après le déclenchement de l’événement lcw :ready . Vous pouvez écouter cet événement en ajoutant votre propre écouteur d’événements sur l’objet window.
  • Cette méthode peut être appelée plusieurs fois du côté client lorsque l’entrée du client change. Le cache côté client est actualisé toutes les 2 minutes ou lorsque les paramètres de contexte du client changent.
  • Cette méthode peut être appelée 100 fois par minute et par organisation uniquement. Si vous dépassez la limite, le code d’état de la réponse http 429 indique que vous avez envoyé trop de requêtes dans un laps de temps spécifié.

Syntaxe

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

Paramètres

Aucun

Valeur retournée

Nom Type Descriptif
queueId Chaîne File d’attente cible dans laquelle la demande est acheminée en fonction de la configuration de la règle de routage et des données d’entrée (la valeur de l’entité et du contexte qui font partie de la règle de routage sont fournies).
isQueueAvailable Booléen Affiche:
- TRUE si la file d’attente se trouve dans les heures d’ouverture.
- FAUX si la file d’attente se trouve en dehors des heures d’ouverture.
StartTimeOfNextOperatingHour Date et heure Heure de début (UTC) des heures d’ouverture de la file d’attente si elle se trouve en dehors des heures d’ouverture. Pendant les heures de fonctionnement, la valeur 01-01-0001 est renvoyée.
EndTimeOfNextOperatingHour Date et heure Heure (UTC) à laquelle les heures d’ouverture se terminent pour la file d’attente si elle se trouve en dehors des heures d’ouverture. Pendant les heures de fonctionnement, la valeur 01-01-0001 est renvoyée.
nexttransitiontime Date et heure Heure (UTC) à laquelle la file d’attente est à nouveau opérationnelle si elle est en dehors des heures d’ouverture. Le temps pendant lequel la file d’attente n’est pas opérationnelle est affiché pendant les heures d’ouverture.
positionInQueue Number Position dans la file d’attente d’un client qui attend derrière d’autres clients dans la même file d’attente.
isAgentAvailable Booléen Affiche:
- TRUE si les agents de la file d’attente sont actuellement disponibles pour prendre des demandes en fonction des règles de routage et d’affectation configurées pour le flux de travail. L’API renvoie également true si un bot est attaché au flux de travail ou à une file d’attente. Nous recommandons de ne pas utiliser cette API lorsqu’un bot est présent.
- FAUX si les agents ne sont pas disponibles pour prendre des demandes.
averageWaitTime Number Temps d’attente moyen en minutes pour les clients de la file d’attente cible sur la base des données des dernières 48 heures.

Example

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

Passez des valeurs de contexte personnalisées pour la fonction afin de vous assurer que le contexte est reçu

Cette méthode effectue un appel interne à la fonction setContextProvider, puis appelle getAgentAvailability de manière synchrone, pour s’assurer que le contexte est défini avant de continuer. En raison de la nature asynchrone des fonctions lorsqu’elles sont utilisées séparément, le contexte peut ne pas être prêt lorsque l’agent consultant est disponible.

Note

Vous n’avez pas besoin d’appeler la méthode setContextProvider avant d’appeler getAgentAvailability.

Voici un exemple de code qui montre comment utiliser la setContextProvider méthode.

// 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
Référence du SDK de conversation instantanée en direct