Digital SDK da Web de bate-papo

SDK: GitHub

Referência de API: GitHub Pages

Amostra de aplicativo: GitHub

Pacote NPM: npmjs.com

O SDK chat web permite criar seu próprio chat Digitalaplicativo, ou adicionar o chat Digital a um aplicativoweb existente. Ele permite usar a infraestrutura digital do CXone em uma interface de usuário de sua escolha. É um SDK baseado em JavaScriptque aceita LiveChat e Mensagem de Chat — mensagens síncronas e assíncronas. Você também pode configurar mensagens singleFechado Em um aplicativo de conversa única, cada contato pode ter apenas uma conversa de chat. Qualquer interação que eles tenham com sua organização ocorre nessa conversa de chat. ou multi-threadedFechado Se seu aplicativo for para várias conversas, seus contatos poderão criar quantas conversas desejarem para discutir novos tópicos. Essas conversas podem estar ativas ao mesmo tempo.. Este SDK oferece mais controle sobre CXone no seu site. Ajuda a evitar certas limitações técnicas que alguns sites têm. Por exemplo, seu site pode não permitir código externo, o que pode impedir a execução do chat nativo do CXone Digital.

O SDK suporta os seguintes recursos:

  • Mensagens de chat digital
  • OAuth2.0 para autorização
  • Identificação do contato e campos personalizados
  • Lista de conversas e recuperação de conversas
  • Anexos
  • Mensagens avançadas
  • Indicadores de digitação, mensagem visualizada e mensagem entregue
  • Mensagens do sistema, como eventos de status de caso ou eventos de atribuição
  • Eventos de posição na fila

Este SDK é escrito em TypeScript 4.9+. Você precisa usar também um aplicativo bundler like webpack or Create React App personalizado.

Recursos de SDK

A parte superior desta página ou o menu suspenso abaixo fornecem links para os diversos recursos de SDK.

Seus desenvolvedores podem obter o SDK do GitHub. O repositório tem um arquivo README que ajuda o desenvolvedor a começar. Também contém a documentação para eventos e a referência de API. A referência de API mais fácil de usar é hospedada separadamente em github.io.

Você também pode conferir a amostra de aplicativo. Isso permite que você teste o chat e observe o código-fonte correspondente.

Os desenvolvedores importam o SDK como um pacote NPM. A entrada do pacote em npmjs.com contém o mesmo conteúdo e instruções para configurar e criar com o SDK.

Termos-chave

  • Conversa: Uma conversa no aplicativo de chat. A primeira mensagem enviada pelo agente ou contatoFechado A pessoa que interage com um agente, RVI ou bot em seu centro de contato. inicia uma conversa. Cada mensagem consecutiva é adicionada à conversa. Conversas são objetos que contêm cada mensagem. As mensagens são estruturadas pelo autor da mensagem. Um threadId identifica uma conversa inteira e todas as mensagens dentro de uma conversa têm um ID de mensagem. Uma conversa termina quando o diálogo termina.

  • Single-Thread: Um design aplicativo onde o contato só pode ter uma conversa por vez.

  • Multi-Thread: Um design aplicativo onde o contato pode ter várias conversas ao mesmo tempo.

  • Canal: No contexto Digital Experience, canal refere-se ao tipo de mensagens ou ao plataforma usado para a comunicação. Por exemplo, você poderia ter um canal de mensagens em tempo real do WhatsApp. O SDK para dispositivos móveis permite adicionar um canal de mensagens de chat ao seu aplicativo móvel. Um canal é criado no CXoneplataforma. Isso determina as configurações do canal junto com um ID de canal. Você usa esse ID para iniciar o canal de chat quando um usuário do aplicativo abre o chat.

  • ChannelId: O ID do canal de chat digital criado na seção Digital do CXone. Você pode encontrar isso nas configurações do canal de chat no CXone (ACDDigitalPontos de Contato DigitalChatInicialização e teste).

  • BrandId: É como o ID do locatárioFechado Alto nível de agrupamento organizacional usado para gerenciar o suporte técnico, cobrança e configurações globais para o seu ambiente CXone do Digital Experience. É usado para inicializar o chat. Você pode encontrar isso nas configurações do canal de chat no CXone (ACDDigitalPontos de Contato DigitalChatInicialização e teste).

  • CustomerId: O ID exclusivo do usuário final do chat. O SDK cria esse ID quando o chat é inicializado. Se você tiver o OAuth configurado, esse ID permanecerá o mesmo para cada contato em todos os seus dispositivos. Caso não tenha configurado o OAuth, esse ID será diferente para cada dispositivo; o ID se tornará como um login de convidado.

  • Região ou ambiente: O local no mundo onde sua implantação do CXone está hospedada. Pode ser: Austrália (AU1), Canadá (CA1), Europa (EU1), Japão (JP1), América do Norte (NA1) ou Reino Unido (UK1). O desenvolvedor deve usar a mesma região onde seu sistema CXone está hospedado, caso contrário a conexão de chat será rejeitada.

  • Contato, Cliente e Usuário: Todos esses termos se referem ao usuário final do aplicativo móvel. A ajuda online normalmente usa o termo contato. Na documentação do SDK e nos comentários do código, é provável que você veja cliente e usuário.

  • CXone: O plataforma central, onde você gerencia e acessa todas as ferramentas de experiência do cliente que a NICE CXone oferece. Dependendo dos recursos de chat que você quer oferecer em seu aplicativo móvel, um administrador com as permissões de conta de usuário necessárias deverá concluir diversas tarefas de configuração no CXone.

  • Digital Experience: A seção do CXone onde você pode gerenciar tudo sobre canais digitais.

Antes de começar a desenvolver

Considere os itens a seguir antes de criar com o SDK móvel:

  • Você tem uma conta de administrador e de agente no CXone? Um administrador pode ajudar você na configuração dos recursos necessários no CXoneplataforma?
  • Você tem canais de chat existentes ou quer criar um novo?
  • Você deseja oferecer conversas single-thread ou multi-thread?
  • Que tipos de mensagens avançadas você quer configurar? Quais são alguns casos de uso em que você pode aproveitar essas mensagens interativas?
  • Você usará ações proativas como pop-ups ou mensagens de boas-vindas?