API de grabación de interacción de pantalla

Se puede utilizar una API para iniciar la grabación de pantalla de la actividad del escritorio. Esto permite grabar las pantallas de los agentes cuando no hay ningún contacto en curso y la grabación de las pantallas del back-office.

Esta API está disponible para usuarios de Engagement Hub con funcionalidad de grabación de voz o pantalla y CXone MpowerACD usuarios.

Antes de que empiece

Puede probar CXone Mpower API en el portal para desarrolladores . Inicie sesión con una cuenta CXone Mpower y luego podrá realizar solicitudes con el inquilinoCerrado Agrupación organizativa de alto nivel utilizado para administrar el soporte técnico, facturación y configuración global para su sistema CXone Mpower. de su cuenta.

Para comenzar a utilizar las API, debe registrarse en NiCE para recibir credenciales válidas utilizadas para la autenticación. Revise la página Primeros pasos en el portal para desarrolladores para obtener instrucciones.

Además, el uso de estas API requiere el permiso Interactions Hub Grabar interacción de pantalla.

Grabación de interacción en la pantalla de inicio

La API permite iniciar la grabación de pantalla para un usuario específico que no está en una llamada activa. Debe especificar la duración de la grabación proporcionándola como parámetro en el comando de inicio. La duración debe estar entre 5 segundos y 3:30 horas, el tiempo máximo permitido. La grabación se detendrá automáticamente cuando se alcance la duración. Además, puedes detener la grabación de pantalla invocando el comando stop-screen-interaction-recording.

  • Cuando se inicia la grabación (indicado por un código de respuesta de 202) o es exitosa (indicado por un código de respuesta de 200), se proporcionará el ID de contacto asociado con la pantalla grabada. Este ID de contacto se debe utilizar al emitir el comando Detener.

  • La API se puede utilizar durante una llamada en vivo entre un agente y un cliente, la cual puede ser grabada. En tales casos, habrá dos grabaciones distintas: una que captura la conversación de voz y la otra basada en interacciones de API, cada una asociada con diferentes identificaciones de contacto.

  • Si se aplica el enmascaramiento a una llamada en vivo, también afectará una interacción de grabación de pantalla de API que pueda grabarse en paralelo.

  • Al utilizar la API, puede haber una única instancia de grabación de pantalla. Si la pantalla de un agente ya se está grabando a través de la API, cualquier llamada de API posterior para ese mismo agente no generará una nueva grabación de pantalla ni actualizará la duración de la grabación.

Método: POST

Punto final: /servicio-de-administración-de-grabación-de-interacciones/v1/interacciones/inicio-de-grabación-de-interacciones-en-pantalla

Parámetros:

userId*:

(consulta)

cadena

ID del usuario a registrar.

duracióndegrabación*:

(consulta)

number

Especifica la duración de grabación requerida dentro del rango de 5 a 13200 segundos

POST /servicio-de-gestión-de-grabación-de-interacciones/interacciones/grabación-de-interacciones-en-la-pantalla-de-inicio?id-usuario=1234567&duración-de-grabación=3000

Respuestas

  • Estado 200-Operación realizada con éxito.

    descripción (cadena): La descripción de la respuesta.

    contactId (número): El ID de contacto de ACD.

    interactionId (cadena): el ID de interacción global.

    httpStatus (cadena): La descripción del estado HTTP.

  • Estado 202-Operación en proceso.

    contactId (número): El ID de contacto de ACD.

    interactionId (cadena): el ID de interacción global.

    httpStatus (cadena): La descripción del estado HTTP.

  • Estado 400-Solicitud incorrecta.

  • Estado 401: El usuario solicitante no pudo autenticarse.

  • Estado 403: El usuario solicitante no está autorizado para realizar la operación.

  • Estado 404-No encontrado. No se encontraron interacciones activas.

  • Estado 425: La interacción está bloqueada mientras se procesa una solicitud anterior.

  • Estado 500-Error interno del servidor.

  • Estado 504: Se agotó el tiempo de solicitud.

Detener la grabación de interacción de pantalla

La API permite detener la grabación de pantalla para el ID de contacto de un usuario específico que se inició usando el comando start-screen-interaction-recording. Debe utilizar el ID de contacto proporcionado en la respuesta del comando start-screen-interaction-recording. Si no se llama a este método, la grabación de pantalla se detiene automáticamente después de la duración proporcionada en el comando start-screen-interaction-recording.

Método: POST

Punto final: /servicio-de-administración-de-grabación-de-interacciones/v1/interacciones/detener-la-grabación-de-interacciones-de-pantalla

Parámetros:

userId*:

cadena

El ID del usuario registrado que se va a detener.
ID de contacto*:

number

El ID de contacto devuelto en el comando de grabación de la pantalla de inicio.

POST /servicio-de-gestión-de-grabación-de-interacciones/interacciones/detener-la-grabación-de-interacciones-en-pantalla?user-id=1234567&contactId=1122334455

Respuestas

  • Estado 200-Operación realizada con éxito.

  • Estado 202-Operación en proceso.

  • Estado 400-Solicitud incorrecta.

  • Estado 401: El usuario solicitante no pudo autenticarse.

  • Estado 403: El usuario solicitante no está autorizado para realizar la operación.

  • Estado 404-No encontrado. No se encontraron interacciones activas.

  • Estado 425: La interacción está bloqueada mientras se procesa una solicitud anterior.

  • Estado 500-Error interno del servidor.

  • Estado 504: Se agotó el tiempo de solicitud.