Met behulp van de Data Extraction API's kunt u gegevens uit CXone Mpower extraheren voor externe rapportage. U kunt bijvoorbeeld workflowgegevens van QM, vraag- en antwoordgegevens van QM, interactie-metadata van Recording of payrollgegevens van WFM extraheren. Gegevens kunnen alleen worden gefilterd volgens een datumbereik.
De API's voor gegevensextractie zijn beschikbaar in de ontwikkelaarscommunityportal.
Voor meer informatie over domeinen en URL's, zie Aan de slag in de Developer Community-portal.
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:
-
Entiteit:
-
Als u interactie-metadata wilt extraheren, hebt u de machtiging Zoeken en afspelen > API's > Interactie-metadata extraheren nodig.
-
Als u workflowgegevens van QM wilt extraheren, hebt u de machtiging QM-tools > Data Extraction API's > QM Workflow API nodig.
-
Als u vraag- en antwoordgegevens van QM wilt extraheren, hebt u de machtiging QM-tools > Data Extraction API's > QM Workflow API nodig.
-
Als u payrollgegevens van WFM wilt extraheren, hebt u de machtiging WFM > Data Extraction API's > WFM Payroll API nodig.
-
OPHALEN Taken
Een lijst weergeven met alle taakstatussen per tenant. Mogelijke statussen zijn Wordt uitgevoerd, Geslaagd, Mislukt, Geannuleerd en Vervallen.
Voorbeelden van aanroepen en antwoorden
Voorbeeld
"jobs": [ { "id": "9dd92a83-1234-8549-8df4-939485722942", "status": "RUNNING" }, { "id": "12345d5h-c099-2345-k3r3-w3ko9ppp1234", "status": "FAILED" } ] }
Reacties
-
Status 200 - Geslaagd. Status is opgehaald voor alle taken.
-
Status 401 - Niet geautoriseerd. Ongeldige inloggegevens.
-
Status 403 - Verboden. De gebruiker heeft geen machtiging om de taakstatus te bekijken.
-
Status 500 - Interne serverfout.
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.
Voorbeelden van aanroepen en antwoorden
| Body van de aanroep*: | application/json |
|
exportRequest {
|
De parameters die moeten worden opgegeven om de gegevens te extraheren. |
| entityName |
string De naam van de te extraheren entiteit. Zie verderop voor de juiste entiteitsnamen. |
| versie |
string De versie van de te extraheren entiteit. Zie verderop voor de juiste entiteitsversies. |
| startDate |
string($date) De datum (in UTC) om te beginnen met het extraheren van gegevens. De datumnotatie is <YYYY-MM-DD>. Als u bijvoorbeeld gegevens wilt extraheren vanaf 22 mei 2019, voert u de datum als volgt in: 2019-05-22. |
| endDate |
string($date) Datum (in UTC) om te stoppen met het extraheren van gegevens. De datumnotatie is <YYYY-MM-DD>. Als u bijvoorbeeld gegevens wilt extraheren tot 29 mei 2019, voert u de datum als volgt in: 2019-05-29. |
| } |
Voorbeeld
{ "entityName": "qm-workflows", "version": "3", "startDate": "2019-05-22", "endDate": "2019-05-29" }
Reacties
-
Status 202 - Geslaagd. Asynchrone taak is geëxporteerd.
string
Voorbeeld: 12345d5h-c099-9303-j99j-w3ko9ppp1234
-
Status 400 - Ongeldige aanvraag. Bijvoorbeeld vanwege onjuiste datumfilters.
-
Status 401 - Niet geautoriseerd. Ongeldige inloggegevens.
-
Status 403 - Verboden. De gebruiker heeft geen machtiging om de taakstatus te bekijken.
-
Status 404 - Niet gevonden. Ontbrekende entiteit of ongeldige versie.
-
Status 500 - Interne serverfout.
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.
Voorbeelden van aanroepen en antwoorden
| jobId*: |
string De unieke identificatiecode voor de aanroep om klantgegevens te extraheren. |
Voorbeeld
12345d5h-r3ds-9303-0pw3-w3ko9ppp1234
Reacties
-
Status 202 - Geslaagd. Taakstatus is opgehaald.
jobResponse{ description: Displays the job status jobStatus: { description: Job Status, includes job ID and job status id: string Unique identifier of the job. status: string example: SUCCEEDED Job status that can be returned. Enum: [ RUNNING, SUCCEEDED, FAILED, CANCELLED, EXPIRED ] result: { description: Job result. If successful, contains the url, if failed, an error message is displayed. url: string example: https://s3.example.amazonaws.com/results-bucket/data-extraction/{details} A url to access the extracted data is returned when a job for extracting data is successful. errorMessage: string Error message displayed when a request for extracting data fails. } } } -
Status 400 - Ongeldige aanvraag. Bijvoorbeeld vanwege onjuiste datumfilters.
-
Status 401 - Niet geautoriseerd. Ongeldige inloggegevens.
-
Status 403 - Verboden. De gebruiker heeft geen machtiging om de taakstatus te bekijken.
-
Status 404 - Niet gevonden. Ontbrekende entiteit of ongeldige versie.
-
Status 500 - Interne serverfout.
Entiteiten en CSV-bestand voor QM Workflow API
Met de QM Workflow API kunt u 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).
Velden in het CSV-bestand voor de QM Workflow
|
Kolomnaam |
Beschrijving |
|---|---|
|
Tenantnaam |
De naam van de tenant. |
|
Agent-ID |
De unieke identificatiecode van de agent. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Type |
Het type evaluatie, bijvoorbeeld:
Veldtype: string met maximaal 24 tekens (VARCHAR) |
|
Trigger voor evaluatiestroom |
De gebeurtenis waarmee de evaluatie is begonnen:
Veldtype: string met maximaal 24 tekens (VARCHAR) |
|
Workflowstatus |
De status van de workflow:
Veldtype: string met maximaal 128 tekens (VARCHAR) |
|
Automatisch bevestigd |
De mogelijke waarden zijn:
Veldtype: BOOLEAN |
|
Workflowtoestand |
De huidige toestand van de workflow:
Veldtype: string met maximaal 128 tekens (VARCHAR) |
|
Werkstroom-ID |
De unieke identificatiecode van de evaluatie. Veldtype: string met maximaal 36 tekens (VARCHAR) API-versie: 3 en hoger |
|
Plannaam |
De naam van het kwaliteitsplan dat is gebruikt om deze evaluatie te initiëren. Veldtype: string met maximaal 128 tekens (VARCHAR) |
|
Formuliernaam |
De naam van het formulier dat voor deze evaluatie is gebruikt. Veldtype: string met maximaal 256 tekens (VARCHAR) |
|
Formulierversie |
De voor deze evaluatie gebruikte versie van het evaluatieformulier. Veldtype: getal (4,0) |
|
Startdatum |
Datum en tijd (in UTC) waarop deze evaluatie is gestart. Veldtype: TIMESTAMP_LTZ(3) |
|
Datum en tijd (in UTC) waarop deze evaluatie is ingediend. Veldtype: TIMESTAMP_LTZ(3) |
|
|
Laatst bijgewerkt |
De tijd (in UTC) wanneer deze evaluatie voor het laatst is gewijzigd. Veldtype: TIMESTAMP_LTZ(3) |
|
Score - Percentage |
De evaluatiescore als percentage. Veldtype: FLOAT |
|
Score |
De score van de evaluatie. Veldtype: FLOAT |
|
Maximale score |
De hoogst mogelijke score voor elke vraag in het evaluatieformulier. Veldtype: FLOAT |
|
Rang |
Aangepast bereik van waarden, ingesteld door de gebruiker om de ranking van het formulier te definiëren. Veldtype: string met maximaal 256 tekens (VARCHAR) |
|
Incorrect beantwoorde kritieke vraag |
Als deze waarde Waar is, is een kritieke vraag niet bevredigend beantwoord en is de score van het evaluatieformulier ingesteld op nul. Als de waarde Onwaar is, heeft de gebruiker de vraag bevredigend beantwoord. Veldtype: BOOLEAN |
|
Opmerkingen van gebruiker |
De opmerkingen die de gebruiker (agent) heeft ingevoerd bij het betwisten van de evaluatie. Veldtype: string met maximaal 256 tekens (VARCHAR) |
|
Opmerkingen beoordelaar betwisten |
De opmerkingen die de manager of beoordelaar heeft ingevoerd bij het oplossen en afsluiten van het bezwaar. Veldtype: string met maximaal 256 tekens (VARCHAR) |
|
Segment-ID |
De segment-ID van de interactie die is geëvalueerd. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
ACD ID |
De unieke identificatiecode van de ACD-tool. Veldtype: getal (38,0) |
|
Interactietype |
Het type interactie:
Veldtype: string met maximaal 50 tekens (VARCHAR) |
|
Interaction Start Date |
De startdatum- en tijd (in UTC) van de interactie. Veldtype: TIMESTAMP_LTZ(6) |
|
Interaction End Date |
De einddatum en -tijd (in UTC) van de interactie. Veldtype: TIMESTAMP_LTZ(6) |
|
Interactierichting |
De richting van de oproep:
Veldtype: string met maximaal 50 tekens (VARCHAR) |
|
Team-ID |
De unieke identificatie van het team van de agent. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Teamnaam |
De naam van het team van de agent. Veldtype: string met maximaal 50 tekens (VARCHAR) |
|
Telefoonnummer |
Het telefoonnummer van de klant. Veldtype: string met maximaal 200 tekens (VARCHAR) |
|
FirstName (Eva) |
De voornaam van de beoordelaar. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
LastName (Eva) |
De achternaam van de beoordelaar. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
FirstName (Agent) |
De voornaam van de beoordeelde agent. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
LastName (Agent) |
De achternaam van de geëvalueerde agent. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
FirstName (Disp) |
De voornaam van de persoon die het bezwaar heeft afgehandeld. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
LastName (Disp) |
De achternaam van de persoon die het bezwaar heeft afgehandeld. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
FirstName (Assigner) |
De voornaam van de gebruiker die de evaluatie heeft toegewezen. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
LastName (Assigner) |
De achternaam van de gebruiker die de evaluatie heeft toegewezen. Veldtype: string met maximaal 255 tekens (VARCHAR) |
| Reden |
De reden voor het verwijderen van de evaluatie. Veldtype: string met maximaal 128 tekens (VARCHAR) API-versie: 4 en hoger |
| Bovenliggende ID |
De bovenliggende workflow-ID van de evaluatie, zoals Gezamenlijk of Kalibratie. Veldtype: string met maximaal 36 tekens (VARCHAR) API-versie: 4 en hoger |
| Onderwerp van evaluatie |
De mogelijke waarden zijn:
Veldtype: string met maximaal 128 tekens (VARCHAR) API-versie: 4 en hoger |
Entiteiten en CSV-bestand voor QM Q&A
Met de QM Q&A API kunt u de vragen en antwoorden uit 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).
Velden in het CSV-bestand voor de QM Q&A
|
Kolomnaam |
Beschrijving |
|---|---|
|
Vraag-ID |
Unieke identificatie van de vraag. Veldtype: NUMBER(38,0) |
| Titel van de vraag |
De tekst van de vraag. Veldtype: string met maximaal 2048 tekens (VARCHAR) |
| Vraagnummer |
Het nummer van de vraag in het evaluatieformulier. Veldtype: string met maximaal 15 tekens (VARCHAR) |
| Answer |
Het antwoord van de beoordelaar op de vraag. Veldtype: string met maximaal 10000 tekens (VARCHAR) |
| Opties |
De beschikbare antwoordopties voor de vraag, zoals Ja/nee, numerieke opties, keuzerondjes enzovoort. Veldtype: ARRAY |
| Formulier-ID |
De unieke identificatiecode van het evaluatieformulier. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Formuliernaam |
De naam van het formulier dat voor deze evaluatie is gebruikt. Veldtype: string met maximaal 256 tekens (VARCHAR) |
|
Formulierversie |
De voor deze evaluatie gebruikte versie van het evaluatieformulier. Veldtype: NUMBER(4,0) |
| Startdatum evaluatie |
Datum en tijd (in UTC) waarop deze evaluatie is gestart. Veldtype: TIMESTAMP_LTZ(3) |
| Indieningsdatum evaluatie |
Datum en tijd (in UTC) waarop deze evaluatie is ingediend. Veldtype: TIMESTAMP_LTZ(3) |
|
Workflow Type |
Het type evaluatie, bijvoorbeeld:
Veldtype: string met maximaal 24 tekens (VARCHAR) |
| Sectie-ID | Unieke identificatie van de sectie in het evaluatieformulier. Veldtype: NUMBER(38,0) |
| Titel van de sectie |
De naam van de sectie in het evaluatieformulier. Veldtype: string met maximaal 2048 tekens (VARCHAR) |
| Scoorbaar |
Een vlag (True/False) die aangeeft of de vraag een score krijgt. Veldtype: BOOLEAN |
| Werkelijke score |
De score die de agent voor de vraag heeft gekregen. Veldtype: FLOAT |
| Sectiescore (%) |
De procentuele score van de sectie gedeelte waarin de vraag zich bevond. Veldtype: FLOAT |
| Maximale score |
De maximale score die een agent op de vraag had kunnen krijgen. Veldtype: FLOAT |
|
Agent-ID |
De unieke identificatiecode van de agent. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
FirstName (Agent) |
De voornaam van de beoordeelde agent. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
LastName (Agent) |
De achternaam van de geëvalueerde agent. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
Team-ID |
De unieke identificatie van het team van de agent. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Teamnaam |
De naam van het team van de agent. Veldtype: string met maximaal 50 tekens (VARCHAR) |
|
FirstName (Eva) |
De voornaam van de beoordelaar. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
LastName (Eva) |
De achternaam van de beoordelaar. Veldtype: string met maximaal 255 tekens (VARCHAR) |
| Kritiek |
Een vlag (True/False) die aangeeft of de vraag een kritieke vraag is. Veldtype: BOOLEAN |
|
Incorrect beantwoorde kritieke vraag |
Als deze waarde Waar is, is een kritieke vraag niet bevredigend beantwoord en is de score van het evaluatieformulier ingesteld op nul. Als de waarde Onwaar is, heeft de gebruiker de vraag bevredigend beantwoord. Veldtype: BOOLEAN |
| Verplicht |
Een vlag (True/False) die aangeeft of de vraag verplicht is. Veldtype: BOOLEAN |
| Vraagtype |
Het type vraag:
Veldtype: string met maximaal 64 tekens (VARCHAR) |
|
Segment-ID |
De segment-ID van de interactie die is geëvalueerd. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Interaction Start Date |
De startdatum- en tijd (in UTC) van de interactie. Veldtype: TIMESTAMP_LTZ(6) |
|
Interaction End Date |
De einddatum en -tijd (in UTC) van de interactie. Veldtype: TIMESTAMP_LTZ(6) |
|
Workflowinstantie-ID |
De unieke identificatiecode van de evaluatie. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Evaluatiescore (%) |
De procentuele score van de evaluatie. Veldtype: FLOAT |
|
Bank-ID |
De unieke identificatiecode van de Vraagbank waarin de vraag voorkomt. Veldtype: string met maximaal 36 tekens (VARCHAR) |
| Verborgen naam |
Met de vlag True worden de vragen verborgen en met de vlag False worden de vragen getoond. Bij gebruik van de regel QM-formulier in een kwaliteitsformulier wordt een vervolgvraag verborgen op basis van de score van een eerdere vraag. Veldtype: BOOLEAN API-versie: 2 en hoger |
Opmerkingen beoordelaar en CSV-bestand voor QM
Met de API van de opmerkingen van de beoordelaar QM kunt u 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).
Velden in het CSV-bestand voor de QM notities van de beoordelaar
|
Kolomnaam |
Beschrijving |
|---|---|
|
Opmerking-ID |
De unieke ID van de opmerking. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Opmerkingen |
De tekst voor de opmerking. Veldtype: string met maximaal 300 tekens (VARCHAR) |
|
Tijd voor opmerking |
Datum en tijd waarop de opmerking werd toegevoegd. Veldtype: TIMESTAMP_LTZ(3) |
|
Activiteit |
De actienaam van de evaluatie wanneer de opmerking werd toegevoegd. Veldtype: string met maximaal 50 tekens (VARCHAR) |
|
Opmerking gegeven door ID. |
De unieke ID van de gebruiker die de opmerking heeft toegevoegd. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Opmerking gegeven door FirstName |
De voornaam van de gebruiker die de opmerking heeft toegevoegd. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
Opmerking gegeven door LastName |
De achternaam van de gebruiker die de opmerking heeft toegevoegd. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
Vraag-ID |
De unieke ID van de vraag. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Titel van de vraag |
De tekst van de vraag. Veldtype: string met maximaal 2048 tekens (VARCHAR) |
|
Formulier-ID |
De unieke identificatiecode van het evaluatieformulier. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Formuliernaam |
De naam van het formulier dat voor de evaluatie is gebruikt. Veldtype: string met maximaal 256 tekens (VARCHAR) |
|
Formulierversie |
De voor de evaluatie gebruikte versie van het evaluatieformulier. Veldtype: NUMBER(4,0) |
|
Werkstroom-ID |
De unieke identificatiecode van de evaluatie. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Workflowstatus |
De status van de workflow. Veldtype: string met maximaal 128 tekens (VARCHAR) |
|
Agent-ID |
De unieke ID van de agent. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
FirstName (Agent) |
Voornaam van de agent. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
LastName (Agent) |
Achternaam van de agent. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
Team-ID |
De unieke identificatie van het team van de agent. Veldtype: string met maximaal 36 tekens (VARCHAR) |
|
Teamnaam |
De naam van het team van de agent. Veldtype: string met maximaal 50 tekens (VARCHAR) |
Entiteiten en CSV-bestand voor de Interaction Metadata API
De Interaction Metadata API stelt u in staat om Recording interactie-metadata te 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
Velden in het CSV-bestand met interactie-metadata
|
Kolomnaam |
Beschrijving |
|---|---|
|
ACD Call ID |
De ACD Oproep-ID is afhankelijk van de gebruikte ACD-oplossing en kan bijvoorbeeld gelijk zijn aan de CXone Mpower Mastercontact-ID Veldtype: getal met maximaal 38 cijfers |
|
Segment-ID |
De unieke identificatiecode van het segment. Een segment is een interactie met twee partijen, zoals een klant en een agent. Veldtype: string met maximaal 36 tekens (VARCHAR UUID) |
|
Segment Start Reason |
De reden waarom het segment is gestart:
Veldtype: string met maximaal 100 tekens (VARCHAR) |
|
Segment End Reason |
De reden waarom het segment is beëindigd:
Veldtype: string met maximaal 100 tekens (VARCHAR) |
| Richting |
De richting van het segment:
Veldtype: string met maximaal 150 tekens (VARCHAR) |
|
Startdatum en -tijd (in UTC) van het segment. Veldtype: TIMESTAMP |
|
|
Einddatum |
Einddatum en -tijd (in UTC) van het segment. Veldtype: TIMESTAMP |
| Kanaaltype |
Het type interactie:
Veldtype: string met maximaal 150 tekens (VARCHAR) |
| Schermopname |
Geeft aan of het segment een schermopname omvat:
|
| Voice Recording Status |
De status van de opname:
Veldtype: string met maximaal 250 tekens (VARCHAR) |
| Screen Recording Status |
De status van de opname:
Veldtype: string met maximaal 250 tekens (VARCHAR) |
|
Opnamewaarschuwingen |
De volgende opnamewaarschuwingen zijn mogelijk:
|
|
Beleidsnaam |
Naam van het opnamebeleid of het niet-opnemen-beleid dat is toegepast op deze interactie. Veldtype: string met maximaal 100 tekens (VARCHAR) |
| ANI |
Bij inbound oproepen is ANI het telefoonnummer van de beller (de beller-ID). Veldtype: string met maximaal 200 tekens (VARCHAR) |
| DNIS |
Bij inbound oproepen is DNIS het telefoonnummer dat de beller heeft gebeld. Veldtype: string met maximaal 200 tekens (VARCHAR) |
| ACW (in seconds) |
Het aantal seconden dat de schermopname na afloop van de oproep werd voortgezet om het nawerk van de agent vast te leggen. |
| Dispositie | De dispositie die de agent heeft toegewezen (een label met aanvullende informatie over de oproep). |
| Gebruikers-ID agent |
De unieke identificatiecode van de agent. Het CSV-bestand kan agentgerelateerde informatie bevatten voor maximaal 5 agents. Bijvoorbeeld: gebruikers-ID Agent1, gebruikers-ID Agent2, gebruikers-ID Agent3, gebruikers-ID Agent4 en gebruikers-ID Agent5. Veldtype: string met maximaal 36 tekens (VARCHAR) |
| Agent ACD ID |
De unieke identificator die door de ACD aan de agent is toegewezen. Het CSV-bestand kan agentgerelateerde informatie bevatten voor maximaal 5 agents. Bijvoorbeeld: ACD-ID Agent1, ACD-ID Agent2, ACD-ID Agent3, ACD-ID Agent4 en ACD-ID Agent5. Veldtype: string met maximaal 50 tekens (VARCHAR) |
| Contactnummer agent |
Unieke ID van het contact dat is gemaakt voor deze agent. Het CSV-bestand kan agentgerelateerde informatie bevatten voor maximaal 5 agents. Bijvoorbeeld: contactnummer Agent1, contactnummer Agent2, contactnummer Agent3, contactnummer Agent4 en contactnummer Agent5. Dit veld is niet beschikbaar voor Multi-ACD (Open). Veldtype: getal met maximaal 38 cijfers API-versie: 5 en hoger |
|
Agentnaam |
De naam van de agent zoals ingesteld in de CXone Mpower-medewerkersaccount. Het CSV-bestand kan agentgerelateerde informatie bevatten voor maximaal 5 agents. Bijvoorbeeld: naam Agent1, naam Agent2, naam Agent3, naam Agent4 en naam Agent5. Veldtype: string met maximaal 100 tekens (VARCHAR) |
|
Agent Team ID |
De unieke identificatiecode van het team van de agent. Het CSV-bestand kan agentgerelateerde informatie bevatten voor maximaal 5 agents. Bijvoorbeeld: team-ID Agent1, team-ID Agent2, team-ID Agent3, team-ID Agent4 en team-ID Agent5. Veldtype: string met maximaal 36 tekens (VARCHAR UUID) |
|
Agent Team |
De naam van het team van de agent. Het CSV-bestand kan agentgerelateerde informatie bevatten voor maximaal 5 agents. Bijvoorbeeld: team Agent1, team Agent2, team Agent3, team Agent4 en team Agent5. Veldtype: string met maximaal 40 tekens (VARCHAR) |
|
Agentskills |
Een classificatie die aan de agent is toegewezen in de ACD op basis van de vaardigheden, specialismen en vakkennis van de agent. Het CSV-bestand kan agentgerelateerde informatie bevatten voor maximaal 5 agents. Bijvoorbeeld: skill Agent1, skill Agent2, skill Agent3, skill Agent4 en skill Agent5. Veldtype: string met maximaal 50 tekens (VARCHAR) |
|
Gekoppelde lijst met contactnummers |
Lijst van contactnummers van agents die gekoppeld zijn met het segment. De elementen van deze lijst zijn alleen van het nummertype. Veldtype: afwijking API-versie: 7 en hoger |
|
Interactie-ID |
Een unieke ID (UUID) voor een interactie. Wanneer er meerdere segmenten gekoppeld zijn met één interactie, kunnen de segmenten dezelfde interactie-ID hebben. De interactie-ID is niet dezelfde als de Segment-ID of Contact-ID. Veldtype: string met maximaal 36 tekens (VARCHAR) API-versie: 7 en hoger |
| Aantal in wachtstand | Het totale aantal keren dat de agent de klant tijdens een gesprek in de wacht heeft gezet. |
| Houdduur in seconden | Het totale aantal seconden dat de klant in de wacht is gezet tijdens een gesprek (de som van alle wachttijden). |
|
Naam bedrijfsgegevens |
De naam van het veld met bedrijfsgegevens. Veldtype: string met maximaal 128 tekens (VARCHAR) API-versie: 7 en hoger |
|
Waarde bedrijfsgegevens |
De waarde van de bedrijfsgegevens kan een tekst, een getal of true/false zijn. Bedrijfsgegevens kunnen uit maximaal 50 velden bestaan: 35 VARCHAR-velden, 10 numerieke velden en 5 Booleaanse velden. Veldtype:
API-versie: 7 en hoger |
|
Source |
De bron van de opname-CXone Mpower of een externe bron. Waarden omvatten:
Veldtype: string met maximaal 30 tekens (VARCHAR) API-versie: 6 en hoger |
|
External Contact ID |
De id van een contact zoals gedefinieerd in de externe bron van de opname. De waarden zijn alleen beschikbaar voor gebruikers met AppLink. Veldtype: string met maximaal 100 tekens (VARCHAR) API-versie: 6 en hoger |
|
External Segment ID |
De id van een segment zoals gedefinieerd in de externe bron van de opname. De waarden zijn alleen beschikbaar voor gebruikers met AppLink. Veldtype: string met maximaal 100 tekens (VARCHAR) API-versie: 6 en hoger |
en selecteert u WFM Entiteiten en CSV-bestand voor de Payroll API
Met de WFM Payroll API (versie 1) kunt u gegevens van WFMactiviteiten extraheren voor externe loonrapportage.
De naam van de 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.
Velden in het CSV-bestand voor WFM Payroll
|
Kolomnaam |
Beschrijving |
|---|---|
|
Voornaam |
De voornaam van de agent. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
Achternaam |
De achternaam van de agent. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
Gebruikersnaam |
De gebruikersnaam van de agent. Veldtype: string met maximaal 255 tekens (VARCHAR) |
|
Planningseenheid |
De planningseenheid van de agent. Veldtype: string met maximaal 256 tekens (VARCHAR) |
|
Scheduling Unit's Time Zone |
De tijdzone van de planningseenheid van de agent. Veldtype: string met maximaal 128 tekens (VARCHAR) |
|
Payroll Code |
De looncode die de geplande activiteitsgegevens bevat. Veldtype: string met maximaal 50 tekens (VARCHAR) |
|
De datum (in de tijdzone van de planningseenheid) van de activiteit. Veldtype: DATE |
|
|
De starttijd (in de tijdzone van de planningseenheid) van de activiteit. Veldtype: TIME (9) |
|
|
Duration In Seconds |
De duur van de activiteit in seconden. Veldtype: NUMBER (8,0) |