API de Grabación a pedido

Esta API está disponible para usuarios de Engagement Hub con funcionalidad de grabación de voz o 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 de las API de Record on Demand está disponible en el portal de la comunidad de desarrolladores .

Antes de que empiece

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

Para empezar a usar las API, debe registrarse con NiCE para recibir credenciales válidas que se utilizan para la autenticación. Revise la página comenzar en el portal para desarrolladores para obtener instrucciones.

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

Iniciar grabación a pedido

La API permite que un agente o aplicación comience a grabar una llamada en curso de un usuario específico. Puede usarse para captar interacciones o conversaciones específicas que sean relevantes para fines de conformidad, garantía de calidad o capacitación.

Puede especificar que comience una grabación de voz solamente, o de voz y pantalla. Este método con API tiene prioridad sobre las políticas de grabación.

El indicador mediaType es opcional y permite controlar los tipos de medios que se graban. Los valores admitidos son voz y voiceAndScreen, que activan el inicio de la grabación de voz solamente o de voz y pantalla.. Si el indicador no se supera, el valor predeterminado será voz.

Método: POST

Punto final: /servicio-de-gestión-de-grabación-de-interacciones/interacciones/inicio-de-grabación-a-demanda

Parámetro:

userId*:

cadena

El tipo de medio que se grabará.

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

Respuesta

  • Estado 200-Operación realizada con éxito. 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 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 409: La solicitud no se puede ejecutar debido al estado del servicio.

  • Estado 425: La interacción está bloqueada mientras se procesa una solicitud anterior de Registro a pedido/Detener a pedido

  • Estado 500-Error interno del servidor.

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

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. Se puede usar para proteger la privacidad de los clientes o para cumplir la normativa que limita la grabación de ciertos tipos de conversaciones.

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

Método: POST

Punto final: /servicio-de-gestión-de-grabación-de-interacciones/interacciones/detener-la-grabación-a-demanda

Parámetro:

userId*:

cadena

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 realizada 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 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 409: La solicitud no se puede ejecutar debido al estado del servicio.

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

  • Estado 500-Error interno del servidor.

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

Desactivar la Opción para 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 relevante para el Reglamento General de Protección de Datos (RGPD) de la UE. Si un cliente rechaza el consentimiento, entonces NiCE CXone Recording Management (CXone) no grabará la llamada, incluso si hay una política de grabación configurada para grabar la llamada, o si el agente graba la llamada a pedido o usando API.

POST. No es posible iniciar la grabación de llamadas con API para todo el contacto con el cliente, como transferencias, consultas y conferencias. Si se llamó a la API 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 búsqueda y reproducción.

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

Método: POST

Punto final: /servicio-de-gestión-de-grabación-de-interacciones/interacciones/no-grabar

Parámetro:

userId*:

cadena

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 realizada 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 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 409: La solicitud no se puede ejecutar debido al estado del servicio.

  • 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.