API's voor gegevensextractie

Met behulp van de Data Extraction API's kunt u gegevens uit CXone extraheren voor externe rapportage. U kunt bijvoorbeeld workflowgegevens van CXone QM, vraag- en antwoordgegevens van CXone QM, interactie-metadata van CXone Recording of payrollgegevens van CXone WFM extraheren. Gegevens kunnen alleen worden gefilterd volgens een datumbereik.

De Data Extraction API's zijn beschikbaar in het DEVone Developer Community-portaal.

Zie het onderwerp Aan de slag in het DEVone Developer Community-portaal voor meer informatie over domeinen en URL's.

Na het aanroepen van het /jobs-eindpunt met de POST-methode wordt een jobId geretourneerd terwijl de gegevens worden voorbereid. U kunt controleren of de gegevens gereed zijn door de service te peilen via het eindpunt/jobs/{jobId}, waarna de status van de taak wordt geretourneerd. Als de status success is, wordt er bovendien een URL geretourneerd. De URL blijft gedurende 30 seconden toegankelijk (plus de tijd die nodig is om het bestand te downloaden).

U kunt scripts schrijven om de API periodiek aan te roepen in plaats van de gegevens elke keer handmatig op te halen. Op een gegeven moment kan slechts één gebruiker per tenant een API aanroepen. U kunt de API maar één keer in een periode van 30 seconden aanroepen.

Voordat u begint

Voordat u de Business Data API kunt gebruiken, dient u eerst gebruikersmachtigingen in te stellen, een toegangssleutel te genereren en het registratie- en authenticatieproces uitgelegd op het Developers Portal te doorlopen. Vereiste machtigingen:

OPHALEN Taken

Een lijst weergeven met alle taakstatussen per tenant. Mogelijke statussen zijn Wordt uitgevoerd, Geslaagd, Mislukt, Geannuleerd en Vervallen.

POST taken

Nadat een verzoek om gegevens te extraheren is ingediend, worden de gegevens verzameld en voorbereid voor extractie. De gegevens zijn gedurende 24 uur beschikbaar in S3 als een CSV-bestand. Na afloop wordt een taak-ID geretourneerd.

GET taken per taak-ID

Bekijk de status voor een specifieke taak op basis van de taak-ID. Als een taak is geslaagd, wordt een URL geretourneerd die toegang geeft tot de opgehaalde gegevens. Deze URL is gedurende 30 seconden toegankelijk (plus de tijd die nodig is om het bestand te downloaden). Als de taak is mislukt, wordt een foutbericht geretourneerd. De link kan worden gebruikt om toegang te krijgen tot de geëxtraheerde gegevens. Mogelijke taakstatussen zijn Wordt uitgevoerd, Geslaagd, Mislukt, Geannuleerd en Vervallen.

Entiteiten en CSV-bestand voor CXone QM Workflow API

Met de CXone QM Workflow API kunt u CXone QM-workflowgegevens extraheren, zoals evaluaties, zelfbeoordelingen en kalibraties.

Voor de POST-taak:

  • entityName is: qm-workflows

  • versie is: 4

Gegevens worden gefilterd op basis van de Indieningsdatum (in UTC).

Entiteiten en CSV-bestand voor CXone QM Q&A

Met de CXone QM Q&A API kunt u de vragen en antwoorden uit CXone QM-evaluaties, zelfbeoordelingen en kalibraties extraheren.

Voor de POST-taak:

  • entityName is: qm-questions

  • versie is: 2

Gegevens worden gefilterd op basis van de Indieningsdatum (in UTC).

Opmerkingen beoordelaar en CSV-bestand voor CXone QM

Met de API van de opmerkingen van de beoordelaar CXone QM kunt u CXone QM notities van de beoordelaar extraheren.

Voor de POST-taak:

  • entityName is: qm-evaluation-comment-entity

  • versie is: 1

Gegevens worden gefilterd op basis van de Indieningsdatum (in UTC).

Entiteiten en CSV-bestand voor de Interaction Metadata API

Met Interactie-metadata extraheren kunt u metadata van CXone Recording-interacties extraheren.

Voor de POST-taak:

  • entityName is: recording-interaction-metadata

  • versie is: 7

  • Om gegevens te filteren op datum en tijd, gebruikt u startDate en endDate in UTC met de notatie: jjjj-mm-dd uu:mm:ss

CXone WFM Entiteiten en CSV-bestand voor de Payroll API

Met de CXone WFM Payroll API (versie 1) kunt u gegevens van CXone WFMactiviteiten extraheren voor externe loonrapportage.

De naam van de CXone WFM Payroll-entiteit voor de POST-taak is: wfm-payroll.

Gegevens worden gefilterd op basis van de datum van de looncode. Let op: de tijdzone voor de datum en tijd is gebaseerd op de tijdzone van de planningseenheid.