Partilhar via

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

Exibe uma notificação que pode ser usada para informar o agente sobre conversas de entrada.

Sintaxe

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

Parâmetros

Nome Tipo Obrigatório Description
dados introduzidos Objeto JSON Yes Cordão
correlationId GUID Não Usado para agrupar todas as chamadas de API relacionadas para telemetria de diagnóstico.
cancellationToken Cordão Não É a cadeia de caracteres exclusiva usada pelo cancelEvent método para cancelar notificações sobre conversas de entrada.
successCallback Função Não Uma função a ser chamada quando a solicitação for bem-sucedida. No retorno de chamada bem-sucedido, o objeto de resposta terá as informações sobre se o cliente aceitou ou rejeitou a conversa.
errorCallback Função Não Uma função para chamar quando a solicitação falhar.

Detalhes da função de retorno de chamada

Os seguintes objetos são passados para as successCallback funções e errorCallback .

função successCallback

Exemplo de objeto JSON:

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

Parâmetros

actionName responseReason Description
Aceitar Aceitar Quando o usuário aceita a notificação
Aceitar Aceitação Automática A notificação é aceite por defeito através de um modelo de notificação
Rejeitar RecusadoByAgent Quando o usuário rejeita a notificação
Rejeitar NotificationQueueLimitExceeded A notificação é rejeitada se o limite exceder dez notificações na fila
Rejeitar NotificationQueueTimeLimitExceeded Quando uma notificação na fila excede o período de tempo limite configurado
Timeout DisplayTimeout Quando o usuário não responde à notificação dentro do período de tempo limite

função errorCallback

Exemplo de objeto JSON:

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

Parâmetros

mensagem Description
NotificationTemplateNotFoundError Quando o nome do modelo especificado não é encontrado
RejectAfterClientError Ocorreu uma exceção desconhecida (ocorre quando a chamada à API da plataforma falha ou algum parâmetro de entrada está ausente)

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
                }
);
  • Last updated on