API de extracción de datos

Las API de extracción de datos le permiten extraer datos de CXone para fines de informes externos. Por ejemplo, puede extraer CXone QM datos de flujo de trabajo, CXone QM datos de preguntas y respuestas, CXone Recording metadatos de interacción, o CXone WFM Datos de nómina. Los datos solo se pueden filtrar de acuerdo con el rango de fechas especificado.

Las API de extracción de datos están disponibles en el Portal de la comunidad de desarrolladores de DEVone.

Para obtener más información sobre dominios y URL, consulte Empezando en el portal de la comunidad de desarrolladores DEVone.

Al llamar al punto final/trabajos con el método POST, una Identificación del trabajose devuelve mientras se preparan los datos. Puede verificar si los datos están listos sondeando el servicio desde el punto final / jobs / {jobId}, se devuelve el estado del trabajo. Si el estado es éxito, 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 que empiece

Antes de empezar a utilizar la API de datos comerciales, debe configurar los permisos de usuario, generar una clave de acceso, y seguir el proceso de registro y autenticación que se explica en el portal de desarrolladores. Permisos necesarios:

  • Entidad:

    • Si está extrayendo metadatos de interacción, entonces necesita el permiso Buscar y Reproducir > API > Extraer metadatos de interacción.

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

    • Si estás extrayendo CXone QMDatos de preguntas y respuestas, entonces necesitas las Herramientas QM > API de extracción de datos > permiso API de flujo de trabajo QM.

    • Si estás extrayendo CXone WFMDatos de nómina, entonces necesitas el CXone WFM > API de extracción de datos > permiso CXone WFMAPI de nómina.

GET Trabajos

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

PUBLICAR 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 termine, se devuelve una ID de trabajo.

OBTENER Trabajos por ID de trabajo

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

CXone QMEntidad de flujo de trabajo y archivo CSV

La API de flujo de trabajo CXone QM permite extraer los datos de flujo de trabajo de CXone 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).

CXone QM Entidad de preguntas y respuestas (Q&A) y archivo CSV

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

Para el trabajo POST:

  • nombre de la entidad es:qm-preguntas

  • versiónes: 1

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

Notas del evaluador CXone QM y archivo CSV

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

Para el trabajo POST:

  • entityName es: qm-evaluation-comment-entity

  • versiónes: 1

Los datos se filtran según 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 CXone Recording Metadatos de interacción.

Para el trabajo POST:

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

  • versiónes: 7

  • Para filtrar datos por fecha y hora utilice startDate y endDate en UTC con el formato: aaaa-mm-dd hh:mm:ss

CXone WFM Entidad de nómina y archivo CSV

El CXone WFM API de nómina (versión1) te permite extraerCXone WFM datos de actividad para fines de informes de nómina externos.

El CXone WFM nombre de la entidad de nómina para el trabajo POST es:nómina de wfm.

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