APIs für die Datenextraktion

Mit den APIs für die Datenextraktion können Sie Daten CXone Mpower für externe Berichtszwecke extrahieren. Sie können zum Beispiel QM Workflow-Daten, QM Frage- und Antwortdaten, Recording Interaktions-Metadaten oder WFM Abrechnungsdaten extrahieren. Daten können nur nach dem angegebenen Datumsbereich gefiltert werden.

Sie können die Daten Extraktion APIs ausprobieren und deren Dokumentation im Entwicklerportal einsehen.

Beim Aufruf von POST /jobswird eine jobId zurückgegeben, während die Daten vorbereitet werden. Sie können überprüfen, ob die Daten bereit sind, indem Sie den Dienst vom Endpunkt /jobs/{jobId}abfragen, der den Status des Auftrags zurückgibt. Wenn der Status success ist, wird auch eine zusätzliche URL zurückgegeben. Die URL ist 30 Sekunden lang verfügbar (ohne die Zeit, die zum Herunterladen der Datei benötigt wird).

Sie können Skripte schreiben, um die API regelmäßig aufzurufen, anstatt die Daten jedes Mal manuell abzurufen. Zu jedem Zeitpunkt kann nur ein Benutzer pro Instanz eine API aufrufen. Sie können die API nur einmal in einem Zeitraum von 30 Sekunden aufrufen.

Bevor Sie beginnen

Sie können CXone Mpower APIs auf dem Entwicklerportal testen. Melden Sie sich mit einem CXone Mpower-Konto an, dann können Sie Anfragen mit dem tenant Eine übergeordnete organisatorische Gruppierung, die Sie für die technische Unterstützung und Abrechnung und außerdem zur Bearbeitung von globalen Einstellungen in Ihrem CXone Mpower-System einsetzen können.. Ihres Kontos stellen.

Um die APIs nutzen zu können, müssen Sie sich bei NiCE registrieren, um gültige Anmeldeinformationen für die Authentifizierung zu erhalten. Anweisungen finden Sie auf der Seite Erste Schritte im Entwicklerportal.

Für die Nutzung dieser APIs sind folgende Berechtigungen erforderlich:

Entität:
- Wenn Sie Interaktionsmetadaten extrahieren möchten, benötigen Sie die Berechtigung Suche & Wiedergabe > APIs > Interaktionsmetadaten extrahieren.
- Wenn Sie QMWorkflowdaten extrahieren, benötigen Sie die Berechtigung QM-Tools > Datenextraktions-APIs > QM-Workflow-API.
- Wenn Sie QMQ&A-Daten extrahieren, dann benötigen Sie die Berechtigung QM-Werkzeuge > Datenextraktions-APIs > QM-Workflow-API .
- Wenn Sie WFM Payroll-Daten extrahieren, benötigen Sie die Berechtigung WFM > Datenextrahierung-APIs > WFM Payroll API .
- Wenn Sie QM Auswertungsnotizenextrahieren, benötigen Sie die Berechtigung QM Tools > Daten Extraktion APIs > QM Evaluator Notes API.

Jobs finden

Zeigen Sie eine Liste aller Jobstatus pro Instanz an. Mögliche Status sind Ausgeführt, Erfolgreich, Fehler, Abgebrochen und Abgelaufen.

Methode: GET

Endpunkt: /data-extraction/v1/jobs

Parameter: keine

Jobs vorbereiten

Nachdem eine Anforderung zum Extrahieren von Daten gestellt wurde, werden die Daten gesammelt und für die Extraktion vorbereitet. Die Daten sind in S3 24 Stunden lang als CSV-Datei verfügbar. Wenn Sie fertig sind, wird eine Job-ID zurückgegeben.

Methode: POST

Endpunkt: /data-extraction/v1/jobs

Parameter: keine

Beispielwert und Antworten

Anforderungstext*:	application/json
exportRequest { description:	Parameter, die angegeben werden müssen, um Daten zu extrahieren.
entityName	String Name der zu extrahierenden Entität. Die korrekten Entitätsnamen finden Sie unten.
Version	String Version der zu extrahierenden Entität. Die korrekten Versionen für jede Entität finden Sie unten.
startDate	string($date) Datum in UTC, ab dem mit dem Extrahieren von Daten begonnen werden soll. Das Zeitformat ist <YYYY-MM-DD>. Um beispielsweise Daten vom 22. Mai 2019 zu extrahieren, geben Sie das Datum ein: 2019-05-22.
endDate	string($date) Datum in UTC, ab dem mit das Extrahieren von Daten beendet werden soll. Das Zeitformat ist <YYYY-MM-DD>. Geben Sie beispielsweise das Datum 2019-05-29 ein, um Daten bis zum 29. Mai 2019 zu extrahieren.
}

Beispielwert

{ "entityName": "qm-workflows", "version": "3", "startDate": "2019-05-22", "endDate": "2019-05-29" }

Antworten

Status 202 - Erfolg. Asynchroner Job erfolgreich exportiert.

String

Beispiel: 12345d5h-c099-9303-j99j-w3ko9ppp1234
Status 400 - Ungültige Anforderung. Falsche Datumsfilter usw.
Status 401 - Nicht autorisiert. Ungültige Anmeldeinformationen.
Status 403 - Verboten. Der Benutzer hat keine Berechtigung zum Anzeigen des Auftragsstatus.
Status 404 - Nicht gefunden. Fehlende Entität oder ungültige Version.
Status 500 - Interner Serverfehler.

Stellenangebote nach Job-ID

Zeigen Sie den Status für einen bestimmten Job anhand seiner Job-ID an. Wenn ein Auftrag erfolgreich war, wird eine URL für den Zugriff auf die extrahierten Daten zurückgegeben, auf die 30 Sekunden lang zugegriffen werden kann (ohne die Zeit, die zum Herunterladen der Datei benötigt wird). Wenn der Job fehlgeschlagen ist, wird eine Fehlermeldung zurückgegeben. Über den Link kann auf die extrahierten Daten zugegriffen werden. Mögliche Status sind Ausgeführt, Erfolgreich, Fehler, Abgebrochen und Abgelaufen.

Methode: GET

Endpunkt: /data-extraction/v1/jobs

Parameter:

jobId*:

String

Eindeutige Kennung für die Anforderung zum Extrahieren von Kundendaten.

Beispielwert und Antworten

Beispielwert

 12345d5h-r3ds-9303-0pw3-w3ko9ppp1234

Antworten

Status 202 - Erfolg. Auftragsstatus abgerufen.

 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 - Ungültige Anforderung. Falsche Datumsfilter usw.
Status 401 - Nicht autorisiert. Ungültige Anmeldeinformationen.
Status 403 - Verboten. Der Benutzer hat keine Berechtigung zum Anzeigen des Auftragsstatus.
Status 404 - Nicht gefunden. Fehlende Entität oder ungültige Version.
Status 500 - Interner Serverfehler.

QM Workflow-Entität und CSV-Datei Datei

Mit der QM Arbeitsablauf-API können Sie QM-Arbeitsablaufdaten extrahieren, einschließlich Bewertungen, Selbstbewertungen und Kalibrierungen.

Für den POST-Job:

entityName ist: qm-workflows
Version ist: 4

Die Daten werden entsprechend Einreichungsdatum gefiltert (in UTC).

Felder in der CSV-Datei des QM Workflows

Spaltenname	Beschreibung
Mandantenname	Name der Instanz.
Agenten-ID	Eindeutige Kennung des Agenten. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Art	Art der Bewertung, zum Beispiel: Bewertung Selbstbewertung Feldtyp: String mit bis zu 24 Zeichen (VARCHAR)
Auslöser des Auswertungsflusses	Ereignis, mit dem die Bewertung gestartet wurde: Kalibrierung Kollaborativ Manuell QP Feldtyp: String mit bis zu 24 Zeichen (VARCHAR)
Workflow-Status	Status des Workflows: Gesendet an Agent Wird überprüft Widersprechen Abgeschlossene Bestätigung Selbstbewertung abgeschlossen Abgeschlossene Prüfungen Hat keine Prüfung abgeschlossen Abgeschlossen Gelöscht Gelöscht – Abgeschlossen Abgelaufen Gelöscht – Abgelaufen Gelöscht – Abgeschlossen bestätigt Gelöscht - Erledigt Überprüft Gelöscht – Abgeschlossen, keine Überprüfung Feldtyp: String mit bis zu 128 Zeichen (VARCHAR)
Automatisch quittiert	Mögliche Werte sind: TRUE: Wenn der Agent die Auswertung nicht bestätigt hat, wurde sie automatisch bestätigt. FALSE: Wenn der Agent die Bewertung bestätigt hat. Leerer Wert: Bei Selbstbewertung ist keine Bestätigung erforderlich. Feldtyp: BOOLEAN
Workflow-Status	Status des Workflows: Geöffnet Geschlossen Zeitüberschreitung Feldtyp: String mit bis zu 128 Zeichen (VARCHAR)
Arbeitsablauf-ID	Die eindeutige Kennung für die Bewertung. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR) API-Version: 3 und höher
Planname	Der Name des Qualitätsplans, mit dem diese Bewertung initiiert wurde. Feldtyp: String mit bis zu 128 Zeichen (VARCHAR)
Formularname	Der Name des Formulars, das für diese Bewertung verwendet wurde. Feldtyp: String mit bis zu 256 Zeichen (VARCHAR)
Von Version	Die Version des Bewertungsformulars für diese Bewertung. Feldtyp: NUMBER (4,0)
Startdatum	Datum und Uhrzeit des Beginns dieser Bewertung in UTC. Feldtyp: TIMESTAMP_LTZ(3)
Einreichungsdatum	Datum und Uhrzeit der Übermittlung dieser Bewertung in UTC. Feldtyp: TIMESTAMP_LTZ(3)
Zuletzt aktualisiert	Zeitstempel in UTC, wann diese Bewertung zuletzt geändert wurde. Feldtyp: TIMESTAMP_LTZ(3) Bei Einsprüchen möchten Sie das Einreichungsdatum abrufen, nicht Zuletzt aktualisiert.
Punktzahl - Prozentsatz	Bewertungspunktzahl als Prozentwert. Feldtyp: FLOAT
Score	Bewertungspunktzahl. Feldtyp: FLOAT
Maximal mögliche Punktzahl	Die maximal mögliche Punktzahl für jede Frage des Bewertungsformulars. Feldtyp: FLOAT
Platzierung	Benutzerdefinierter Wertebereich, der vom Benutzer festgelegt wird, um den Formularrang zu definieren. Feldtyp: String mit bis zu 256 Zeichen (VARCHAR)
Fehlgeschlagene kritische Frage	Wenn der Wert „true“ ist, bedeutet dies, dass der Benutzer eine kritische Frage nicht bestanden hat und die Bewertung des Bewertungsformulars auf Null gesetzt ist. Wenn der Wert „false“ ist, bedeutet dies, dass der Benutzer die Frage richtig beantwortet hat. Feldtyp: BOOLEAN
Kommentare zur Benutzerbewertung	Die Kommentare des Benutzers (Agenten), während er die Bewertung bestreitet. Feldtyp: String mit bis zu 256 Zeichen (VARCHAR)
Resolver-Kommentare zum Disput	Die Kommentare des Benutzers (Managers/Bewerters), während er den Disput schließt. Feldtyp: String mit bis zu 256 Zeichen (VARCHAR)
Segment-ID	Die Segment-ID der zu bewertenden Interaktion. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
ACD-ID	Eindeutige Kennung des automatischen Anrufverteilers. Feldtyp: NUMBER (38,0)
Interaktionstyp	Art der Interaktion: PHONE_CALL E-MAIL CHAT SMS WORKITEM GOOGLE_BUSINESS_MESSAGES_PRIVATE APPLE_BUSINESS_CHAT_PRIVATE TELEGRAM_PRIVATE LINE_PRIVATE WHATSAPP_PRIVATE SLACK_PRIVATE MICROSOFT_TEAMS_PRIVATE TW_PRIVATE VIBER_PRIVATE CUSTOM_PRIVATE WE_CHAT_PRIVATE FB_PRIVATE Feldtyp: String mit bis zu 50 Zeichen (VARCHAR)
Startdatum der Interaktion	Start-Datum/Uhrzeit (in UTC) der Interaktion. Feldtyp: TIMESTAMP_LTZ(6)
Enddatum der Interaktion	Enddatum-Uhrzeit (in UTC) der Interaktion. Feldtyp: TIMESTAMP_LTZ(6)
Interaktionsrichtung	Anrufdatum: Eingehend Ausgehend Feldtyp: String mit bis zu 50 Zeichen (VARCHAR)
Team-ID	Die eindeutige Kennung des Agententeams. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Teamname	Name des Agententeams. Feldtyp: String mit bis zu 50 Zeichen (VARCHAR)
Telefonnummer	Die Telefonnummer des Kunden. Feldtyp: String mit bis zu 200 Zeichen (VARCHAR)
Vorname (Eva)	Vorname des Bewerters. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Nachname (Eva)	Nachname des Bewerters. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Vorname (Agent)	Vorname des bewerteten Agenten. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Nachname (Agent)	Nachname des bewerteten Agenten. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Vorname (Disp)	Vorname des Disputbeilegers. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Nachname (Disp)	Nachname des Disputbeilegers. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Vorname (Zuweiser)	Vorname des Benutzers. der die Bewertung zugewiesen hat. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Nachname (Zuweiser)	Nachname des Benutzers, der die Bewertung zugewiesen hat. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Grund	Grund für die Löschung der Bewertung. Feldtyp: String mit bis zu 128 Zeichen (VARCHAR) API-Version: 4 und höher
Übergeordnete ID	Die übergeordnete Workflow-ID der Bewertung, z. B. für die Zusammenarbeit und die Kalibrierung. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR) API-Version: 4 und höher
Gegenstand der Bewertung	Mögliche Werte sind: Mitarbeiter Segment Feldtyp: String mit bis zu 128 Zeichen (VARCHAR) API-Version: 4 und höher

QM Fragen und Antworten (F & A) Entität und CSV-Datei

Die QM Q&A API ermöglicht es Ihnen, die Fragen und Antworten aus QM-Bewertungen, Selbstbeurteilungen und Kalibrierungen zu extrahieren.

Für den POST-Job:

entityName ist: qm-questions
Version ist: 2

Die Daten werden entsprechend Einreichungsdatum gefiltert (in UTC).

Felder in der QM F&A CSV-Datei

Spaltenname	Beschreibung
Fragen-ID	Eindeutige Kennung der Frage. Feldtyp: NUMBER (38,0)
Fragetitel	Der Text der Frage. Feldtyp: String mit bis zu 2048 Zeichen (VARCHAR)
Fragenummer	Die Nummer der Frage im Bewertungsformular. Feldtyp: String mit bis zu 15 Zeichen (VARCHAR)
Antwort	Die Antwort des Bewerters auf die Frage. Feldtyp: String mit bis zu 10000 Zeichen (VARCHAR)
Optionen	Die verfügbaren Antwortoptionen für die Frage, z. B. Ja/Nein, numerische Optionen, Optionsfelder usw. Feldtyp: ARRAY
Formular-ID	Eindeutige Kennung des Bewertungsformulars. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Formularname	Der Name des Formulars, das für diese Bewertung verwendet wurde. Feldtyp: String mit bis zu 256 Zeichen (VARCHAR)
Von Version	Die Version des Bewertungsformulars für diese Bewertung. Feldtyp: NUMBER (4,0)
Bewertung Startdatum	Datum und Uhrzeit des Beginns dieser Bewertung in UTC. Feldtyp: TIMESTAMP_LTZ(3)
Datum der Bewertungseinreichung	Datum und Uhrzeit der Übermittlung dieser Bewertung in UTC. Feldtyp: TIMESTAMP_LTZ(3) Bei Einsprüchen möchten Sie das Einreichungsdatumabrufen, nicht das Datum der letzten Änderung.
Arbeitsablauf-Typ	Art der Bewertung, zum Beispiel: Bewertung Selbstbewertung Feldtyp: String mit bis zu 24 Zeichen (VARCHAR)
Abschnitts-ID	Eindeutige Kennung des Abschnitts im Bewertungsformular. Feldtyp: NUMBER (38,0)
Abschnittstitel	Der Name des Abschnitts im Auswertungsformular. Feldtyp: String mit bis zu 2048 Zeichen (VARCHAR)
Bewertbar	Richtig oder falsch, wenn die Frage bewertet werden konnte. Feldtyp: BOOLEAN
Tatsächliche Punktzahl	Die Punktzahl, die der Agent für die Frage erhalten hat. Feldtyp: FLOAT
Abschnitt Punktzahl (%)	Die prozentuale Punktzahl des Abschnitts, in dem sich die Frage befand. Feldtyp: FLOAT
Max. Score	Die maximale Punktzahl, die ein Agent für die Frage erhalten haben könnte. Feldtyp: FLOAT
Agenten-ID	Eindeutige Kennung des Agenten. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Vorname (Agent)	Vorname des bewerteten Agenten. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Nachname (Agent)	Nachname des bewerteten Agenten. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Team-ID	Die eindeutige Kennung des Agententeams. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Teamname	Name des Agententeams. Feldtyp: String mit bis zu 50 Zeichen (VARCHAR)
Vorname (Eva)	Vorname des Bewerters. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Nachname (Eva)	Nachname des Bewerters. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Kritisch	True oder False für die Frage, ob die Frage eine kritische Frage war. Feldtyp: BOOLEAN
Fehlgeschlagene kritische Frage	Wenn der Wert „true“ ist, bedeutet dies, dass der Benutzer eine kritische Frage nicht bestanden hat und die Bewertung des Bewertungsformulars auf Null gesetzt ist. Wenn der Wert „false“ ist, bedeutet dies, dass der Benutzer die Frage richtig beantwortet hat. Feldtyp: BOOLEAN
Obligatorisch	Richtig- oder Falsch-Markierung, wenn die Frage obligatorisch war. Feldtyp: BOOLEAN
Fragentyp	Der Typ der Frage: Optionsschaltfläche Ja/Nein Kontrollkästchen Drop-down Datum/Uhrzeit Feldtyp: String mit bis zu 64 Zeichen (VARCHAR)
Segment-ID	Die Segment-ID der zu bewertenden Interaktion. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Startdatum der Interaktion	Start-Datum/Uhrzeit (in UTC) der Interaktion. Feldtyp: TIMESTAMP_LTZ(6)
Enddatum der Interaktion	Enddatum-Uhrzeit (in UTC) der Interaktion. Feldtyp: TIMESTAMP_LTZ(6)
WorkflowInstance-ID	Die eindeutige Kennung für die Bewertung. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Bewertungspunktzahl (%)	Die prozentuale Punktzahl der Bewertung. Feldtyp: FLOAT
Bank-ID	Eindeutige Kennung der Fragenbank, in der sich die Frage befindet. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Ausgeblendeter Name	True (Richtig) blendet die Fragen aus; False (Falsch) blendet sie ein. Bei Verwendung der QM-Fomularregel in einem Qualitätsformular werden damit Folgefragen auf der Grundlage der Punktzahl der vorherigen Frage ausgeblendet. Feldtyp: BOOLEAN API-Version: 2 und höher

QM-Bewerteranmerkungen und CSV-Datei

Mit der QM-Bewerteranmerkungen-API können Sie Anmerkungen von QM-Bewertern extrahieren.

Für den POST-Job:

entityName ist: qm-evaluation-comment-entity
version ist: 1

Die Daten werden entsprechend Einreichungsdatum gefiltert (in UTC).

Felder in der CSV-Datei mit QM-Bewerteranmerkungen

Spaltenname	Beschreibung
Kommentar-ID	Die eindeutige Kennung des Kommentars. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Kommentare	Der Text des Kommentars. Feldtyp: String mit bis zu 300 Zeichen (VARCHAR)
Kommentiert um	Datum und Uhrzeit, zu der der Kommentar hinzugefügt wurde. Feldtyp: TIMESTAMP_LTZ(3)
Aktivität	Der Name der Bewertungsaktion, als der Kommentar hinzugefügt wurde. Feldtyp: String mit bis zu 50 Zeichen (VARCHAR)
Kommentar von ID	Die eindeutige Kennung des Benutzers, der den Kommentar hinzugefügt hat. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Kommentar von Vorname	Vorname des Benutzers, der den Kommentar hinzugefügt hat. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Kommentar von Nachname	Nachname des Benutzers, der den Kommentar hinzugefügt hat. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Fragen-ID	Die eindeutige Kennung der Frage. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Fragetitel	Der Text der Frage. Feldtyp: String mit bis zu 2048 Zeichen (VARCHAR)
Formular-ID	Die eindeutige Kennung des Bewertungsformulars. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Formularname	Der Name des Formulars, das für die Bewertung verwendet wurde. Feldtyp: String mit bis zu 256 Zeichen (VARCHAR)
Von Version	Die Version des Bewertungsformulars, das für diese Bewertung verwendet wurde. Feldtyp: NUMBER (4,0)
Arbeitsablauf-ID	Die eindeutige Kennung für die Bewertung. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Workflow-Status	Der Status des Arbeitsablaufs. Feldtyp: String mit bis zu 128 Zeichen (VARCHAR)
Agenten-ID	Die eindeutige Kennung des Agenten. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Vorname (Agent)	Der Vorname des Agenten. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Nachname (Agent)	Der Nachname des Agenten. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Team-ID	Die eindeutige Kennung des Agententeams. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Teamname	Name des Agententeams. Feldtyp: String mit bis zu 50 Zeichen (VARCHAR)

Interaktionsmetadaten-Entität und CSV-Datei

Mit der Interaktionsmetadaten-API können Sie Recording Interaktionsmetadaten extrahieren.

Für den POST-Job:

entityName ist: recording-interaction-metadata
Version ist: 10
Um Daten nach Datum und Uhrzeit zu filtern, verwenden Sie startDate und endDate in UTC im Format jjjj-mm-tt hh:mm:ss

Felder in der CSV-Datei mit Interaktionsmetadaten

Spaltenname	Beschreibung
ACD-Anruf-ID (z. B. Hauptkontakt-ID)	Die ACD-Call-ID hängt von der ACD-Lösung ab, z. B. ist dies die gleiche wie die CXone Mpower Master-Kontakt-ID Die Master- oder übergeordnete ID für einen oder mehrere verwandte Kontakte. Eine neue Haupt-Kontakt-ID wird zugewiesen, wenn ein Kontakt drei Mal oder öfter weitergeleitet wird.. Feldtyp: Zahl mit bis zu 38 Ziffern
Segment-ID	Eindeutige Kennung des Segments. Ein Segment ist eine Interaktion mit zwei Parteien, wie z. B. Kunde und Agent. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR UUID)
Segment Startgrund	Grund für den Beginn des Segments: Konferenz IVR Segment: Erstes Segment im Kontakt Weiterleiten Kontakt Eskaliert An externe Nummer weitergeleitet Externe Weiterleitung Feldtyp: String mit bis zu 100 Zeichen (VARCHAR)
Segmentende Grund	Grund für das Ende des Segments: Konferenz IVR Segment: Letztes Segment im Kontakt Weiterleiten Kontakt Eskaliert An externe Nummer weitergeleitet Externe Weiterleitung Feldtyp: String mit bis zu 100 Zeichen (VARCHAR)
Richtung	Richtung des Segments: Eingehend Ausgehend Intern Unbekannt Feldtyp: String mit bis zu 150 Zeichen (VARCHAR)
Startdatum	Startdatum und -zeit (in UTC) des Segments. Feldtyp: TIMESTAMP
Enddatum	Enddatum und -zeit (in UTC) des Segments. Feldtyp: TIMESTAMP
Kanaltyp	Art der Interaktion: Sprache Chat E-Mail IVR Arbeitselement SMS Messaging-Kanäle: Facebook Messenger, WhatsApp, Apple Messages for Business, (Apple Business Chat), LINE Messaging,Telegram Messenger, Viber Messenger, Benutzerdefiniert, Microsoft Teams, Slack. Öffentliche soziale Kanäle: Facebook, Google Orte, Google Play,LinkedIn, YouTube, Apple Apps Rezensionen, Benutzerdefiniert (öffentlich). Feldtyp: String mit bis zu 150 Zeichen (VARCHAR)
Bildschirmaufzeichnung	Wenn das Segment eine Bildschirmaufnahme enthält: Ja Nein
Sprachaufnahmestatus	Status der Aufnahme: Erfolg Teilaufzeichnung: Teile dieses Segments wurden nicht aufgezeichnet, aber die Interaktion kann trotzdem wiedergegeben werden Entspricht keiner Richtlinie: Keine Aufzeichnung – keine der Aufzeichnungsrichtlinien wurde durch diese Interaktion ausgelöst Aufgrund des Aufzeichnungsprozentsatzes nicht aufgezeichnet: Keine Aufzeichnung – durch diese Interaktion wurde eine Aufzeichnungsrichtlinie ausgelöst, die jedoch aufgrund des in der Richtlinie definierten Aufzeichnungsprozentsatzes nicht aufgezeichnet wurde. Richtlinie „Nicht aufzeichnen“: Keine Aufzeichnung – für diese Interaktion wurde eine Richtlinie „Nicht aufzeichnen“ ausgelöst. Verweigerte Zustimmung in IVR: Keine Aufzeichnung Fehlgeschlagen: Keine Aufzeichnung Maskiert: Keine Aufnahme – die Aufnahme wurde maskiert Datensatzübertragung an externe Nummer nicht ausgewählt: Keine Aufzeichnung Aufnehmbar (Sprache) nicht ausgewählt: Keine Aufzeichnung - Das Agentenattribut Aufnehmbar (Sprache) wurde nicht ausgewählt. Feldtyp: String mit bis zu 250 Zeichen (VARCHAR)
Bildschirmaufnahmestatus	Status der Aufnahme: Erfolg Teilaufzeichnung: Teile dieses Segments wurden nicht aufgezeichnet, aber die Interaktion kann trotzdem wiedergegeben werden Entspricht keiner Richtlinie: Keine Aufzeichnung – keine der Aufzeichnungsrichtlinien wurde durch diese Interaktion ausgelöst Aufgrund des Aufzeichnungsprozentsatzes nicht aufgezeichnet: Keine Aufzeichnung – durch diese Interaktion wurde eine Aufzeichnungsrichtlinie ausgelöst, die jedoch aufgrund des in der Richtlinie definierten Aufzeichnungsprozentsatzes nicht aufgezeichnet wurde. Richtlinie „Nicht aufzeichnen“: Keine Aufzeichnung – für diese Interaktion wurde eine Richtlinie „Nicht aufzeichnen“ ausgelöst. Verweigerte Zustimmung in IVR: Keine Aufzeichnung Fehlgeschlagen: Keine Aufzeichnung Maskiert: Keine Aufnahme – die Aufnahme wurde maskiert Feldtyp: String mit bis zu 250 Zeichen (VARCHAR)
Aufzeichnungswarnungen	Zu den Aufzeichnungsbenachrichtigungen gehören: ScreenAgent ist nicht erreichbar: ScreenAgent ist nicht richtig konfiguriert oder wird nicht ausgeführt. Fehler bei der Bildschirmaufzeichnung: Anruf möglicherweise nicht vollständig aufgezeichnet Fehler bei Bildschirmaufzeichnung ScreenAgent-Maschinenkonfigurationsfehler Keine Verbindung zwischen ScreenAgent und den Bildschirmen des Agenten Fehler bei der Netzwerkkonfiguration des ScreenAgent-Computers ScreenAgent hat aufgrund der Computerkonfiguration nicht mit der Aufzeichnung begonnen ScreenAgent konnte die Aufzeichnung aufgrund der Konfiguration des selbstsignierten Zertifikats nicht hochladen Festplattenkonfigurationsfehler des ScreenAgent-Computers ScreenAgent hat die maximale Anzahl paralleler Anrufe erreicht Die Bildschirmaufzeichnung hat die maximale Anrufdauer erreicht Siehe ScreenAgent-Probleme beheben. Aufnahme zu kurz: Die Bildschirmaufnahme ist zu kurz. Der Ton ist kürzer als 4 Sekunden und wird möglicherweise nicht aufgezeichnet. Keine Verbindung zum Medienserver: Es gab ein Problem mit dem Medienserver, weshalb keine Aufnahme verfügbar war. Dieser Fehler kann verschiedene Ursachen haben. Die Fehlerbeschreibung zum Aufzeichnungsalarm enthält genauere Informationen. Bei der Lösung Multi-ACD (Open) weist dieser Fehler auf fehlende SIP-Ereignisse vom Kunden hin. Dies kann bedeuten, dass entweder die gesamte Einladung fehlt oder nur eine Seite (Nearend oder Farend) empfangen wird. Die Sprachaufzeichnungsfunktion konnte den Anruf nicht aufzeichnen: Keine Aufzeichnung. Es lag ein Problem mit der Sprachaufzeichnungsfunktion vor. Dies kann mehrere Gründe haben. Die Fehlerbeschreibung für die Aufzeichnungswarnung liefert genauere Informationen. Audio nicht verfügbar: unvollständige Audiodaten: Audio ist für diese Interaktion nicht verfügbar (unvollständige Audiodaten). Kontaktieren Sie den CXone Mpower-Support. Audio nicht verfügbar: fehlende Audiopakete: Audio ist für diese Interaktion nicht verfügbar (fehlende Audiopakete). Kontaktieren Sie den CXone Mpower-Support. Audio nicht verfügbar: fehlende Audiopakete aus externer Quelle: (CR-Funktion) Audio ist für diese Interaktion nicht verfügbar (fehlende Audiopakete im Medienstream). Kontaktieren Sie den CXone Mpower-Support. Systemfehler: Die Aufzeichnung wurde nicht gestartet oder es lag ein anderer allgemeiner Fehler vor. Kontaktieren Sie den CXone Mpower-Support. Maskierung fehlgeschlagen: Die Aufnahme wurde nicht maskiert. Sie können die Aufnahme abspielen, um zu prüfen, ob sensible Daten vorhanden sind. Um die Aufzeichnung zu löschen, klicken Sie auf Aktion und wählen Sie Aufzeichnungen löschen. Aufzeichnung auf Wunsch gestoppt: Aufzeichnung wurde vom Benutzer gestoppt.
Name der Richtlinie	Name der Aufzeichnungsrichtlinie oder Nicht-Aufzeichnungsrichtlinie, die auf diese Interaktion angewendet wurde. Feldtyp: String mit bis zu 100 Zeichen (VARCHAR)
ANI	Bei eingehenden Anrufen ist ANI die Telefonnummer des Anrufers (Anrufer-ID). Feldtyp: String mit bis zu 200 Zeichen (VARCHAR)
DNIS	Bei eingehenden Anrufen ist DNIS die angerufene Telefonnummer (gewählte Nummer). Feldtyp: String mit bis zu 200 Zeichen (VARCHAR)
ACW (in Sekunden)	Wie viele Sekunden wurde die Bildschirmaufnahme nach Beendigung des Anrufs fortgesetzt, um die Arbeit des Agenten nach dem Anruf zu erfassen.
Disposition	Der Tag, die der Agent mit zusätzlichen Informationen zum Anruf zuweist.
Externe Segment-ID	Die ID eines Segments, wie in der externen Quelle der Aufzeichnung definiert. Werte sind nur für Benutzer mit AppLink verfügbar. Feldtyp: String mit bis zu 100 Zeichen (VARCHAR) API-Version: 6 und höher
Externe Kontakt-ID	Die ID eines Kontakts, wie in der externen Quelle der Aufzeichnung definiert. Werte sind nur für Benutzer mit AppLink verfügbar. Feldtyp: String mit bis zu 100 Zeichen (VARCHAR) API-Version: 6 und höher
Quelle	Die Quelle der Aufnahme-CXone Mpower oder eine externe Quelle. Werte: Engage BrandEmbassy Uptivity InContactACD Multi-ACD MigratedCallsExternal MigratedCallsEngage MigratedCallsNim SmartReach Feldtyp: String mit bis zu 30 Zeichen (VARCHAR) API-Version: 6 und höher
Zugehörige Kontakt-ID-Liste	Liste der Kontaktnummern von Agenten, die mit diesem Segment verknüpft sind. Die Elemente diese Liste bestehen nur aus Zahlen. Feldtyp: Variante API-Version: 7 und höher
Interaktions-ID	Eine eindeutige Kennung (UUID) für eine Interaktion. Wenn mit einer einzelnen Interaktion mehrere Segmente verknüpft sind, können die Segmente dieselbe Interaktions-ID haben. Die Interaktions-ID ist nicht dasselbe wie die Segment-ID oder die Kontakt-ID. Feldtyp: String mit bis zu 36 Zeichen (VARCHAR) API-Version: 7 und höher
Anzahl "Halten"	Die Gesamtzahl der Male, die der Agent den Kunden während eines Anrufs in die Warteschleife gesetzt hat. API-Version: 8 und höher
Haltedauer in Sekunden	Die Gesamtzahl der Sekunden, die der Kunde während eines Anrufs in der Warteschleife war (die Summe aller Warteschleifen). API-Version: 8 und höher
Komplexer Anruf	Gibt an, ob an einem Anruf mehrere Teilnehmer teilnahmen. Feldtyp: Boolesche Werte bestehend aus WAHR oder FALSCH (BOOLEAN) API-Version: 9 und höher
Maskierungsstatus der Sprachaufzeichnung	Zeigt den Status der Sprachaufzeichnungsmaskierung für eine Interaktion an. Feldtyp: Zeichenkette API-Version: 10 und höher Mögliche Werte sind: Erfolg: Sprachaufzeichnung wurde erfolgreich maskiert Fehler: Sprachaufzeichnungsmaskierung fehlgeschlagen Partiell: Die Sprachaufzeichnung wurde teilweise maskiert NA: Nicht zutreffend
Maskierungsstatus der Bildschirmaufzeichnung	Zeigt den Status der Bildschirmaufzeichnungsmaskierung für eine Interaktion an. Feldtyp: Zeichenkette API-Version: 10 und höher Mögliche Werte sind: Erfolg: Bildschirmaufnahme wurde erfolgreich maskiert Fehler: Bildschirmaufzeichnungsmaskierung fehlgeschlagen Partiell: Die Bildschirmaufnahme wurde teilweise maskiert NA: Nicht zutreffend
Benutzer-ID des Agenten	Dem Agenten zugewiesene eindeutige Kennung. Die CSV-Datei enthält dieses Feld als separate Spalte für jeden Agenten und unterstützt bis zu 5 Agenten. Beispielhafte Spaltennamen: `Agent 1 User ID, Agent 2 User ID, ..., Agent 5 User ID` Feldtyp: String mit bis zu 36 Zeichen (VARCHAR)
Agenten-ACD-ID	Eindeutige Kennung, die dem Agenten von der ACD zugewiesen wurde. Die CSV-Datei enthält dieses Feld als separate Spalte für jeden Agenten und unterstützt bis zu 5 Agenten. Beispielhafte Spaltennamen: `Agent 1 ACD ID, Agent 2 ACD ID, ..., Agent 5 ACD ID` Feldtyp: String mit bis zu 50 Zeichen (VARCHAR)
Agenten-Kontaktnummer	Eindeutiger Bezeichner des für diesen Agenten erstellten Kontakts. Dieses Feld ist für Multi-ACD (Open) nicht verfügbar. Die CSV-Datei enthält dieses Feld als separate Spalte für jeden Agenten und unterstützt bis zu 5 Agenten. Beispielhafte Spaltennamen: `Agent 1 Contact Number, Agent 2 Contact Number, ..., Agent 5 Contact Number` Feldtyp: Zahl mit bis zu 38 Ziffern API-Version: 5 und höher
Name des Agenten	Der Name des Agenten, wie im CXone Mpower-Mitarbeiterkonto festgelegt. Die CSV-Datei enthält dieses Feld als separate Spalte für jeden Agenten und unterstützt bis zu 5 Agenten. Beispielhafte Spaltennamen: `Agent 1 Name, Agent 2 Name, ..., Agent 5 Name` Feldtyp: String mit bis zu 100 Zeichen (VARCHAR)
Agent Team ID	Dem Agenten-Team zugewiesene eindeutige Kennung. Die CSV-Datei enthält dieses Feld als separate Spalte für jeden Agenten und unterstützt bis zu 5 Agenten. Beispielhafte Spaltennamen: `Agent 1 Team ID, Agent 2 Team ID, ..., Agent 5 Team ID` Feldtyp: String mit bis zu 36 Zeichen (VARCHAR UUID)
Agent-Team	Name des Agententeams. Die CSV-Datei enthält dieses Feld als separate Spalte für jeden Agenten und unterstützt bis zu 5 Agenten. Beispielhafte Spaltennamen: `Agent 1 Team, Agent 2 Team, ..., Agent 5 Team` Feldtyp: String mit bis zu 40 Zeichen (VARCHAR)
Agentenskills	Eine Klassifizierung, die abhängig von Skills, Spezialgebieten und Fachwissen dem Agenten zugewiesen wird. Die CSV-Datei enthält dieses Feld als separate Spalte für jeden Agenten und unterstützt bis zu 5 Agenten. Beispielhafte Spaltennamen: `Agent 1 Skills, Agent 2 Skills, ..., Agent 5 Skills` Feldtyp: String mit bis zu 50 Zeichen (VARCHAR)
Name der Geschäftsdaten	Name des Geschäftsdatenfelds wie angegeben. Die CSV-Datei enthält dieses Feld als separate Spalte für jeden Geschäftsdatensatz: Für API-Versionen 7 bisunterstützt die Datei bis zu 50 Einträge: 35 varchar, 10 numerisch und 5 boolesch. Für die API-Version 11, die Kunden im Rahmen des Programms Controlled Release (CR) zur Verfügung steht, unterstützt die Datei bis zu 250 Einträge: 1-35 varchar, 36-45 numeric, 46-65 Boolean, 66-95 date, 96-210 varchar, 211-250 numeric Beispielspaltennamen: `Business Data Name 1, Business Data Name 2, ..., Business Data Name 50` (oder bis zu `Business Data Name 250` für CR) Feldtyp: String mit bis zu 128 Zeichen (VARCHAR) API-Version: 7 und höher
Geschäftsdatenwert	Der Wert der Geschäftsdaten kann ein Text, ein numerischer Wert oder wahr/falsch sein. Die CSV-Datei enthält dieses Feld als separate Spalte für jeden Geschäftsdatensatz: Für API-Versionen 7 bisunterstützt die Datei bis zu 50 Einträge: 35 varchar, 10 numerisch und 5 boolesch. Für die API-Version 11, die Kunden im Rahmen des Programms Controlled Release (CR) zur Verfügung steht, unterstützt die Datei bis zu 250 Einträge: 1-35 varchar, 36-45 numeric, 46-65 Boolean, 66-95 date, 96-210 varchar, 211-250 numeric Beispielspaltennamen: `Business Data Value 1, Business Data Value 2, ..., Business Data Value 50` (oder bis zu `Business Data Value 250` für CR) Feldtyp: String mit bis zu 4000 Zeichen (VARCHAR) Numerischer Wert mit bis zu 38 Ziffern (ZAHL) Boole'sche Werte vom Typ TRUE oder FALSE (BOOLEAN) Datumswerte im unterstützten Format (DATUM) API-Version: 7 und höher Aktualisierungen von Geschäftsdaten, die mehr als 2 Tage nach Erstellung der Interaktion vorgenommen wurden, sind nicht in der Ausgabe der Data Extract API enthalten.

WFM Lohnbuchhaltung Entität und CSV-Datei

Die WFM Payroll API (Version 1) ermöglicht es Ihnen, WFM Aktivitätsdaten für externe Lohnabrechnungsberichte zu extrahieren.

Der WFM Payroll-Entitätsname für den POST-Auftrag lautet: wfm-payroll.

Die Daten werden nach dem Datum des Abrechnungscodes gefiltert. Beachten Sie, dass die Zeitzone für Datum und Uhrzeit der Zeitzone des Terminplaners entspricht.

Felder in der WFM Payroll CSV-Datei

Spaltenname	Beschreibung
Vorname	Vorname des Agenten. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Nachname	Nachname des Agenten. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Benutzername	Der Benutzername des Agenten. Feldtyp: String mit bis zu 255 Zeichen (VARCHAR)
Planungseinheit	Terminierungseinheit des Agenten. Feldtyp: String mit bis zu 256 Zeichen (VARCHAR)
Zeitzone der Planungseinheit	Zeitzone der Zeitplanungseinheit des Agenten. Feldtyp: String mit bis zu 128 Zeichen (VARCHAR)
Code der Gehaltsabrechnung	Der Abrechnungscode, der die geplanten Aktivitätsdaten enthält. Feldtyp: String mit bis zu 50 Zeichen (VARCHAR)
Datum	Datum (in der Zeitzone der Planungseinheit) der Aktivität. Feldtyp: DATE
Startzeit	Startzeit (in der Zeitzone der Planungseinheit) der Aktivität. Feldtyp: TIME (9)
Dauer in Sekunden	Die Dauer der Aktivität in Sekunden. Feldtyp: NUMBER (8,0)