notifyEvent (JavaScript API-Referenz) für Dynamics 365-Kanalintegrationsframework 2.0

Zeigt eine Benachrichtigung an, mit der der Agent über eine eingehende Unterhaltung informiert werden kann.

Syntax

Microsoft.CIFramework.notifyEvent(input, correlationId, cancellationToken).then(successCallback, errorCallback);

Parameter

Name des Dataflows	Typ	Erforderlich	Beschreibung
Eingabe	JSON-Objekt	Ja	Zeichenfolge
correlationId	GUID	Nein	Zur Gruppierung aller verwandten API-Aufrufe für die diagnostische Telemetrie.
cancellationToken	Zeichenfolge	Nein	Ist die eindeutige Zeichenfolge, die von der cancelEvent-Methode zum Abbrechen von Benachrichtigungen über eingehende Gespräche verwendet wird.
successCallback	Funktion	Nein	Eine Funktion, die bei erfolgreicher Anfrage aufgerufen wird. Bei einem erfolgreichen Rückruf enthält das Antwortobjekt Informationen darüber, ob der Kunde das Gespräch angenommen oder abgelehnt hat.
errorCallback	Funktion	Nein	Eine Funktion, die aufgerufen wird, wenn die Anforderung fehlschlägt.

Details zur Callback-Funktion

Die folgenden Objekte werden an die Funktionen successCallback und errorCallback übergeben.

successCallback Funktion

JSON-Beispielobjekt:

{
	"value": {"actionName" : "Accept",
     "responseReason" : "Accept"}
}

Parameter

actionName	responseReason	Beschreibung
Accept	Accept	Wenn der Benutzer die Benachrichtigung akzeptiert
Accept	AutoAccept	Die Benachrichtigung wird als Standard über eine Benachrichtigungsvorlage akzeptiert.
Zurückweisen	DeclinedByAgent	Wenn der Benutzer die Benachrichtigung zurückweist
Zurückweisen	NotificationQueueLimitExceeded	Die Benachrichtigung wird abgelehnt, wenn der Grenzwert zehn Benachrichtigungen in der Warteschlange überschreitet
Zurückweisen	NotificationQueueTimeLimitExceeded	Wenn eine Benachrichtigung in der Warteschlange den konfigurierten Zeit-Grenzwert überschreitet
Zeitüberschreitung	DisplayTimeout	Wenn der Benutzer nicht innerhalb des Zeitgrenzwerts auf die Benachrichtigung antwortet

errorCallback Funktion

JSON-Beispielobjekt:

{
	"message" : "<error details>",
	"msdyn_name" : "NotifyEvent"
}

Parameter

Nachricht	Beschreibung
NotificationTemplateNotFoundError	wnn der angegebene Vorlagenname nicht gefunden wurde
RejectAfterClientError	Es ist eine unbekannte Ausnahme aufgetreten (tritt auf, wenn der Plattform-API-Aufruf fehlschlägt oder ein Eingabeparameter fehlt)

Beispiel

var canceltoken = "cancellationtoken"+ Math.ceil(Math.random() * 100000 + 100000).toString();

 

var input = {
                templateName: "msdyn_chat_incoming_unauthenticated",
                // unique name of the configured template
                templateParameters: {
                },
// unique random token, to identify the notification during cancelEvent call
                cancellationToken: canceltoken
}
Microsoft.CIFramework.notifyEvent(input).then(
                function success(result) {
                                console.log(result);
                                // Perform operations
                },
                function (error) {
                                console.log(error.message);
                                // Handle error conditions
                }
);