Compartir a través de

notifyEvent (referencia de API JavaScript) para Marco de integración de canal de Dynamics 365 2.0

Muestra una notificación que se puede utilizar para informar al agente sobre conversaciones entrantes.

Sintaxis

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

Parámetros

Name Type Obligatorio Description
input Objeto JSON Sí String
correlationId GUID No Se usa para agrupar todas las llamadas API relacionadas para telemetría de diagnóstico.
cancellationToken String No Es la cadena única que utiliza el método cancelEvent para cancelar las notificaciones sobre conversaciones entrantes.
successCallback Function No Una función para llamar cuando la solicitud se realiza correctamente. En caso de una devolución de llamada correcta, el objeto de respuesta tendrá la información sobre si el cliente aceptó o rechazó la conversación.
errorCallback Function No Una función para llamar cuando la solicitud produce error.

Detalles de la función de devolución de llamada

Los siguientes objetos se pasan a las funciones successCallback y errorCallback.

Función successCallback

Objeto JSON de ejemplo:

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

Parámetros

actionName responseReason Description
Accept Accept Cuando el usuario acepta la notificación
Accept AutoAccept La notificación se acepta de forma predeterminada a través de una plantilla de notificación
Rechazar DeclinedByAgent Cuando el usuario rechaza la notificación
Rechazar NotificationQueueLimitExceeded La notificación se rechaza si el límite supera las diez notificaciones en la cola
Rechazar NotificationQueueTimeLimitExceeded Cuando una notificación en la cola excede el período de tiempo de espera configurado
Temporización DisplayTimeout Cuando el usuario no responde a la notificación dentro del período de tiempo de espera

Función errorCallback

Objeto JSON de ejemplo:

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

Parámetros

message Description
NotificationTemplateNotFoundError Cuando no se encuentra el nombre de la plantilla especificada
RejectAfterClientError Se produjo una excepción desconocida (ocurre cuando falla la llamada a la API de la plataforma o falta algún parámetro de entrada)

Ejemplo

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