notifyEvent (Referenční dokumentace rozhraní JavaScript API) pro Dynamics 365 Channel Integration Framework 2.0

Zobrazí oznámení, které lze použít k informování agenta o příchozích konverzacích.

Syntaxe

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

Parametry

Název	Typ	Povinné	Description
vstup	Objekt JSON	Ano	String
ID korelace	GUID	Ne	Slouží k seskupení všech souvisejících volání rozhraní API pro diagnostickou telemetrii.
cancellationToken	String	Ne	Je jedinečný řetězec, který metoda cancelEvent používá ke zrušení oznámení o příchozích konverzacích.
úspěchZpětné volání	Funkce	Ne	Funkce, která se má volat v případě úspěchu požadavku. Po úspěšném zpětném volání bude objekt odpovědi obsahovat informaci o tom, zda zákazník konverzaci přijal nebo odmítl.
errorCallback	Funkce	Ne	Funkce, která se má volat v případě selhání požadavku.

Podrobnosti o funkci zpětného volání

Následující objekty jsou předány do successCallback funkcí a errorCallback .

Funkce successCallback

Ukázkový objekt JSON:

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

Parametry

actionName	responseReason	Description
Přijmout	Přijmout	Když uživatel oznámení přijme
Přijmout	Automatické přijetí	Oznámení je ve výchozím nastavení přijato prostřednictvím šablony oznámení
Odmítat	DeclinedByAgent	Když uživatel oznámení odmítne
Odmítat	NotificationQueueLimitExceeded	Oznámení je odmítnuto, pokud limit přesáhne deset oznámení ve frontě
Odmítat	NotificationQueueTimeLimitExceeded	Když oznámení ve frontě překročí nakonfigurovaný časový limit
Přerušení zápasu	Časový limit zobrazení	Pokud uživatel na oznámení nereaguje během časového limitu

Funkce errorCallback

Ukázkový objekt JSON:

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

Parametry

zpráva	Description
NotificationTemplateNotFoundError	Pokud není nalezen zadaný název šablony
Chyba RejectAfterClientError	Došlo k neznámé výjimce (nastane v případě, že se nezdaří volání rozhraní API platformy nebo chybí některý vstupní parametr)

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