Partager via

notifyEvent (Référence API JavaScript) pour l'environnement d'intégration du canal de Dynamics 365 2.0

Affiche une notification qui peut être utilisée pour informer l’agent des conversations entrantes.

Syntaxe

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

Paramètres

Nom  Type Requise Description
input Objet JSON Oui String
correlationId GUID Non Utilisé pour regrouper tous les appels d'API associés pour la télémétrie de diagnostic.
cancellationToken String Non Chaîne unique utilisée par la méthode cancelEvent pour annuler les notifications sur les conversations entrantes.
successCallback Function Non Fonction à appeler lorsque la demande aboutit. En cas de rappel réussi, l’objet de réponse contiendra des informations indiquant si le client a accepté ou rejeté la conversation.
errorCallback Function Non Fonction à appeler lorsque la requête échoue.

Détails de la fonction de rappel

Les objets suivants sont passés dans les fonctions successCallback et errorCallback .

Fonction successCallback

Exemple d’objet JSON :

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

Paramètres

actionName responseReason Description
Accept Accept Lorsque l’utilisateur accepte la notification
Accept AutoAccept La notification est acceptée par défaut via un modèle de notification
Rejeter DeclinedByAgent Lorsque l’utilisateur rejete la notification
Rejeter NotificationQueueLimitExceeded La notification est rejetée si la limite dépasse dix notifications dans la file d’attente
Rejeter NotificationQueueTimeLimitExceeded Lorsqu’une notification dans la file d’attente dépasse le délai d’expiration configuré
Délai d’attente DisplayTimeout Lorsque l’utilisateur ne répond pas à la notification dans le délai d’expiration

Fonction errorCallback

Exemple d’objet JSON :

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

Paramètres

message Description
NotificationTemplateNotFoundError Lorsque le nom du modèle spécifié est introuvable
RejectAfterClientError Une exception inconnue s’est produite (se produit lorsque l’appel de l’API Platform échoue ou qu’un paramètre d’entrée est manquant)

Exemple

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