notifyEvent (JavaScript API-referens) för Dynamics 365 Channel Integration Framework 2.0

Visar ett meddelande som kan användas för att informera handläggaren om inkommande konversationer.

Syntax

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

Parameterar

Namn	Typ	Krävs	Description
inmatning	JSON-objekt	Yes	String
correlationId	GUID (globalt unikt identifierare)	Nej	Används för att gruppera alla relaterade API-anrop för diagnostisk telemetri.
cancellationToken	String	Nej	Är den unika sträng som används av cancelEvent metoden för att avbryta aviseringar om inkommande konversationer.
framgångCallback	Funktion	Nej	En funktion som ska anropas när begäran lyckas. Vid lyckat återanrop kommer svarsobjektet att ha information om huruvida kunden accepterade eller avvisade konversationen.
errorCallback	Funktion	Nej	En funktion som ska anropas när begäran misslyckas.

Information om återuppringningsfunktion

Följande objekt skickas till successCallback funktionerna och errorCallback .

Funktionen successCallback

Exempel på JSON-objekt:

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

Parameters

actionName	responseReason	Description
Godkänn	Godkänn	När användaren accepterar meddelandet
Godkänn	Godkänn automatiskt	Anmälan godkänns som standard via en anmälningsmall
Avvisa	DeclinedByAgent (på engelska)	När användaren avvisar meddelandet
Avvisa	NotificationQueueLimitExceeded	Meddelandet avvisas om gränsen överskrider tio meddelanden i kön
Avvisa	NotificationQueueTimeLimitExceeded	När ett meddelande i kön överskrider den konfigurerade tidsgränsen
Tidsavbrott	DisplayTimeout (på engelska)	När användaren inte svarar på meddelandet inom tidsgränsen

Funktionen errorCallback

Exempel på JSON-objekt:

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

Parameters

meddelande	Description
NotificationTemplateNotFoundError	När det angivna mallnamnet inte hittas
RejectAfterClientError	Ett okänt undantag inträffade (inträffar när plattforms-API-anropet misslyckas eller någon indataparameter saknas)

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
                }
);