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 Mpower em uma interface de usuário de sua escolha. Este é um SDK baseado em JavaScript que suporta mensagens LiveChat e Chat Messaging ambas síncronas e assíncronas. Você também pode configurar mensagens single
Em um aplicativo de única conversa, cada contato tem uma conversa de chat que lida com qualquer interação que ele tenha com sua organização. ou multi-threaded 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 Mpower 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 Mpower 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
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
| Termo | Detalhes |
|---|---|
| Conversa | Uma conversa no aplicativode chat. A primeira mensagem enviada pelo agente ou contato 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 em que o contato só pode ter uma conversa por vez. |
| Multi-thread | Um design aplicativo em que o contato pode ter várias conversas ao mesmo tempo. |
| Canal | No contexto de Digital Experience, canal refere-se ao tipo de mensagem ou ao plataforma usado para 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 CXone Mpowerplataforma. 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. |
| Identificação do canal | O ID do canal de chat digital criado na seção Digital do CXone Mpower. Você pode encontrar isso nas configurações do canal de chat no CXone Mpower (ACD > Digital > Pontos de Contato Digital > Chat > Inicialização e teste). |
| ID da marca | É como um ID locatário Alto nível de agrupamento organizacional usado para gerenciar o suporte técnico, cobrança e configurações globais para o seu sistema CXone Mpower. para Digital Experience. É usado para inicializar o chat. Você pode encontrar isso nas configurações do canal de chat no CXone Mpower (ACD > Digital > Pontos de Contato Digital > Chat > Inicialização e teste). |
| ID do cliente | 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 Mpower 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 Mpower 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 aplicativomó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 Mpower | O plataforma principal onde você gerencia e acessa todas as ferramentas de experiência do cliente que CXone Mpower 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 Mpower. |
| Digital Experience | A seção de CXone Mpower 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 Mpower? Um administrador pode ajudar você na configuração dos recursos necessários no CXone Mpowerplataforma?
- 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?
Inicializar o bate-papo corretamente
Seus desenvolvedores devem conectar seu aplicativo a CXone Mpower para iniciar a comunicação entre si. Isso cria uma conexão WebSocket. Desenvolvedores pode fazer isso chamando await sdk.connect(). Certifique-se de instruir seus desenvolvedores a fazer isso somente para conversas de chat ativas. Isso garante que o WebSocket só seja executado quando necessário.