SDK de Agent

Lenguaje del SDK: Typescript

Versión actual: 24.4

Fecha de lanzamiento de la versión actual: 15 de octubre de 2024

Disponibilidad: Todas las regiones y todos los segmentos de negocio

Compatibilidad con navegadores: Google Chrome, Microsoft Edge, Island Enterprise

Repositorio de SDK: GitHub

NPM: ACD , Agent , Auth , Digital , Voice

Referencia de API: CXone Mpower Portal para desarrolladores

Un kit de desarrollo de software (SDK) es como una caja de herramientas para desarrolladores. Proporciona un conjunto de herramientas y recursos que facilitan la creación de aplicacións de software. Se puede considerar como una colección de bloques prefabricados. Estos bloques tienen funcionalidades existentes. Sus desarrolladores pueden usar estos bloques existentes en lugar de crear la funcionalidad por su cuenta desde cero. A continuación se enumeran tres beneficios generales de utilizar un SDK:

  1. Eficacia: El SDK proporciona herramientas listas para usar y componentes prediseñados que ahorran tiempo a los desarrolladores. En lugar de reinventar la rueda, pueden centrarse en los aspectos exclusivos de su aplicación.

  2. Coherencia: El SDK garantiza la coherencia entre diferentes aplicacións. Al utilizar el mismo conjunto de herramientas y bibliotecas, los desarrolladores mantienen una experiencia uniforme para los usuarios.

  3. Control de calidad: Con el registro de eventos, los desarrolladores pueden verificar el código, detectar errores a tiempo y ofrecer un software más confiable.

En resumen, un SDK simplifica el desarrollo, garantiza la calidad y fomenta la colaboración, lo que lo convierte en una herramienta esencial para la creación eficiente de la aplicación.

El SDK CXone Mpower Agent le permite crear un La aplicación del agente. También permite integrar la funcionalidad de Agent en una aplicación aplicación existente. En lugar de utilizar directamente las API de CXone Mpower, los desarrolladores pueden utilizar la funcionalidad prediseñada a través del SDK. Esto acelera el tiempo de desarrollo y ahorra recursos. No es necesario que sus desarrolladores entiendan cómo funcionan todas las API de CXone Mpower. En cambio, el SDK permite utilizar grupos de API en contenedores de JavaScript fáciles de consumir.

El SDK de Agent es una compilación de SDK más pequeños. Cada SDK más pequeño se centra en un aspecto concreto de la funcionalidad, como la autenticación o los controles de llamada. Para satisfacer su caso de uso, puede elegir sólo los SDK que necesite. Por ejemplo, es posible que no necesite el SDK de voz, que proporciona la funcionalidad WebRTC para un Integrated Softphone. Esto también significa que los desarrolladores sólo tienen que instalar los SDK necesarios para su caso de uso.

Datos clave sobre el SDK de Agent:

  • El SDK funciona mediante suscripciones a eventos. Los datos de la CXone Mpower Plataforma se publican con un evento. Para utilizar los datos, su aplicación debe suscribirse a estos eventos.

  • Todas las funciones de Agent están disponibles a través de este SDK.

  • Debe registrar la aplicación con el que utilizará el SDK. Rellene el formulario de registro para recibir las credenciales para esta aplicación. La página Inicio rápido del portal para desarrolladores lo guiará a través del proceso de registro de la aplicación y configuración de la autenticación.

  • El SDK es compatible con Conexión OpenID con el flujo de autenticación PKCE.

Casos de uso del SDK de Agent

Los siguientes son tres casos de uso comunes del SDK de Agent SDK.

  • Cliente personalizado de Agent::
    En este caso, tiene una función o requisito único que Agent nativo no proporciona. Además, quizás no pueda simplemente insertar su funcionalidad requerida en Agent. Por ejemplo, puede que necesite limitar la visibilidad de los agentes a la información de contacto. Esto podría deberse a un requisito de seguridad concreto. Es posible que necesite enmascarar todos los datos de contacto de los agentes, lo que sólo un cliente personalizado puede facilitar.

  • Integrar un cliente de Agent con una aplicación de terceros:
    En este caso, no se puede insertar La aplicación agente en otra aplicación. Otras aplicacións suelen ser CRM, sitios de banca en línea, o sistemas de reserva de hoteles. Este casos de uso se da cuando quiere la funcionalidad de un cliente agente, pero no requiere necesariamente la interfaz de usuario del cliente. Utilizando el SDK, puede integrar una parte de la funcionalidad en otra aplicación. Utilizando el sistema del hotel como ejemplo, el personal podría llamar a una habitación específica a través del sistema de reservas.

  • Suscripción de eventos para aplicaciones integradas:
    Esto se utiliza comúnmente para cumplir con ciertas restricciones de seguridad del navegador. Por ejemplo, Google impide enviar datos a una ventana iframed desde otro sitio web. Esto complica la forma en que las ventanas pueden compartir mensajes o datos entre los dos marcos. Por ejemplo, tiene una aplicación de atención médica que inserta en un iframe en Agent. Cuando el agente acepta un contacto, quiere utilizar el número de teléfono del contacto para buscar su información en su aplicación de atención médica. Esto le permite mostrar automáticamente la información de contacto al agente. Si lo agentes usan Google Chrome, la aplicación de atención médica no puede obtener el número de teléfono del contacto de Agent. En cambio , necesita suscribirse al flujo de eventos VC, que es el mismo que utiliza Agent.

Desglose del SDK

El SDK de Agent se compone de los siguientes SDK más pequeños:

SDK Detalles
ACD

Este SDK ofrece funciones para manejar llamadas de voz, mensajes de voz y elementos de trabajoClosed Método personalizado de entregarle contactos a un agente a través de scripts de Studio.. Por ejemplo:

  • Para las llamadas de voz, puede iniciar, recibir, transferir y realizar conferencias telefónicas.

  • En el caso de los mensajes de voz, puede recibirlos, almacenarlos y gestionarlos.

  • Para los elementos de trabajo, puede automatizar la distribución de los elementos de trabajo a los agentes. Esto optimiza la carga de trabajo de los agentes utilizando reglas y criterios predefinidos.

A continuación se ofrecen detalles técnicos clave sobre el SDK de ACD:

  • Después de autenticarse correctamente, puede llamar a initAcdEngagement() para instanciar este módulo y crear funciones de ACD.

  • Puede establecer una sesión entre un agente y un contacto utilizando los métodos startSession y joinSession.

  • Una vez establecida la sesión, la aplicación puede llamar a otros métodos para funciones como marcación, transferencia, conferencia, etc.

  • Llamada correctamente a los métodos de este módulo produce eventos de ACD.
Agente

Este SDK sirve para manejar los eventos de sesión. Permite iniciar sesiones, unirse a una sesión en curso, etc. Sus principales enfoques son:

  • El bucle get-next-event

  • Cualquier cosa que las áreas de ACD y Digital Experience de la CXone Mpower Plataforma tienen en común, como WEM o notificaciones.
Auth

Este SDK facilita la autenticación y autorización seguras. Principalmente le permite configurar un flujo de inicio de sesión utilizando la autenticación global de CXone Mpower . El flujo de autenticación compatible es Conexión OpenID con PKCE. Los usuarios deben autenticarse con una cuenta de CXone Mpower. Esto le permite verificar las identidades de los usuarios y sus permisos en función de su rolClosed Diferente del sentimiento negativo. Las pistas de frustración muestran que un cliente está enfadado en lugar de limitarse a hablar de algo negativo. de CXone Mpower.

Las características clave incluyen:

  • Actualización automática de tokens de aut. Esto permite a los usuarios permanecer conectados hasta que cierren la aplicación o se desconecten.

  • Gestión y validación de tokens. Si un usuario ya ha iniciado sesión en CXone Mpower, puede pasar el token aut válido a su aplicación.

A continuación se ofrecen detalles técnicos clave sobre el SDK de Auth:

  • Llame a cxoneAuth.init() par pasar cxoneHostname, clientId, y redirectUri al SDK.

  • Invoca el método getAuthorizeUrl() para redirigir al usuario a la página de autenticación global CXone Mpower. Después de iniciar sesión, se redirigen de nuevo a su aplicación.

  • Cuando el usuario ingresa las credenciales e inicia la autenticación, se crea un objeto AuthSettings con su información de usuario. La instancia CXoneAuth se inicializa usando AuthSettings.

  • Use getAccessTokebByCode() para capturar el código devuelto y generar un token de autenticación. Esto también guarda la información del usuario.

  • Suscribirse a onAuthStatusChange, que produce eventos sobre autenticación como AUTHENTICATED o AUTHENTICATEDFAILED. En el caso de AUTHENTICATED, esto activa automáticamente el flujo de actualización, manteniendo al usuario conectado.
Digital

Este SDK le permite integrar canales de comunicación digital. Puede utilizar canales digitales estándar como correo electrónico, chat y SMS, además de plataformas de redes sociales como WhatsApp. Dependiendo del número de canales que haya configurado, puede crear una comunicación multicanal.

A continuación se ofrecen detalles técnicos clave sobre el SDK Digital:

  • Después de autenticarse correctamente, puede llamar a CXoneDigitalClient.instance.initDigitalEngagement(). Esto instancia los componentes necesarios para los mensajes digitales y establecerá una conexión WebSocket digital.

  • Utilice eventos digitales para recibir casos ya asignados y sus hilos de mensajes existentes.

  • Su aplicación puede responder a los mensajes digitales con el método reply().

  • También puede iniciar una nueva interacción saliente con el método reply().

  • Para utilizar este SDK, el origen de su aplicación debe estar permitido por Digital Experience Plataforma. Debes proporcionar cualquier origen a tu Representante de cuenta. Los orígenes deben ser permitidos por el Digital Plataforma.
Voz Este SDK proporciona funcionalidad de Integrated Softphone. Es un contenedor para WebRTC.

Recursos

Un SDK permite crear su propia funcionalidad personalizada, por lo tanto sus recursos de soporte son principalmente contenido de autoservicio. Sus opciones de soporte técnico se basan en el acuerdo de soporte de su organización con NICE. Póngase en contacto con su Representante de cuenta para obtener más información sobre sus opciones de soporte.

Además de esta página, su contenido de autoservicio se centra en los recursos para desarrolladores. El paquete SDK incluye lo siguiente:

  • LÉAME para cada SDK individual que proporciona información de inicio.

  • Una aplicación de ejemplo para mostrar la funcionalidad básica.

  • Ejemplos de uso con extractos de código de la aplicación de ejemplo.

  • Comentarios de código.

Soporte para múltiples conectores

Lo siguiente se aplica a usted si su inquilinoClosed Agrupación organizativa de alto nivel utilizado para administrar el soporte técnico, facturación y configuración global para su CXone Mpower entorno tiene habilitada la Cola de UI.

La cola de interfaz de usuario CXone Mpower es un enfoque basado en WebSocket para emitir eventos ACD. Esta es una alternativa al sondeo largo para obtener el siguiente evento. La cola de UI no admite conexiones de múltiples sockets: no se pueden emitir los mismos eventos tanto al cliente Agent como al SDK .Agent Por lo tanto, si desea probar o verificar cierta funcionalidad del SDK usando Agent, asegúrese de cerrar aplicación que está consumiendo el SDK.

Eventos

A continuación se enumeran los eventos que la aplicación puede escuchar. Los eventos están clasificados por el módulo en el que están disponibles.

SDK de ACD

Instancia Evento Descripción

CXoneAcdClient.instance.contactManager

conferenceCallEvent

Escucha eventos relacionados con llamadas de conferencia.

 

onDispositionEvent

Maneja eventos relacionados con las disposicionesClosed Resultado asignado por el agente o el sistema al final de una interacción de voz (disposición) o digital (estado). de interacciones.

 

onTagsEvent

Gestiona eventos relacionados con etiquetas asociadas a interacciones.

 

voiceContactUpdateEvent

Escucha las actualizaciones de los contactos de voz.

 

voiceMailContactUpdateEvent

Escucha las actualizaciones de los contactos de mensaje de voz.

 

workItemContactUpdateEvent

Escucha las actualizaciones de los contactos de elementos de trabajo.

CXoneAcdClient.instance.notification

onUpdateMessageEvent

Escucha nuevos mensajes o notificaciones para el agente.

CXoneAcdClient.instance.screenPop

agentAssistSubject

Maneja eventos relacionados con la asistencia al agente o aplicaciones de copilot.

 

contactScreenPopSubject

Maneja eventos relacionados con la apertura de pantalla para contactos entrantes.

 

pageOpenSubject

Maneja eventos relacionados con la apertura de páginas web.

 

popUrlSubject

Maneja eventos relacionados con la apertura de URL en una nueva ventana o pestaña.

 

runAppSubject

Maneja eventos relacionados con la ejecución de aplicaciones o la apertura de formularios personalizados.

CXoneAcdClient.instance.session

agentLegEvent

Escucha eventos relacionados con el tramoClosed La parte de una interacción que tiene lugar entre CXone Mpower y el agente. del agente en la sesión.

 

agentStateSubject

Observable que emite eventos relacionados con cambios en el estado del agente, como Disponible a No disponible.

 

naturalCallingSkillListSubject

Escucha las actualizaciones de la lista de habilidades activadas para la llamada natural.

Los tipos de evento incluyen: SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS y JOIN_SESSION_FAILURE.

 

networkOfflineSubject

Escucha eventos relacionados con problemas de conectividad de red.

 

onAgentSessionChange

Escucha cambios en el estado de la sesión del agente, como inicio o fin.

Los tipos de evento incluyen: SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS y JOIN_SESSION_FAILURE.

CXoneAcdClient.instance.session.agentStateService

agentStateSubject

Observable que emite actualizaciones sobre los cambios de estado del agente.

SDK de Agent

Instancia Evento Descripción

CXoneClient.instance

autoSummaryService

Servicio de gestión de resúmenes automáticos.

 

copilotNotificationClient

Facilita la recepción de notificaciones en tiempo real para el Agent Copilot.

 

cxoneApiPerformanceMetrics

Escucha las métricas de rendimiento de la API de CXone Mpower.

CXoneClient.instance.agentSession

agentSessionEndSubject

Emite un evento cuando finaliza la sesión del agente actual.

CXoneClient.instance.agentSetting

mchAgentSettingsChangeEvent

Escucha los cambios en la configuración de Make Call Heard, Escuchar llamadas realizadas, (MCH) del agente.

CXoneClient.instance.autoSummaryService

onAutoSummaryReceived

Evento observable que se activa cuando se recibe un resumen generado automáticamente para un contacto.

CXoneClient.instance.commitment

onCommitmentEvent

Escucha eventos relacionados con los compromisos del agente.

 

onCommitmentStatusEvent

Escucha cambios en el estado de los compromisos del agente.

 

onUpdateCommitments

Escucha las actualizaciones de los compromisos del agente.

CXoneClient.instance.contactManager

onDigitalContactEvent

Proporciona actualizaciones sobre interacciones de contactos digitales como sesiones de chat y mensajes salientes en CXone Mpower.

 

onDispositionEvent

Proporciona actualizaciones sobre el estado de disposición de la llamada una vez finalizada.

 

voiceContactUpdateEvent

Proporciona actualizaciones en tiempo real de los detalles de las llamadas de voz en curso, como el nombre y el número de teléfono de la persona que llama.

CXoneClient.instance.copilotNotificationClient

onMessageNotification

Observable/emisor de eventos utilizado para suscribirse a mensajes o notificaciones entrantes del copilot.

Los tipos de evento incluyen: ADAPTIVE_CARD, RT_SUMMARY, NEXT_BEST_RESPONSE, NEXT_BEST_RESPONSE_LLM, NEXT_BEST_RESPONSE_EXPERT, KB_ANSWERS, SENTIMENT, KB_LINKS, KB_IMAGES, TEXT, FINAL_SUMMARY, FINAL_SUMMARY_NOTES, KB_ANSWERS_VOICE, KB_IMAGES_VOICE, ENLIGHTEN_AGENT_COPILOT y AGENT_COPILOT.

CXoneClient.instance.directory

directoryEvent

Escucha eventos relacionados con el directorio, como agentes, equipos o habilidades.

Proporciona actualizaciones sobre cambios en los datos del directorio, como nuevos contactos, actualizaciones y modificaciones de permisos en CXone Mpower.

 

onUpdateSkillsEvent

Escucha las actualizaciones de las habilidades asignadas al agente.

CXoneClient.instance.directory.dynamicDirectory

searchDirectoryResult

Espera a que vuelvan los resultados después de haber buscado algo como una persona o un departamento en un directorio dentro del sistema.

CXoneClient.instance.indicator

agentIndicatorsEvent

Evento que proporciona actualizaciones sobre indicadores de agente como disponibilidad, actividad actual e indicadores de estado de agente personalizados.

 

contactIndicatorsEvent

Evento que proporciona actualizaciones sobre indicadores de contacto que pueden desencadenar acciones como mostrar formularios personalizados para recopilar información adicional.

CXoneClient.instance.notification

onCXoneNotificationEvent

Escucha las notificaciones de la CXone Mpower Plataforma.

CXoneClient.instance.screenPop

contactScreenPopSubject

Evento que desencadena la apertura de una página web con información de la persona que llama para una llamada existente.

 

pageOpenSubject

Evento que desencadena la apertura de una página web que no está necesariamente relacionada con la llamada actual.

 

popUrlSubject

Evento que desencadena la apertura de una página web relevante para una llamada existente.

 

runAppSubject

Evento que desencadena el lanzamiento de una aplicación o la visualización de un formulario personalizado para una llamada.

CXoneClient.instance.session

agentLegEvent

Escucha las actualizaciones de un tramo de llamada específico del agente, como una llamada entrante o saliente.

CXoneClient.instance.session.agentStateService

agentStateSubject

Evento que proporciona actualizaciones en directo sobre el estado de disponibilidad del agente y los cambios de estado en CXone Mpower.

CXoneClient.instance.skillActivityQueue

agentQueueSubject

Evento que proporciona actualizaciones sobre la información de la cola asignada al agente, como el nombre de la cola, el recuento de llamadas y la disponibilidad del agente.

 

agentQueuesDetailSubject

Evento que proporciona actualizaciones detalladas sobre las colas asignadas al agente, incluyendo métricas como el tiempo promedio de espera, los Acuerdos de nivel de servicio (SLA) y el rendimiento del agente.

 

skillActivityEvent

Evento que proporciona actualizaciones sobre métricas de actividad de habilidades, como la longitud de la cola de llamadas, el tiempo promedio de espera y los agentes disponibles.

Auth SDK

Instancia Evento Descripción

CXoneAuth.instance

onAuthStatusChange

Observable que escucha los cambios de estado de autenticación del usuario.

Los tipos de evento incluyen: AUTHENTICATED,AUTHENTICATING, NOT_AUTHENTICATED, AUTHENTICATION_FAILED y REFRESH_TOKEN_SUCCESS

SDK Digital

Instancia Evento Descripción

CXoneDigitalClient.instance.digitalContactManager

onDigitalContactEvent

Escucha eventos relacionados con contactos digitales.

Los tipos de evento incluyen: CASE_INBOX_ASSIGNEE_CHANGED, CASE_STATUS_CHANGED, MESSAGE_ADDED_INTO_CASE, CASE_INBOX_ASSIGNED, CASE_INBOX_UNASSIGNED, MESSAGE_CREATED, MESSAGE_NOTE_CREATED, MESSAGE_NOTE_DELETED, MESSAGE_NOTE_UPDATED, MESSAGE_UPDATED, SENDER_TYPING_START, SENDER_TYPING_END y MESSAGE_PREVIEW.

 

onDigitalContactNewMessageEvent

Escucha nuevos mensajes de contactos digitales.

 

onDigitalContactUserTypingPreviewEvent

Escucha los eventos de previsualización de escritura de los contactos digitales.

Los tipos de evento incluyen: CASE_INBOX_ASSIGNEE_CHANGED, CASE_STATUS_CHANGED, MESSAGE_ADDED_INTO_CASE, CASE_INBOX_ASSIGNED, CASE_INBOX_UNASSIGNED, MESSAGE_CREATED, MESSAGE_NOTE_CREATED, MESSAGE_NOTE_DELETED, MESSAGE_NOTE_UPDATED, MESSAGE_UPDATED, SENDER_TYPING_START, SENDER_TYPING_END y MESSAGE_PREVIEW.

SDK de Voice

Instancia Evento Descripción

CXoneVoiceClientWrapper.instance

onCallStatusChanged

Maneja eventos relacionados con cambios en el estado de la llamada.

 

onConnectionStatusChanged

Maneja eventos relacionados con cambios en el estado de la conexión de voz.