Compartilhar via

Referência do SDK do chat ao vivo

O Omnichannel for Customer Service oferece um conjunto de recursos que ampliam o poder do Dynamics 365 Customer Service Enterprise para permitir que as organizações se conectem e interajam instantaneamente com clientes em canais de mensagens digitais. É necessária uma licença adicional para acessar o Omnichannel for Customer Service. Para obter mais informações, consulte as páginas Visão geral de preços do Dynamics 365 Customer Service e Plano de preços do Dynamics 365 Customer Service.

Os métodos JavaScript a seguir podem ser usados para fazer várias operações com o widget de chat ao vivo do Omnicanal para Customer Service.

Methods

Método Description
setContextProvider Define o provedor de contexto para canais de chat ao vivo. A função do provedor de contexto, quando invocada, retorna o contexto a ser usado para inicializar uma sessão de chat.
getContextProvider Recupera o provedor de contexto personalizado definido no momento, se houver.
removeContextProvider Remove o provedor de contexto personalizado definido no momento, se houver.
setAuthTokenProvider Define o provedor de token de autenticação.
getAuthTokenProvider Obtém o provedor de token de autenticação definido no momento, se houver.
removeAuthTokenProvider Remove o provedor de token de autenticação definido no momento, se houver.
startChat Abre um bate-papo existente, se houver. Caso contrário, ele inicia um novo bate-papo. Você pode usar o customContext parâmetro no método para passar diretamente o contexto para inicializar a sessão de chat
startProactiveChat Permite que as organizações envolvam os usuários convidando-os automaticamente para uma conversa de chat com base nas regras configuradas.
closeChat Encerra a conversa entre o agente e o cliente. Qualquer cache do navegador relacionado à conversa também é excluído.
getAgentAvailability Recupera a disponibilidade do agente para uma fila com base nas regras de roteamento. O desenvolvedor omnichannel pode usar essa API para determinar se a opção de início de conversa deve estar visível para o cliente e também para exibir informações como tempo de espera e posição nas filas.

Eventos

Event Description
lcw:ready Esse evento é gerado quando o SDK do chat ao vivo está pronto para uso.
lcw:error Esse evento é gerado caso ocorra um erro durante o tempo de vida de um chat. Para obter informações sobre códigos de erro e mensagens de erro, consulte a Referência de código de erro do Omnicanal para Customer Service.
lcw:startChat Esse evento é acionado quando um bate-papo é iniciado.
lcw:closeChat Esse evento é acionado quando um chat é fechado.
lcw:chatQueued Esse evento é gerado quando a conversa de chat é criada e iniciada.
lcw:chatRetrieved Esse evento é gerado quando o sistema recupera uma conversa de bate-papo em andamento do cache depois que uma página é recarregada ou aberta em outra guia.
lcw:onClose Esse evento é acionado quando o cliente engajado no widget de chat fecha o widget.
lcw:onMinimize Esse evento é acionado quando o cliente engajado no widget de chat minimiza o widget.
lcw:onMaximize Esse evento é acionado quando o cliente engajado no widget de chat maximiza o widget.
lcw:onMessageReceived Esse evento é acionado quando o widget de chat recebe uma nova mensagem.
lcw:onMessageSent Esse evento é acionado quando um cliente engajado no widget de chat envia uma nova mensagem.
lcw:threadUpdate Esse evento é gerado pelo chat ao vivo quando um agente encerra uma conversa.
lcw:getAgentAvailability Esse evento é gerado quando o getAgentAvailability método retorna uma resposta bem-sucedida.

Omnicanal para Customer Service para desenvolvedores

  • Last updated on