logAnalyticsEvent (Référence API JavaScript) pour l’environnement d’intégration du canal de Dynamics 365 2.0
Appelez cette méthode pour enregistrer les analyses des événements personnalisés.
Syntaxe
Microsoft.CIFramework.logAnalyticsEvent(data, eventName, correlationId).then(successCallback, errorCallback);
Paramètres
| Nom | Type | Requise | Description |
|---|---|---|---|
| Données | Objet JSON | Oui | Saisie d’JSON |
| eventName | String | Oui | Le nom de l’événement |
| correlationId | GUID | No | Utilisé pour regrouper tous les appels d’API associés pour la télémétrie de diagnostic. |
| successCallback | Function | No | Une fonction à appeler lorsque le promesse est correctement retournée. |
| errorCallback | Function | No | Une fonction à appeler lorsque la demande de retour de la promesse échoue. |
Voici la structure du paramètre data JSON. Assurez-vous d’inclure les champs : conversationId et providerSessionId.
{
"conversationId": "<Conversation identifier>",
"providerSessionId": "<Channel Integration Framework Provider Id>",
"clientSessionId":"<Client session identifier>",
"participantId":"<Participant identifier>",
"events": [
{
"kpiEventName": "<Name of the associated KPI event>",
"kpiEventReason": "<Reason due to which the KPI event was created>",
"eventTimestamp": "<Timestamp at which the event occurred>",
"additionalData": "<Additional data related to the session>",
"notificationResponseAction":"<Agent notification response action value>",
"externalCorrelationId": "<External system correlation Id>",
"customData": [
{
"attribute": "<name>",
"value": "<value>"
}
]
}
]
}
Valeur renvoyée
Promesse avec une valeur de chaîne
Exemple
//Success callback handler
const successCallback = (result) => {
// result will indicate if the custom analytics event has been logged
console.log(result);
};
//Failure callback handler
const errorCallback = (error) => {
// handling failure
console.error(error)
};
Microsoft.CIFramework.logAnalyticsEvent(data, eventName, correlationId).then(successCallback, errorCallback);