Compartilhar via

logAnalyticsEvent (Referência da API JavaScript) para Dynamics 365 Channel Integration Framework 2.0

Invoque esse método para registrar o Analytics para eventos personalizados.

Sintaxe

Microsoft.CIFramework.logAnalyticsEvent(data, eventName, correlationId).then(successCallback, errorCallback);

Parâmetros

Nome Tipo Obrigatório Description
dados Objeto JSON Yes Entrada JSON
nome_do_evento String Yes Nome do evento
correlationId GUID Não Usado para agrupar todas as chamadas de API relacionadas para telemetria de diagnóstico.
sucessoRetorno de chamada Função Não Uma função a ser chamada quando a promessa for retornada com êxito.
erroRetorno de chamada Função Não Uma função a ser chamada quando a solicitação para retornar a promessa falhar.

Aqui está a estrutura do data parâmetro JSON. Certifique-se de incluir os campos: conversationId e 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>"
				}
			]
		}
	]
}

Valor de retorno

Promessa com valor como string

Example

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

updateConversation
Análise de canal

  • Last updated on