Mobile SDK

Supported Operating Systems:
  • Android v7 ou superior, escrito em Kotlin v2.x ou superior
  • iOS v15.0 ou superior, escrito em Swift
  • Estruturas Híbrido não são suportadas

Versão Atual:

Referências de API:

Para ajudá-lo a iniciar a implementação do Mobile SDK, você deve adquirir o pacote de implementação básico de NiCE. Um parceiro da NiCE o orienta durante a implementação.

Você também pode querer comprar horas de Serviços Profissionais de NiCE para perguntas sobre configuração fora do Mobile SDK.

Mobile SDK permite que você integre o NiCE CXone chat digital aos aplicativos de telefone móvel da sua empresa. Isso permite que os usuários do aplicativo (contatosClosed A pessoa que interage com um agente, Rvi ou bot em seu contact center.) conversem por chat com os agentes do seu contact center e com agentes virtuaisClosed Um aplicativo de software que gerencia as interações com clientes no lugar de um agente humano ao vivo. por meio de canaisClosed Diversos meios de comunicação por voz e digitais que facilitam as interações com o cliente em uma central de contato. de chat digitaisClosed Qualquer canal, contato ou competência associado a Digital Experience (DX).. O SDK simplifica o processo de implementação do chat digital; os desenvolvedores não precisam lidar com a implementação da lógica comercial. A tarefa principal dos seus desenvolvedores é exibir visualmente e gerenciar os recursos que você configura em NiCE CXone, como notificações por push ou mensagens enriquecidasClosed Elementos em mensagens digitais, como botões, imagens, menus e seletores de opção..

O SDK é compatível com aplicativos iOS e Android. Os aplicativos iOS devem ser escritos em Swift Este link é aberto em uma nova janela e os aplicativos Android devem ser escritos em Kotlin Este link é aberto em uma nova janela. Além disso, o SDK exige uma versão MÍNIMA Android de 7.0 e uma versão MÍNIMA iOS de 15.0.

Com Mobile SDK:

Para uma visão rápida dos benefícios do SDK, você pode consultar a Mobile SDK data sheet Este link é aberto em uma nova janela. Você também pode assistir a um breve vídeo de demonstração Este link é aberto em uma nova janela.

Recursos de SDK

Baixe os pacotes do SDK em repositórios GitHub públicos (Android This link opens in a new window iOS This link opens in a new window). Ambos os repositórios contêm um arquivo README para ajudar você a começar a desenvolver. Eles também oferecem casos de uso com exemplos de código em /docs. Use isso como inspiração ao desenvolver seu chat. Ambos os repositórios também incluem logs de alterações.

Você pode acessar as referências de API no seu navegador (Android This link opens in a new window iOS This link opens in a new window).

Seus desenvolvedores também podem consultar aplicativos de exemplo para as plataformas Android This link opens in a new window e iOS This link opens in a new window. Isso ajuda os desenvolvedores a ver exemplos de funcionalidades implementadas.

Mobile SDK Versionamento

As VERSÕES do SDK geralmente são atualizadas junto com as principais versões de marketing do NiCE CXone, como 25.4, 26.1, e assim por diante. No GitHub, cada versão de lançamento é marcada de acordo com o versionamento semântico explicado abaixo.

Você é responsável por manter seu aplicativo atualizado conforme o SDK também é atualizado. A seção Recursos de SDK acima fornece links para os recursos mais atualizados. Nos repositórios de SDK, você pode usar as tags para encontrar versões anteriores do SDK. O erro sdkVersionNotSupported informa que a versão do seu SDK está desatualizada e você deve atualizá-la.

Esteja atento ao fato de que o SDK é compatível com versões anteriores até as últimas duas versões principais.

NiCE suporta a versão atual e a versão principal anterior do SDK. Por exemplo, se a versão atual for 2.2, NiCE suporta v2.2 e 1.3 (a versão 1.x.x mais recente).

Alterações de versão

Quando a versão do SDK muda de uma versão para outra, o número da versão indica o tipo de alteração:

  • 2.0.0: O primeiro número denota a alteração importante da API.

  • 2.1.0: O segundo número indica uma alteração sem quebra de compatibilidade. Frequentemente, novos recursos são adicionados como alterações sem quebra de compatibilidade.

  • 2.0.1: O terceiro número indica uma correção de bug. Estas são sempre compatíveis com versões anteriores.

Correções de bugs

NiCE Serviços Profissionais trabalha com você em correções de bugs. Você pode enviar bugs por meio deles (ou do parceiro de implementação), e eles comunicam as correções a você além do changelog do SDK.

Além disso, todos os bugs são corrigidos nas versões atualmente suportadas. Por exemplo, se a versão atual for a 3.0, as duas versões suportadas são a 3.0 e a 2.3 (a versão mais recente da série 2.x). Se você encontrou um bug na v2.1, NiCE o corrigiria para a 2.3 e a 3.0, mas não para a 2.1 ou a 2.2.

Como o Mobile SDK se Encaixa no Digital Experience (DX)

O Mobile SDK é uma forma de estender o Digital Experience (DX) e fornecer chat digital em aplicativos móveis. O Digital Experience (DX) é a parte do NiCE CXone que oferece suporte a digital channels. Exemplos de digital channels são WhatsApp, postagens em Facebook ou chat digital. Para adicionar o chat digital do NiCE CXone aos seus aplicativos, você deve configurar determinados recursos na seção Digital Experience (DX) da interface NiCE CXone. Em seguida, com o SDK, você acessa e usa os recursos que configurou em NiCE CXone.

Por exemplo, parte do processo inicial é configurar um canal de chat digital no NiCE CXone. Em seguida, seu aplicativo deve criar uma conexão WebSocket com o canal de chat digital que você criou. Você também pode configurar recursos avançados, como mensagens de boas-vindas ou pesquisas pré-chat. Essas oferecem uma variedade de opções para simplificar a experiência dos usuários do aplicativo. Os usuários podem fornecer informações iniciais sobre seu problema ou solicitação, inserir dados pessoais básicos e assim por diante. Esses recursos são inicialmente configurados no NiCE CXone, que você pode usar com o SDK.

Diagrama da infraestrutura do SDK para dispositivos móveis

Chat UI

O Mobile SDK vem com um módulo de UI/UX padrão. Você pode optar por implementá-lo como parte do pacote de implementação padrão. Isso reduz substancialmente o tempo de implementação.

Módulo de UI padrão

O módulo padrão trata automaticamente de todos os recursos de chat, o que reduz a necessidade de qualquer desenvolvimento adicional de sua parte, como:

O aplicativo de exemplo Mobile SDK mostra a UI/UX padrão. A documentação do módulo de UI/UX está no próprio módulo, para que seus desenvolvedores a revisem.

Personalização de cor

Você pode escolher as cores de 33 partes diferentes da interface do usuário do chat, variando de títulos a botões. Isso inclui tanto o modo claro quanto o modo escuro. Como parte do pacote de implementação padrão, você define essas cores. As cores padrão seguem a marca NiCE, que você pode alterar.

Após a implementação, seus desenvolvedores podem controlar as cores com um gerenciador de cores na classe ChatStyle.

Desenvolva sua própria interface do usuário

Você também pode optar por usar ou desenvolver sua própria UI; você não é obrigado a usar a UI/UX padrão. Se você usar sua própria UI (ou um pacote de UI de terceiro), NiCE não fornece suporte para ela.

Da mesma forma, você pode querer fazer determinadas personalizações de configurações na UI padrão, como localização, notificações por push e autenticação OAuth. Se você quiser dar suporte a algum idioma além de Inglês, você deve fornecer traduções para as cadeias de texto. Se você implementar um idioma que não seja Inglês, certifique-se de testar todas as áreas da UI para garantir que a exibição seja tratada adequadamente.

Se seus desenvolvedores fizerem personalizações adicionais além da UI/UX padrão, NiCE não oferece suporte para essas alterações.

AI Rótulos do Assistant no Mobile SDK

Para cumprir as regulamentações globais de transparência de AI (como a Lei de IA da UE), o CXone Mobile SDK agora pode identificar automaticamente quando um contato está interagindo com uma IA em vez de um agente humano.

Quando ativado, as mensagens enviadas por agentes virtuaisClosed Um aplicativo de software que gerencia as interações com clientes no lugar de um agente humano ao vivo. ou sistemas automatizados exibem um rótulo "AI Assistant" na Interface de chat.

Recursos chave

  • Identificação automática: O SDK detecta mensagens geradas por AI e aplica o rótulo de divulgação automaticamente.

  • Texto personalizável: O rótulo padrão é "AI Assistant." Para o DX Chat, você pode personalizar esse texto nas configurações de Translations. Para implementações do Mobile SDK, o texto do rótulo deve ser codificado diretamente no projeto do aplicativo móvel, pois o Mobile SDK não usa as configurações de Translation/localização.

Pré-requisitos

  • Mobile SDK: Versão 4.0 (versão 26.3) (iOS e Android).

  • Para habilitar ou desabilitar o indicador AI, navegue até ACD > Points of Contact Digital > Chat > Basics > configurações de AI e selecione ou desmarque a caixa de seleção indicador de AI.

Personalizando o Rótulo

Para canais de DX Chat, você pode personalizar o texto do rótulo "AI Assistant" através das configurações de Translations (ACD > Points of Contact Digital > Chat > Translations).

Para implementações de Mobile SDK, o texto do rótulo deve ser codificado diretamente no projeto do aplicativo móvel. O Mobile SDK não usa as configurações de Tradução/localização. Para usar termos alternativos, como "Bot", "Virtual Assistant" ou "Chatbot", seus desenvolvedores devem atualizar a string codificada diretamente no código do aplicativo.

Para desenvolvedores que constroem interfaces personalizadas, a propriedade booleana isAiGenerated está disponível no DTO (Data Transfer Object) de mensagem.

  • Propriedade: isAiGenerated

  • Tipo: Booleano

  • Comportamento: Quando a caixa de seleção AI indicador estiver selecionada nas configurações do canal, o SDK inclui a propriedade isAiGenerated na carga útil da mensagem. Quando verdadeiro, a interface do usuário exibe o rótulo \"AI Assistant\" próximo à mensagem. Se a caixa de seleção estiver desmarcada, essa propriedade é omitida da carga útil da mensagem para evitar impacto no código personalizado existente.

Fatos principais

  • Para ajudá-lo a começar a implementar o Mobile SDK, você deve adquirir o pacote de implementação básico de NiCE. Um parceiro da NiCE o orienta durante a implementação.

  • Talvez você queira comprar horas de Serviços Profissionais de NiCE para perguntas sobre a configuração fora do Mobile SDK.

  • O SDK não pode ser usado sem um aplicativo móvel existente. Você deve ter seu próprio aplicativo escrito nativamente em Kotlin ou Swift.

  • Frameworks não nativos ou híbridos não são suportados, como React Native.

  • Este SDK funciona com chat digital autônomo, não com chat via Guide.

  • O Mobile SDK armazena em cache as informações de canal por cinco minutos. Quando o usuário minimiza o aplicativo ou passa para outra tela e depois retorna, o SDK usa as informações de canal armazenadas em vez de solicitá-las novamente.

    • Se você alterar as configurações de um canal em NiCE CXone, a atualização pode levar até cinco minutos para aparecer no aplicativo porque o SDK ainda está usando sua cópia armazenada em cache das informações do canal.

    • O SDK limpa as informações do canal em cache imediatamente quando um contato efetua logout ou quando o aplicativo é reinicializado com um id de canal diferente. O cache não é limpo quando o aplicativo passa para o plano de fundo ou para o primeiro plano; a expiração de cinco minutos abrange esse caso.

Antes de Iniciar o Desenvolvimento

Considere os itens a seguir antes de criar com o Mobile SDK:

  • Você tem uma conta de administrador e de agente no NiCE CXone? Um administrador pode ajudá-lo a configurar os recursos necessários na plataforma NiCE CXone?
  • Seu aplicativo móvel está disponível para iOS (Apple), Android ou ambos? Seus desenvolvedores estão familiarizados com as linguagens Swift e Kotlin?
  • Você tem canais de mensagens de chat existentes ou quer criar um novo?
  • Você usará OAuth para autenticar os usuários do seu aplicativo? Se sim, qual provedor OAuth você usará?
  • Você deseja oferecer conversas single-thread ou multi-thread?
  • Você usará ações proativas como pop-ups ou mensagens de Bem-vindos?
  • Deseja usar notificações por push? Você tem contas no Firebase ou no Apple Developer?
  • Quais tipos de mensagens interativas você deseja configurar? Quais são alguns casos de uso em que você pode aproveitar essas mensagens interativas?
  • Você quer monitorar os dados do usuário? Como você pode usar os eventos de visitantes para gerar análises?

Termos-chave

TermoDetalhes
Conversa Uma conversa dentro do aplicativo de chat. A primeira mensagem enviada pelo agente ou contatoClosed A pessoa que interage com um agente, Rvi ou bot em seu contact center. 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-threadUm design de aplicativo em que o contato só pode ter uma conversa por vez.
Canal de mensagens (multithread)Um canal assíncrono em que um cliente pode manter diversas conversas de longa duração simultaneamente. O SDK expõe getThreadList(), nomenclatura de threads e arquivamento aqui.
CanalNo contexto de Digital Experience (DX), canal refere-se ao tipo de mensagem ou à plataforma usada para comunicação. Por exemplo, você pode ter um canal de mensagens em tempo real do WhatsApp. O Mobile SDK permite que você adicione um canal de mensagens de chat ao seu aplicativo móvel. Um canal é criado na plataforma NiCE CXone. 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.
ChannelIdO ID do canal de chat digital criado na seção Digital de NiCE CXone. Você pode encontrar isso nas configurações do canal de chat em NiCE CXone (ACD > Digital > Points of Contact Digital > Chat > Initialization & Testar).
BrandIdThis é como um ID de locatárioClosed Agrupamento organizacional de alto nível usado para gerenciar o suporte técnico, o faturamento e as configurações globais do seu sistema NiCE CXone. para Digital Experience (DX). É usado para inicializar o chat. Você pode encontrar isso nas configurações do canal de chat em NiCE CXone (ACD > Digital > Points of Contact Digital > Chat > Initialization & Test).
CustomerIdId exclusivo do usuário final do chat. O SDK cria esse ID quando o chat é inicializado. Se você configurou o OAuth, esse ID permanece o mesmo para cada contato em todos os seus dispositivos. Se você não tem OAuth configurado, esse ID é diferente para cada dispositivo; o ID passa a funcionar como um login de convidado.
Região ou AmbienteA localização no mundo onde sua implantação do NiCE 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 NiCE CXone está hospedado, caso contrário a conexão de chat será rejeitada.
Contato, Cliente e UsuárioEsses termos todos 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.
NiCE CXoneA plataforma principal em que você gerencia e acessa todas as ferramentas de experiência do cliente que NiCE CXone oferece. Dependendo de quais recursos de chat você deseja oferecer em seu aplicativo móvel, um administrador com as permissões de conta de usuário necessárias deve concluir várias tarefas de configuração em NiCE CXone.
Digital Experience (DX)A seção de NiCE CXone onde você pode gerenciar tudo sobre digital channels.
MarcaSua empresa ou conta em NiCE CXone, identificada por um brandId numérico. Todas as configurações de chat ficam sob uma marca.
Canal Livechat (sessão única)Uma sessão síncrona, roteada por agente. O chat deve ser iniciado explicitamente (startChat()) e pode ser encerrado (endChat()), e o cliente pode esperar em uma fila DE espera. O SDK retorna um LivechatThread para esses canais.
ConversaUma conversa dentro de um canal, identificada por um id da conversa. Ela contém o histórico de mensagens e é a sua principal referência para enviar e receber mensagens.
Contato, caso e interação

Uma única interaçãoClosed A conversa completa com um agente por meio de um canal. Por exemplo, uma interação pode ser uma chamada de voz, um e-mail, um chat ou uma conversa em mídia social. roteada criada a partir de um thread. É a unidade que o agente efetivamente seleciona e com a qual trabalha. Um thread pode produzir múltiplos contatos ao longo de seu ciclo de vida (por exemplo, um novo contato cada vez que o cliente retoma o contato após o encerramento).

No NiCE CXone ajuda online, o termo interaction é usado com mais frequência. O termo case é usado em algumas páginas de ajuda de Digital Experience (DX). Contact é usado em contextos técnicos, como SDK ou conteúdo de ajuda de Studio, e geralmente se refere ao id que NiCE CXone atribui a um segmento de uma conversa ou interação completa (contactId).

MensagemUm único item em um tópico — texto, um anexo ou conteúdo interativo — criado pelo cliente ou pelo agente.
AgenteUm ser humano (ou bot) do lado de NiCE CXone que atende o contato. A atribuição e a digitação do Agente aparecem como eventos.
Visitante ou visitaIdentificadores de análise leves para a pessoa que está navegando (visitorId) e sua sessão de navegação atual (visitId). Eles são gerados para você caso não os forneça e são importantes principalmente para chat proativo e análises.