API de Extracción de datos

Las API de Extracción de Datos le permiten extraer datos de NiCE CXone para fines de reportes externos. Por ejemplo, puede extraer QM datos de flujo de trabajo, QM datos de preguntas y respuestas, Recording Management (CXone) metadatos de interacción, o WFM Datos de Nómina. Los datos solo se pueden filtrar según el rango de fechas especificado. Los datos de Gestión de calidad se envían a la API de Extracción cada 15 minutos.

Puede probar las API de Extracción de Datos y revisar su documentación en el portal para desarrolladores.

Al llamar a POST /jobs, se devuelve un jobId mientras se prepara la información. Puede verificar si los datos están listos sondeando el servicio desde el terminal /jobs/{jobId}, que devuelve el estado del trabajo. Si el estado es éxito, entonces también se devuelve una URL adicional. Se podrá acceder a la URL durante 30 segundos (sin incluir el tiempo que lleva descargar el archivo).

Puede escribir scripts para llamar a la API periódicamente en lugar de recuperar los datos manualmente cada vez. En un momento dado, solo un usuario por inquilino puede llamar a una API. solo puede llamar a la API una vez en un período de 30 segundos.

Antes de Comenzar

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.

El uso de estas API requiere los siguientes permisos:

  • Entidad:

    • Si está extrayendo metadatos de interacción, entonces necesita el permiso Search & Reproducción > APIs > Extract Interaction Metadata.

    • Si está extrayendo QM datos de flujo de trabajo, entonces necesita el QM Herramientas > API de Extracción de Datos > QM Workflow API permiso.

    • Si usted está extrayendo QM datos de preguntas y respuestas, entonces necesita el permiso QM Herramientas > API de Extracción de Datos > QM Workflow API.

    • Si está extrayendo WFM datos de Nómina, entonces necesita el permiso WFM > API de Extracción de Datos > WFM API de Nómina.

    • Si está extrayendo QM notas del evaluador, entonces necesita el permiso QM Tools > Data Extraction APIs > QM Evaluator Notes API.

Obtener Trabajos

Ver una lista de todos los estados de trabajo por tenant. Los posibles estados son Corriendo, Triunfó, Ha fallado , cancelado y Caducado.

Método: GET

Terminal: /data-extraction/v1/jobs

Parámetros: none

Preparar Trabajos

Después de realizar una solicitud para extraer datos, los datos se recopilan y se preparan para la extracción. Los datos están disponibles en S3 como un Archivo csv durante 24 horas. Cuando termina, se devuelve un id de trabajo.

Método: POST

Terminal: /data-extraction/v1/jobs

Parámetros: none

Obtener trabajos por Id de trabajo

Vea el estado de un trabajo específico según su id de trabajo. Si un trabajo tuvo éxito, se devuelve una URL para acceder a los datos extraídos y se puede acceder durante 30 segundos (sin incluir el tiempo que lleva descargar el archivo). Si el trabajo falló, se devuelve un mensaje de error. El enlace se puede usar para acceder a los datos extraídos. Los posibles estados de trabajo son Corriendo, Triunfó, Ha fallado , cancelado y Caducado.

Método: GET

Terminal: /data-extraction/v1/jobs

Parámetros:

jobId*:

Cadena de caracteres

Identificador único de la solicitud que se realizó para extraer datos del cliente.

QM Entidad de Workflow y CSV Archivo

La API de Flujo de trabajo QM permite extraer los datos de flujo de trabajo de QM incluyendo las evaluaciones, autoevaluaciones, y calibraciones.

Para el trabajo POST:

  • Nombre de la entidad es: flujos de trabajo qm

  • Versiónes: 4

Los datos se filtran según el Día de entrega (en UTC).

QM Entidad de preguntas y respuestas (Q&A) y Archivo csv

La API de preguntas y respuestas de QM permite extraer las preguntas y respuestas de las evaluaciones, autoevaluaciones y calibraciones de QM.

Para el trabajo POST:

  • Nombre de la entidad es:qm-preguntas

  • Versiónes: 2

Los datos se filtran según el Día de entrega (en UTC).

QM Notas del evaluador y Archivo csv

La API de notas de Evaluador QM permite extraer notas de evaluador de QM.

Para el trabajo POST:

  • entityName es: qm-evaluation-comment-entity

  • Versiónes: 1

Los datos se filtran de acuerdo con el Día de entrega (en UTC).

Entidad de Metadatos de Interacción y Archivo csv

La API de Metadatos de interacción le permite extraer los Recording Management (CXone) metadatos de interacción.

Para el trabajo POST:

  • Nombre de la entidad es: grabación-interacción-metadatos

  • Versión es: 12

  • Para filtrar los datos por fecha y hora, use fecha de inicio y fecha final en UTC con el formato: yyyy-mm-dd hh:mm:ss

WFM Entidad de nómina y Archivo csv

La API de Nómina de WFM (versión1) le permite extraer datos de actividad de WFM para fines de generación de reportes de nómina externos.

El WFM nombre de entidad de Nómina para el trabajo POST es: wfm-payroll.

Los datos se filtran de acuerdo con el código de nómina fecha. Tenga en cuenta que la zona horaria de la fecha y la hora corresponde a la zona horaria de la unidad de programación.