Mobile SDK

Supported Operating Systems:
  • Android v7 o superior, escrito en Kotlin v2.x o superior
  • iOS v15.0 o superior, escrito en Swift
  • Los marcos de trabajo Híbrido no son compatibles
Current Version:
API References:

Para ayudarlo a comenzar a implementar el SDK móvil, debe adquirir el paquete de implementación básico en NiCE. Un socio de NiCE lo guía durante la implementación.

También puede que desee comprar horas de Servicios Profesionales de NiCE para preguntas sobre la configuración que queden fuera de Mobile SDK.

Mobile SDK le permite integrar NiCE CXone conversación digital en las aplicaciones móviles empresariales de su empresa. Esto permite que los usuarios de la aplicación chateen con los agentes y bots de su centro de contacto a través de canales de chat digitalClosed Cualquier canal, contacto o habilidad asociado con Digital Experience (DX).. El SDK simplifica el proceso de implementación del chat digital; los desarrolladores no necesitan encargarse de la implementación de la lógica empresarial. La tarea principal de sus desarrolladores es mostrar visualmente y administrar las funciones que usted configura en NiCE CXone, como las notificaciones push o los mensajes enriquecidosClosed Elementos en la mensajería digital, como botones, imágenes, menús y selectores de opciones..

El SDK admite tanto aplicaciones iOS como Android. Las aplicaciones iOS deben estar escritas en Swift Este enlace se abre en una ventana nueva y las aplicaciones Android deben estar escritas en Kotlin Este enlace se abre en una ventana nueva. Además, el SDK requiere una versión MÍNIMA de Android de 7.0 y una versión MÍNIMA de iOS de 15.0.

Con Mobile SDK:

Para obtener una vista rápida de los beneficios del SDK, puede consultar la hoja de datos de Mobile SDK Este enlace se abre en una ventana nueva. También puede ver un breve video de demostración Este enlace se abre en una ventana nueva.

Recursos del SDK

Descargue los paquetes del SDK desde los repositorios públicos de GitHub (Android Este enlace abre una nueva ventana iOS This link opens in a new window). Ambos repositorios contienen un archivo README para ayudarlo a empezar a desarrollar. Ellos también ofrecen casos de uso con muestras de código en /docs. Úselos como inspiración mientras desarrolla su chat. Ambos repositorios también incluyen registros de cambios.

Puede acceder a las referencias de la API en su navegador (Android This link opens in a new window iOS This link opens in a new window).

Sus desarrolladores también pueden consultar aplicaciones de ejemplo para ambos Android Este enlace abre una nueva ventana y iOS This link opens in a new window plataformas. Esto ayuda a los desarrolladores a ver ejemplos de funcionalidad implementada.

Mobile SDK Versiones

Las versiones del SDK generalmente se actualizan junto con los lanzamientos principales de márketing de NiCE CXone, como 25.4, 26.1, y así sucesivamente. En GitHub, cada versión de lanzamiento se etiqueta de acuerdo con el versionado semántico que se explica a continuación.

Usted es responsable de mantener su aplicación actualizada a medida que el SDK también se actualiza. La sección más arriba de Recursos del SDK proporciona enlaces a los recursos más actualizados. En los repositorios del SDK, puede utilizar las etiquetas para encontrar versiones anteriores del SDK. Además, el Error sdkVersionNotSupported le indica que la versión de su SDK está desactualizada y que debe actualizarla.

Tenga en cuenta que el SDK es retrocompatible con las últimas dos versiones principales.

NiCE admite la versión principal actual y la versión principal anterior del SDK. Por ejemplo, si la versión actual es 2.2, NiCE admite v2.2 y 1.3 (la última versión 1.x.x).

Cambios de versión

Cuando la versión del SDK cambia de una versión a otra, el número de versión indica el tipo de cambio:

  • 2.0.0: El primer número indica el cambio importante de la API.

  • 2.1.0: El segundo número indica un cambio que no genera incompatibilidad. A menudo, las funciones nuevas se agregan como cambios que no generan incompatibilidad.

  • 2.0.1: El tercer número denota una corrección de errores. Estas siempre son compatibles con versiones anteriores.

Correcciones de errores

NiCE Servicios profesionales trabaja con usted en la corrección de errores. Puede enviar los errores a través de ellos (o del socio de implementación), y ellos le comunican las correcciones además del registro de cambios del SDK.

Además, los errores se corrigen en las versiones actualmente admitidas. Por ejemplo, si la versión actual es 3.0, entonces las dos versiones admitidas son 3.0 y 2.3 (la última versión de 2.x). Si encontró un error en la v2.1, NiCE lo corregiría para 2.3 y 3.0, pero no para 2.1 ni 2.2.

Cómo se integra Mobile SDK en Digital Experience (DX)

El Mobile SDK es una forma de extender Digital Experience (DX) y proporcionar conversación digital en aplicaciones móviles. Digital Experience (DX) es la parte de NiCE CXone que admite digital channels. Ejemplos de digital channels son WhatsApp, publicaciones en Facebook o conversación digital. Para agregar NiCE CXone conversación digital a sus aplicaciones, debe configurar ciertas características en la sección Digital Experience (DX) de la interfaz NiCE CXone. Luego, con el SDK, accede y usa las funciones que configuró en NiCE CXone.

Por ejemplo, parte del proceso de introducción consiste en configurar un canal de chat digital en NiCE CXone. Luego, su aplicación debe crear una conexión WebSocket con el canal de conversación digital que creó. También puede configurar funciones avanzadas como mensajes de bienvenida o encuestas previas al chat. Estas ofrecen una variedad de opciones para optimizar la experiencia de los usuarios de la aplicación. Los usuarios pueden proporcionar información inicial sobre su incidencia o solicitud, ingresar datos personales básicos, entre otros. Estas funciones se configuran inicialmente en NiCE CXone, que luego puede utilizar con el SDK.

Diagrama de infraestructura de SDK para móviles

Chat UI

El Mobile SDK viene con un módulo de UI/UX predeterminado. Puede optar por implementarlo como parte del paquete de implementación estándar. Esto reduce considerablemente el tiempo de implementación.

Módulo UI predeterminado

El módulo predeterminado maneja automáticamente todas las funciones de chat, lo cual reduce la necesidad de cualquier desarrollo adicional de su parte, tal como:

La aplicación de ejemplo Mobile SDK muestra la IU/UX predeterminada. La documentación para el módulo de IU/UX se encuentra en el módulo mismo, para que sus desarrolladores la revisen.

Personalización de Color

Puede elegir los colores de 33 partes diferentes de la interfaz de usuario del chat, que van desde encabezados hasta botones. Esto incluye tanto el modo claro como el modo oscuro. Como parte del paquete de implementación estándar, usted define estos colores. Los colores predeterminados siguen la marca de NiCE, que puede cambiar.

Después de la implementación, sus desarrolladores pueden controlar los colores con un administrador de colores en la clase ChatStyle.

Desarrollar la propia interfaz de usuario

Usted también puede optar por usar o desarrollar su propia interfaz de usuario; no está obligado a usar la interfaz de usuario/experiencia de usuario predeterminada. Si usa su propia interfaz de usuario (o un paquete de interfaz de usuario de terceros), NiCE no brinda soporte para ella.

De manera similar, es posible que desee realizar ciertas personalizaciones de configuraciones a la IU predeterminada, como localización, notificaciones push y autenticación de OAuth. Si desea admitir cualquier idioma aparte de Inglés, debe proporcionar traducciones para las cadenas de texto. Si implementa un idioma que no sea Inglés, asegúrese de probar todas las áreas de la IU para garantizar que la visualización se maneje adecuadamente.

Si sus desarrolladores realizan personalizaciones adicionales sobre la interfaz de usuario/experiencia de usuario (UI/UX) estándar, NiCE no proporciona soporte para esos cambios.

AI Etiquetas de Assistant en Mobile SDK

Para cumplir con las regulaciones globales de transparencia de AI (como la Ley de IA de la UE), el CXone Mobile SDK ahora puede identificar automáticamente cuándo un contacto está interactuando con una ai en lugar de con un agente humano.

Cuando está habilitado, los mensajes enviados por robots o sistemas automatizados muestran una etiqueta "Asistente de AI" en la intefaz de chat.

Características clave

  • Identificación automática: el SDK detecta los mensajes generados por AI y aplica la etiqueta de divulgación automáticamente.

  • Diseño orientado al cumplimiento: Si el sistema no puede verificar que un mensaje fue enviado por un humano (como mensajes generados por el sistema o anonimizados), de forma predeterminada muestra la etiqueta AI para garantizar el cumplimiento normativo.

  • Texto personalizable: Si bien la etiqueta predeterminada es "AI Assistant", puede personalizar este texto para que coincida con la voz de su marca mediante la configuración de localización.

Prerrequisitos

  • Mobile SDK: Versión 26.3 o superior (iOS y Android).

  • Función de activación: Se debe habilitar featureAiGeneratedMessageFlag para su abonado. Comuníquese con su representante de cuenta de NiCE para habilitar esta función.

Personalizar la Etiqueta

Los desarrolladores pueden anular el texto predeterminado "AI Assistant" actualizando las cadenas de localización en el proyecto de la aplicación móvil. Esto le permite usar términos alternativos como "Bot," "Virtual Assistant," o "Chatbot."

Para los desarrolladores que crean interfaces personalizadas, la propiedad booleana isAiGenerated está disponible en el DTO (Data Transfer Object) del mensaje.

  • Propiedad: isAiGenerated

  • Tipo: Valor booleano

  • Comportamiento: Cuando es verdadero, la IU debe mostrar el indicador de autoría de AI. Si el conmutador de funciones está deshabilitado, esta propiedad se omite de la carga útil del mensaje para evitar afectar el código personalizado existente.

Mobile SDK

Datos clave

  • Para ayudarlo a comenzar a implementar el Mobile SDK, debe adquirir el paquete de implementación básico de NiCE. Un socio de NiCE lo guía durante la implementación.

  • Es posible que desee comprar horas de Servicios Profesionales de NiCE para preguntas sobre la configuración fuera de Mobile SDK.

  • El SDK no se puede utilizar sin una aplicación móvil existente. Usted debe tener su propia aplicación escrita de forma nativa en Kotlin o Swift.

  • Los frameworks no nativos o híbridos no son compatibles, como React Native.

  • Este SDK funciona con el chat Digital independiente, no con el chat a través de Guide.

  • El Mobile SDK almacena en caché la información del canal durante 5 minutos. Cuando el usuario minimiza la aplicación o pasa a otra pantalla y luego regresa, el SDK utiliza la información del canal almacenada en lugar de solicitarla de nuevo.

Antes de Comenzar a Desarrollar

Considere los siguientes elementos antes de crear usando el SDK móvil:

  • ¿Dispone de una cuenta de administrador y de agente en NiCE CXone? ¿Puede un administrador ayudarlo a configurar las funciones necesarias en la plataforma NiCE CXone?
  • ¿Su aplicación móvil está disponible para iOS (Apple), Android, o ambos? ¿Sus desarrolladores están familiarizados con los lenguajes Swift y Kotlin?
  • ¿Dispone de canales de mensajería de chat o quiere crear uno nuevo?
  • ¿Usará OAuth para autenticar a los usuarios de su aplicación? En caso afirmativo, ¿qué proveedor de OAuth usará?
  • ¿Desea ofrecer conversaciones de un solo hilo o multihilo?
  • ¿Utilizará acciones proactivas, como ventanas emergentes o mensajes de bienvenida?
  • ¿Desea usar notificaciones push? ¿Dispone de cuentas de Firebase o Apple Developer?
  • ¿Qué tipos de mensajes enriquecidos desea configurar? ¿En qué casos puede aprovechar estos mensajes interactivos?
  • ¿Quiere hacer un seguimiento de los datos de los usuarios? ¿Cómo puede utilizar los eventos de visitante para producir análisis?

Términos clave

Término Detalles
Hilo Una conversación dentro de la aplicación de chat. El primer mensaje enviado por el agente o el contactoClosed La persona que interactúa con un agente, IVR o bot en su centro de contacto. inicia un hilo. Cada mensaje consecutivo de la conversación se agrega al hilo. Los hilos son objetos que contienen cada mensaje. Los Mensajes se estructuran según el autor del Mensaje. Un threadId identifica una conversación completa, y todos los mensajes dentro de una conversación tienen un ID de mensaje. Un hilo termina cuando finaliza la conversación.
Un solo hilo Un diseño de aplicación en el que el contacto solo puede tener una conversación a la vez.
Canal de Messaging (multihilo) Un canal asíncrono en el que un cliente puede mantener varias conversaciones de larga duración al mismo tiempo. Aquí, el SDK expone getThreadList(), la asignación de nombres a los hilos y el archivado.
Canal En el contexto de Digital Experience (DX), el canal se refiere al tipo de mensajería o la plataforma utilizada para la comunicación. Por ejemplo, podría tener un canal de mensajería en tiempo real de WhatsApp. El Mobile SDK le permite agregar un canal de mensajería de chat a su aplicación móvil. Un canal se crea en la plataforma de NiCE CXone. Esto determina la configuración del canal junto con un ID de canal. Usted utiliza este ID para iniciar el canal de chat cuando un usuario de la aplicación abre el chat.
ChannelId El id del canal de conversación digital creado en la sección Digital de NiCE CXone. Puede encontrar esto en la configuración del canal de chat en NiCE CXone (ACD > Digital > Points of Contact Digital > Chat > Initialization & Test).
BrandId Esto es como un id de abonado para Digital Experience (DX). Se utiliza para inicializar el chat. Puede encontrar esto en la configuración del canal de chat en NiCE CXone (ACD > Digital > Points of Contact Digital > Chat > Inicialización y Prueba).
CustomerId The unique ID of the chat end user. The SDK creates this ID when the chat is initialized. If you have OAuth set up, this ID stays the same for each contact across all their devices. If you do not have OAuth set up, this ID is different for each device; the ID becomes like a guest login.
Región o Entorno La ubicación en el mundo donde está alojada su implementación de NiCE CXone. Puede ser: Australia (AU1), Canadá (CA1), Europa (EU1), Japón (JP1), Norteamérica (NA1) o Reino Unido (UK1). El desarrollador debe utilizar la misma región en la que su sistema NiCE CXone está alojado, de lo contrario se rechazará la conexión al chat.
Contacto, Cliente y Usuario Estos términos hacen referencia al usuario final de la aplicación móvil. La ayuda en línea suele utilizar el término contacto. En la documentación del SDK y en los comentarios de código, es probable que vea cliente y usuario.
NiCE CXone La plataforma principal donde usted administra y accede a todas las herramientas de experiencia del cliente que NiCE CXone ofrece. Dependiendo de las funciones de chat que desee ofrecer en su aplicación móvil, un administrador con los permisos de cuenta de usuario necesarios debe completar varias tareas de configuración en NiCE CXone.
Digital Experience (DX) La sección de NiCE CXone donde puede administrar todo lo relacionado con digital channels.
Marca Su empresa/cuenta en CXone, identificada por un brandId numérico. Toda la configuración de chat se encuentra bajo una marca.
Canal Livechat (sesión única) Una sesión síncrona, enrutada por agente. El chat debe iniciarse explícitamente (startChat()) y se puede finalizar (Chat finalizado()), y el cliente puede esperar en una cola. El SDK devuelve un LivechatThread para estos canales.
Hilo Una conversación dentro de un canal, identificada por un id de hilo. Contiene el historial de mensajes y es su control principal para enviar y recibir mensajes.
Contacto (también conocido como caso) Una interacción enrutada única creada a partir de un hilo, es decir, la unidad que el agente realmente recibe y procesa. Un hilo puede generar múltiples contactos a lo largo de su ciclo de vida (por ejemplo, un contacto nuevo cada vez que el cliente vuelve a interactuar después del cierre).
Mensaje Un elemento individual en una conversación —texto, un adjunto o contenido enriquecido— creado por el cliente o un agente.
Agente Un ser humano (o bot) del lado de CXone que atiende el contacto. La asignación y el tipo de Agente aparecen como eventos.
Visitante / visita Identificadores de analíticas ligeros para la persona que está navegando (visitorId) y su sesión de navegación actual (visitId). Se generan para usted si no los proporciona, y son relevantes principalmente para el chat proactivo y las analíticas.