Udostępnij przez

notifyEvent (dokumentacja interfejsu API języka JavaScript) dla Dynamics 365 Channel Integration Framework 2.0

Wyświetla powiadomienie, które może być używane do informowania agenta o przychodzących rozmowach.

Składnia

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

Parametry

Name Typ Wymagane Description
dane wejściowe Obiekt JSON Tak Sznurek
correlationId (identyfikator korelacji) GUID Nie. Służy do grupowania wszystkich powiązanych wywołań interfejsu API na potrzeby telemetrii diagnostycznej.
Token anulowania Sznurek Nie. Jest unikatowym ciągiem używanym przez cancelEvent metodę do anulowania powiadomień o przychodzących rozmowach.
successCallback (pomyślne wywołanie zwrotne) Funkcja Nie. Funkcja do wywołania, gdy żądanie zakończy się pomyślnie. Po pomyślnym wywołaniu zwrotnym obiekt odpowiedzi będzie zawierał informacje o tym, czy klient zaakceptował, czy odrzucił rozmowę.
errorOddzwanianie Funkcja Nie. Funkcja do wywołania, gdy żądanie zakończy się niepowodzeniem.

Szczegóły funkcji wywołania zwrotnego

Następujące obiekty są przekazywane do funkcji and successCallbackerrorCallback .

successCallback, funkcja

Przykładowy obiekt JSON:

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

Parametry

actionName responseReason (Przyczyna odpowiedzi) Description
Akceptuj Akceptuj Gdy użytkownik zaakceptuje powiadomienie
Akceptuj Automatyczne akceptowanie Powiadomienie jest domyślnie akceptowane za pośrednictwem szablonu powiadomienia
Odrzuć Odrzucone przez agenta Gdy użytkownik odrzuci powiadomienie
Odrzuć NotificationQueueLimitExceeded Powiadomienie zostanie odrzucone, jeśli limit przekroczy dziesięć powiadomień w kolejce
Odrzuć NotificationQueueTimeLimitExceeded Gdy powiadomienie w kolejce przekroczy skonfigurowany limit czasu
Przerwa czasowa Limit czasu wyświetlania Gdy użytkownik nie odpowie na powiadomienie w przekroczonym limicie czasu

errorCallback, funkcja

Przykładowy obiekt JSON:

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

Parametry

komunikat Description
NotificationTemplateNotFoundError Gdy określona nazwa szablonu nie zostanie znaleziona
RejectAfterClientError (Odrzuć błąd klienta) Wystąpił nieznany wyjątek (występuje, gdy wywołanie interfejsu API platformy kończy się niepowodzeniem lub brakuje jakiegoś parametru wejściowego)

Example

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
                }
);
  • Last updated on