SDK web de chat Digital
SDK: GitHub
Referencia API: Páginas de GitHub
Aplicación de ejemplo: GitHub
Paquete NPM: npmjs.com
El SDK web de chat le permite crear su propio chat Digital aplicación, o agregar chat Digital a una web aplicación existente. Permite usar la infraestructura digital de CXone en una interfaz de usuario de su elección. Se trata de un SDK basado en JavaScript que admite tanto LiveChat y Mensajería de chat—tanto mensajería síncrona como asíncrona. También puede configurar la mensajería de uno En una aplicación de un solo hilo, cada contacto puede tener solo un hilo de chat. Cualquier interacción que tengan con su organización tiene lugar en ese único hilo de chat. o varios hilos
En una aplicación de subprocesos múltiples, los contactos pueden crear tantos subprocesos como deseen para discutir nuevos temas. Estos hilos pueden estar activos al mismo tiempo.. Este SDK le da más control sobre CXone en su sitio web. Ayuda a evitar ciertas limitaciones técnicas que tienen algunos sitios web. Por ejemplo, es posible que su sitio no permita código externo, lo que podría impedir la ejecución del chat CXone Digital nativo.
El SDK es compatible con las siguientes funciones:
- Mensajes de chat digital
- OAuth2.0 para autorización
- Identificación de contactos y campos personalizados
- Lista de hilos y recuperación de hilos
- Archivos adjuntos
- Mensajes enriquecidos
- Indicadores de escritura, mensaje visto y mensaje entregado
- Mensajes del sistema, como eventos de estado de casos o eventos de asignación
- Eventos de posición en cola
Este SDK está escrito en TypeScript 4.9+. También debe usar una aplicación
Recursos del SDK
La parte superior de esta página o el menú desplegable que aparece a continuación proporcionan enlaces a los distintos recursos del SDK.
Sus desarrolladores pueden obtener el SDK en GitHub. El repositorio tiene un LÉAME que ayuda al desarrollador a empezar. También contiene documentación sobre eventos y la referencia API. La referencia de la API más fácil de usar se aloja por separado en github.io.
También puede ver aplicación de ejemplo. Esto permite probar el chat y ver el código fuente correspondiente.
Los desarrolladores importan el SDK como un paquete NPM. La entrada del paquete en npmjs.com contiene todo el mismo contenido e instrucciones para configurar y construir con el SDK.
Términos clave
-
Hilo: Una conversación dentro de una aplicación de chat. El primer mensaje enviado por el agente o el contacto
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 donde el contacto sólo puede tener una conversación a la vez.
-
Múltiples hilos: Un diseño de aplicación donde el contacto puede tener múltiples conversaciones a la vez.
-
Canal: En el contexto de Digital Experience, canal se refiere al tipo de mensajería o la Plataforma utilizada para la comunicación. Por ejemplo, puede tener un canal de mensajería de WhatsApp en tiempo real. El SDK para móviles permite agregar un canal de mensajería de chat a su aplicación móvil. Se crea un canal en CXonePlataforma. Esto determina la configuración del canal junto con un ID de canal. Este ID se utiliza para iniciar el canal de chat cuando un usuario de la aplicación abre el chat.
-
ChannelId: El ID del canal de chat digital creado en la sección Digital de CXone. Puede encontrarlo en la configuración del canal de chat en CXone (ACD > Digital > Puntos de contacto digital > Chat > Inicialización y prueba).
-
BrandId: Es como un ID de abonado
Agrupación organizativa de alto nivel utilizado para administrar el soporte técnico, facturación y configuración global para su CXone entorno para Digital Experience. Se utiliza para inicializar el chat. Puede encontrarlo en la configuración del canal de chat en CXone (ACD > Digital > Puntos de contacto digital > Chat > Inicialización y prueba).
-
CustomerId: El ID único del usuario final del chat. El SDK crea este ID cuando se inicializa el chat. Si tiene OAuth configurado, este ID permanece igual para cada contacto en todos sus dispositivos. Si no lo ha configurado OAuth, este ID es diferente para cada dispositivo; el ID se convierte en un inicio de sesión de invitado.
-
Región o Entorno: La ubicación en el mundo donde se aloja su implementación de 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 CXone está alojado, de lo contrario se rechazará la conexión al chat.
-
Contacto, cliente y usuario: Todos estos términos se refieren 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.
-
CXone:La Plataforma principal donde se gestionan y se accede a todas las herramientas de experiencia de 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 CXone.
-
Digital Experience: La sección de CXone donde se puede gestionar todo lo relacionado con los canales digitales.
Antes de empezar a desarrollar
Considere los siguientes elementos antes de crear usando el SDK móvil:
- ¿Dispone de una cuenta de administrador y de agente en CXone? ¿Puede un administrador ayudarlo a configurar las funciones necesarias en la CXonePlataforma?
- ¿Dispone de canales de chat o quiere crear uno nuevo?
- ¿Desea ofrecer conversaciones de un solo hilo o multihilo?
- ¿Qué tipos de mensajes enriquecidos quiere configurar? ¿En qué casos puede aprovechar estos mensajes interactivos?
- ¿Utilizará acciones proactivas como ventanas emergentes o mensajes de bienvenida?