getAgentAvailability

Omnichannel for Customer Service bietet eine Reihe von Funktionalitäten, die die Möglichkeiten von Dynamics 365 Customer Service Enterprise erweitern und es Unternehmen ermöglichen, über digitale Nachrichtenkanäle sofort mit ihren Kunden in Kontakt zu treten und sich mit ihnen zu engagieren. Für den Zugriff auf Omnichannel for Customer Service ist eine zusätzliche Lizenz erforderlich. Weitere Informationen finden Sie auf den Seiten Dynamics 365 Customer Service Preisübersicht und Dynamics 365 Customer Service Preisplan.

Ruft die Agentenverfügbarkeit für eine Warteschlange basierend auf den Routingregeln ab. Der Omnichannel-Entwickler kann diese API verwenden, um zu bestimmen, ob die Option zum Starten eines Gesprächs für den Kunden sichtbar sein soll, und auch um Informationen wie Wartezeit und Position in Warteschlangen anzuzeigen.

Hinweis

• Lauschen Sie auf das lcw:ready-Ereignis , das von einem Livechat ausgelöst wird, bevor Sie die Livechat-SDK-Methoden aufrufen. Die Live-Chat-Methoden können aufgerufen werden, nachdem das lcw:ready-Ereignis ausgelöst wurde. Sie können auf dieses Ereignis lauschen, indem Sie dem window-Objekt einen eigenen Ereignis-Listener hinzufügen.
• Diese Methode kann mehrmals von der Clientseite aus aufgerufen werden, wenn sich die Kundeneingabe ändert. Der clientseitige Cache wird alle 2 Minuten oder wenn sich die Kundenkontextparameter ändern, aktualisiert.
• Diese Methode kann nur 100 Mal pro Minute und Organisation aufgerufen werden. Wenn Sie den Grenzwert überschreiten, wird der Antwortstatuscode http 429 angezeigt, der angibt, dass Sie in einem bestimmten Zeitraum zu viele Anforderungen gesendet haben.

Syntax

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

Die Parameter

Nichts

Rückgabewert

Name	Typ	Description
queueId	String	Die Zielwarteschlange, an die die Anforderung basierend auf der Konfiguration der Routingregel und den Eingabedaten weitergeleitet wird (der Wert der Entität und des Kontexts, die Teil der Routingregel sind, werden bereitgestellt).
isQueueAvailable	Boolean	Zeigt: - TRUE, wenn sich die Warteschlange innerhalb der Betriebszeiten befindet. - FALSE, wenn sich die Warteschlange außerhalb der Betriebszeiten befindet.
StartTimeOfNextOperatingHour	DateTime	Die Startzeit (UTC) der Betriebszeiten für die Warteschlange, wenn sie außerhalb der Betriebszeiten liegt. Während der Betriebszeiten wird der Wert 01-01-0001 zurückgegeben.
EndTimeOfNextOperatingHour	DateTime	Die Zeit (UTC), zu der die Betriebszeiten für die Warteschlange enden, wenn sie außerhalb der Betriebszeiten liegt. Während der Betriebszeiten wird der Wert 01-01-0001 zurückgegeben.
nexttransitiontime	DateTime	Die Zeit (UTC), zu der die Warteschlange wieder betriebsbereit ist, wenn sie außerhalb der Betriebszeiten liegt. Die Zeit, zu der die Warteschlange nicht betriebsbereit ist, wird während der Betriebszeiten angezeigt.
positionInQueue	Number	Die Position in der Warteschlange für einen Kunden, der hinter anderen Kunden in derselben Warteschlange wartet.
isAgentAvailable	Boolean	Zeigt: - TRUE, wenn Agenten in der Warteschlange derzeit verfügbar sind, um Anfragen basierend auf konfigurierten Routing- und Zuweisungsregeln für Workstream entgegenzunehmen. Die API gibt auch true zurück, wenn ein Bot an den Workstream oder eine Warteschlange angefügt ist. Es wird empfohlen, diese API nicht zu verwenden, wenn ein Bot vorhanden ist. - FALSE, wenn Agenten nicht verfügbar sind, um Anfragen entgegenzunehmen.
averageWaitTime	Number	Durchschnittliche Wartezeit in Minuten für Kunden in der Zielwarteschlange basierend auf den Daten der letzten 48 Stunden.

Example

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

Übergeben Sie benutzerdefinierte Kontextwerte für die Funktion, um sicherzustellen, dass der Kontext empfangen wird

Diese Methode führt einen internen Aufruf der setContextProvider-Funktion aus und ruft dann getAgentAvailability synchron auf, um sicherzustellen, dass der Kontext festgelegt ist, bevor fortgesetzt wird. Aufgrund der asynchronen Natur der Funktionen, wenn sie separat verwendet werden, ist der Kontext möglicherweise nicht bereit, wenn der Beratungsagent verfügbar ist.

Hinweis

Sie müssen die setContextProvider-Methode nicht aufrufen, bevor Sie getAgentAvailability aufrufen.

Im Folgenden finden Sie einen Beispielcode, der zeigt, wie die setContextProvider Methode verwendet wird.

// 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}

        }

    }

    );

Verwandte Informationen

startChat
setContextProvider
Livechat SDK Referenz