APIs zur Aufzeichnung bei Bedarf

Diese API steht Benutzern des Engagement Hub mit Sprach- oder Bildschirmaufzeichnungsfunktion zur Verfügung.

Diese APIs ermöglichen das Starten, Beenden und Deaktivieren der Anrufaufzeichnung bei Bedarf,d. h. die Steuerung der Aufzeichnung erfolgt über APIs.

Die Dokumentation für die Record on Demand APIs ist im Developer Community Portal verfügbar.

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 tenantGeschlossen 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 API ist außerdem die Berechtigung Interactions Hub >APIs > Multi-ACD Record on Demand API erforderlich.

Aufnahme bei Bedarf starten

Die API ermöglicht einem Agenten oder einer Anwendung, die Aufzeichnung eines laufenden Anrufs für einen bestimmten Benutzer zu starten. Sie kann verwendet werden, um bestimmte Interaktionen oder Gespräche für Konformitäts-, Qualitätssicherungs- oder Schulungszwecke aufzuzeichnen.

Sie können festlegen, ob die Aufzeichnung nur für Sprache oder für Sprache und Bildschirm gestartet wird. Diese API hat Vorrang vor Aufzeichnungsrichtlinien.

Das Flag mediaType ist optional und ermöglicht die Steuerung der aufzuzeichnenden Medientypen. Die unterstützten Werte sind voice und voiceAndScreen, die es ermöglichen, die Aufzeichnung nur für Sprache oder für Sprache und Bildschirm zu starten. Wenn das Flag nicht angegeben ist, lautet der Standardwert voice.

Methode: POST

Endpunkt: /interaction-recording-management-service/interactions/start-recording-on-demand

Parameter:

userId*:

String

Der aufzuzeichnende Medientyp.

POST /interaction-recording-management-service/interactions/start-recording-on-demand?user-id=1234567

Antwort

  • Status 200 – Erfolgreich durchgeführte Operation. Die Anforderung zum Starten der Aufzeichnung bei Bedarf wurde gestartet.

  • Status 202 – Operation läuft. Die Anforderung zum Starten der Aufzeichnung bei Bedarf wurde akzeptiert und wird verarbeitet.

  • Status 400 – Ungültige Anfrage

  • Status 401 – Der anfragende Benutzer konnte sich nicht authentifizieren.

  • Status 403 – Der anfordernde Benutzer ist nicht berechtigt, den Vorgang auszuführen.

  • Status 404 – Nicht gefunden. Es wurden keine aktiven Interaktionen gefunden.

  • Status 409 – Die Anfrage kann aufgrund des Dienststatus nicht ausgeführt werden.

  • Status 425 - Die Interaktion ist während der Verarbeitung einer vorherigen Record on demand/Stop on demand-Anforderung gesperrt.

  • Status 500 – Interner Serverfehler.

  • Status 504 – Die Anfrage ist abgelaufen.

Aufzeichnung auf Anfrage beenden

Die API ermöglicht das Beenden der Sprache- und Bildschirmaufzeichnung eines laufenden Anrufs für einen bestimmten Benutzer. Sie kann für den Datenschutz des Kunden oder zur Einhaltung von Vorschriften verwendet werden, die die Aufzeichnung bestimmter Gesprächsarten einschränken.

Diese API-Methode gibt Vorrang vor Recording-Richtlinien. Nach dem Aufruf der API zum Beenden der Aufzeichnung bei Bedarf kann die Aufzeichnung nur durch Aufruf der API Aufzeichnung bei Bedarf starten fortgesetzt werden.

Methode: POST

Endpunkt: /interaction-recording-management-service/interactions/stop-recording-on-demand

Parameter:

userId*:

String

Benutzer-ID des Agenten, der aufgezeichnet werden soll.

POST /interaction-recording-management-service/interactions/stop-recording-on-demand?user-id=1234567

Antwort

  • Status 200 – Erfolgreich durchgeführte Operation. Die Anforderung zum Beenden der Aufzeichnung bei Bedarf wurde gestartet.

  • Status 202 – Operation läuft. Die Anforderung zum Beenden der Aufzeichnung bei Bedarf wurde akzeptiert und wird verarbeitet.

  • Status 400 – Ungültige Anfrage.

  • Status 401 – Der anfragende Benutzer konnte sich nicht authentifizieren.

  • Status 403 – Der anfordernde Benutzer ist nicht berechtigt, den Vorgang auszuführen.

  • Status 404 – Nicht gefunden. Es wurden keine aktiven Interaktionen gefunden.

  • Status 409 – Die Anfrage kann aufgrund des Dienststatus nicht ausgeführt werden.

  • Status 425 – Die Interaktion ist während der Verarbeitung einer vorherigen Record-on-Demand-/Stop-on-Demand-Anforderung gesperrt.

  • Status 500 – Interner Serverfehler.

  • Status 504 – Die Anfrage ist abgelaufen.

Deaktivieren Sie die Option zum Aufzeichnen des Anrufs.

Diese API ermöglicht die Deaktivierung der Option zur Aufzeichnung von Sprache und Bildschirm eines Anrufs für den Fall, dass der Kunde seine Einwilligung ablehnt und der Aufzeichnung nicht zustimmt. Dies gilt insbesondere für die EU-Datenschutzgrundverordnung (DSGVO). Wenn ein Kunde seine Zustimmung verweigert, wird CXone Mpower Recording das Gespräch nicht aufzeichnen, selbst wenn eine Aufzeichnungsrichtlinie zur Aufzeichnung des Gesprächs festgelegt ist oder wenn der Agent das Gespräch auf Anfrage bzw. mithilfe der API aufzeichnet.

Die API zur Deaktivierung der Anrufaufzeichnung kann nicht für den gesamten Kundenkontakt, einschließlich Weiterleitungen, Rücksprachen und Konferenzen, initiiert werden. Wenn die API während der Anrufaufzeichnung aufgerufen wurde, stoppt Recording die Aufzeichnung. Der aufgezeichnete Teil des Anrufs steht dann für die Suche und Wiedergabe zur Verfügung.

Die Einwilligung zur Aufzeichnung gilt nur für den aktuellen Anruf. Sie wird nicht für zukünftige Interaktionen für den Kunden gespeichert.

Methode: POST

Endpunkt: /interaction-recording-management-service/interactions/do-not-record

Parameter:

userId*:

String

Benutzer-ID des Agenten, der aufgezeichnet werden soll.

POST /interaction-recording-management-service/interactions/do-not-record?user-id=1234567

Antwort

  • Status 200 – Erfolgreich durchgeführte Operation. Die "Nicht aufzeichnen“-Anforderung wurde gestartet.

  • Status 202 – Operation läuft. Die "Nicht aufzeichnen"-Anforderung wurde akzeptiert und wird verarbeitet.

  • Status 400 – Ungültige Anfrage.

  • Status 401 – Der anfragende Benutzer konnte sich nicht authentifizieren.

  • Status 403 – Der anfordernde Benutzer ist nicht berechtigt, den Vorgang auszuführen.

  • Status 404 – Nicht gefunden. Es wurden keine aktiven Interaktionen gefunden.

  • Status 409 – Die Anfrage kann aufgrund des Dienststatus nicht ausgeführt werden.

  • Status 425 – Die Interaktion ist gesperrt, während eine vorherige Anfrage verarbeitet wird.

  • Status 500 – Interner Serverfehler.

  • Status 504 – Die Anfrage ist abgelaufen.