API de Grabación a pedido

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

Estas API permiten iniciar, detener y desactivar la grabación de llamadas a pedido, lo que activa el control de grabación mediante API.

La documentación para las API de Grabación a pedido está disponible en el portal de Developer Community Icon of dark gray square with an arrow pointing out of its upper right corner.

Antes de Comenzar

Puede probar las API de NiCE CXone en el portal para desarrolladores Icon of dark gray square with an arrow pointing out of its upper right corner. Inicie sesión con una cuenta de NiCE CXone y, luego, podrá realizar solicitudes con el abonadoClosed High-level organizational grouping used to manage technical support, billing, and global settings for your NiCE CXone system. de su cuenta.

Para comenzar a usar las API, debe registrarse con NiCE para recibir credenciales válidas que se utilizan para la autenticación. Revise la página de comenzar Icon of dark gray square with an arrow pointing out of its upper right corner en el portal para desarrolladores para obtener instrucciones.

Además, el uso de esta API requiere el permiso Interactions Hub >API > Multi-ACD Record on Demand API.

Iniciar grabación a pedido

La API permite que un agente o una aplicación inicie la captura de una llamada en curso para un usuario específico. Puede utilizarse para capturar conversaciones o interacciones específicas que sean importantes para fines de cumplimiento, control de calidad o capacitación.

Puede especificar iniciar la grabación de solo voz, o tanto voz como pantalla. Este método con API tiene prioridad sobre las políticas de grabación.

El indicador mediaType es opcional y permite controlar qué tipos DE medio se grabarán. Los valores admitidos SOn voice y voiceAndScreen, lo que permite iniciar la grabación de solo voz o de voz y pantalla. Si no se pasa el indicador, el valor predeterminado sería voice.

Método: POST

Terminal: /interaction-recording-management-service/interactions/start-recording-on-demand

El parámetro:

userId*:

Cadena de caracteres

El tipo de medio que se grabará.

POST /interaction-recording-management-service/interactions/start-recording-on-demand?user-id=1234567

Respuesta

  • Estado 200: Con éxito la operación. Comenzó la solicitud de Iniciar grabaciones a pedido.

  • Estado 202: Operación en proceso. Se aceptó la solicitud de Iniciar grabaciones a pedido y se está procesando.

  • Estado 400: Solicitud incorrecta

  • Estado 401—El usuario solicitante no ha podido autenticarse.

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

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

  • Estado 409: no es posible ejecutar la solicitud debido al estado del servicio.

  • Estado 425: la interacción está bloqueada mientras se procesa una solicitud anterior de Grabación a pedido/detener grabación a pedido.

  • Estado 500: error en el servidor Interna.

  • Estado 504: la solicitud ha caducado.

Detener grabación a pedido

La API permite detener la grabación de voz y pantalla de la llamada en curso de un usuario específico. Puede utilizarse para proteger la privacidad del cliente o para cumplir con regulaciones que restringen la grabación de ciertos tipos de conversaciones.

Este método de API tiene prioridad sobre las políticas de Recording Management (CXone). POST. Detener grabaciones a pedido. La grabación solo se puede reanudar llamando a Iniciar grabaciones a pedido.

Método: POST

Terminal: /interaction-recording-management-service/interactions/stop-recording-on-demand

El parámetro:

userId*:

Cadena de caracteres

Id DE usuario del agente que se va a grabar.

POST /interaction-recording-management-service/interactions/stop-recording-on-demand?user-id=1234567

Respuesta

  • Estado 200: operación Con éxito. Comenzó la solicitud de detener grabaciones a pedido.

  • Estado 202: Operación en proceso. Se aceptó la solicitud de detener grabaciones a pedido y se está procesando.

  • Estado 400: Solicitud incorrecta.

  • Estado 401: el usuario solicitante no ha podido autenticarse.

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

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

  • Estado 409: no es posible ejecutar la solicitud debido al estado del servicio.

  • Estado 425: la interacción está bloqueada mientras se procesa una solicitud anterior de Grabación a pedido/Detener grabaciones a pedido.

  • Estado 500: error en el servidor Interna.

  • Estado 504: la solicitud ha caducado.

Desactivar la Opción de grabar la Llamada

La API permite desactivar la opción de grabar voz y pantalla en caso de que el cliente rechace el consentimiento y no acepte ser grabado. Esto es especialmente importante para el Reglamento general de Protección de Datos (RGPD) de la UE. Si el cliente no otorga su consentimiento, entonces NiCE CXone Recording Management (CXone) no grabará la llamada, incluso si hay una política de grabación establecida para grabar la llamada, o si el agente grabó la llamada a petición, o mediante API.

Después de la Llamada a la API, no se puede iniciar la grabación para todo el contacto del cliente, incluidas las transferencias, las consultas y las conferencias. Si la API se llamó mientras la grabación de la llamada estaba en curso, Recording Management (CXone) detendrá la grabación, y la parte grabada de la llamada estará disponible para la búsqueda y la reproducción.

El consentimiento de grabación solo se aplica a la llamada actual. No se guarda para las futuras interacciones con el cliente.

Método: POST

Punto de conexión: /interaction-recording-management-service/interactions/DO-not-record

El parámetro:

userId*:

Cadena de caracteres

Id DE usuario del agente que se va a grabar.

POST /interaction-recording-management-service/interactions/do-not-record?user-id=1234567

Respuesta

  • Estado 200: operación Con éxito. Se inició la solicitud de No grabar.

  • Estado 202: Operación en proceso. La solicitud de No grabar se aceptó y se está procesando.

  • Estado 400: Solicitud incorrecta.

  • Estado 401—El usuario solicitante no ha podido autenticarse.

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

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

  • Estado 409: no es posible ejecutar la solicitud debido al estado del servicio.

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

  • Estado 500—error en el servidor Interna.

  • Estado 504: la solicitud agotó el tiempo DE espera.