APIs zur Aufzeichnung von Bildschirminteraktionen

Eine API kann verwendet werden, um die Bildschirmaufzeichnung von Desktop Aktivitäten zu initiieren. Dies ermöglicht die Aufzeichnung der Bildschirme von Agenten, wenn kein Kundenkontakt stattfindet, sowie die Aufzeichnung von Backoffice-Bildschirmen.

Diese API ist für Engagement Hub-Benutzer mit Sprach- oder Bildschirmaufzeichnungsfunktion und CXone MpowerACD-Benutzer 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.

Außerdem ist für die Nutzung dieser APIs die Berechtigung Interactions Hub Bildschirminteraktion aufzeichnen erforderlich.

Aufzeichnung der Interaktion mit dem Startbildschirm

Die API ermöglicht die Initiierung einer Bildschirmaufzeichnung für einen bestimmten Benutzer, der sich nicht in einem aktiven Anruf befindet. Sie müssen die Aufzeichnungsdauer festlegen, indem Sie sie als Parameter im Startbefehl angeben. Die Dauer sollte zwischen 5 Sekunden und 3:30 Stunden, der maximal zulässigen Zeit, liegen. Die Aufnahme wird automatisch gestoppt, wenn die Dauer erreicht ist. Darüber hinaus können Sie die Bildschirmaufzeichnung stoppen, indem Sie den Befehl „Stop-Screen-Interaction-Recording“ aufrufen.

  • Wenn die Aufzeichnung gestartet (angezeigt durch einen Antwortcode von 202) oder erfolgreich (angezeigt durch einen Antwortcode von 200) ist, wird die mit dem aufgezeichneten Bildschirm verknüpfte Kontakt-ID bereitgestellt. Diese Kontakt-ID sollte beim Ausgeben des Stopp-Befehls verwendet werden.

  • Die API kann während eines Live-Anrufs zwischen einem Agenten und einem Kunden genutzt werden, der aufgezeichnet werden kann. In solchen Fällen gibt es zwei unterschiedliche Aufzeichnungen – eine erfasst das Sprachgespräch und die andere basiert auf API-Interaktionen – die jeweils mit unterschiedlichen Kontakt-IDs verknüpft sind.

  • Wenn bei einem Live-Anruf eine Maskierung angewendet wird, wirkt sich dies auch auf eine API-Bildschirmaufzeichnungsinteraktion aus, die möglicherweise parallel aufgezeichnet wird.

  • Bei Verwendung der API kann es eine einzelne Instanz der Bildschirmaufzeichnung geben. Wenn der Bildschirm eines Agenten bereits über die API aufgezeichnet wird, wird bei nachfolgenden API-Aufrufen für denselben Agenten keine neue Bildschirmaufzeichnung erzeugt oder die Aufzeichnungsdauer aktualisiert.

Methode: POST

Endpunkt: /interaction-recording-management-service/v1/interactions/start-screen-interaction-recording

Parameter:

userId*:

(Abfrage)

String

ID des aufzuzeichnenden Benutzers.

Aufnahmedauer*:

(Abfrage)

number

Gibt die gewünschte Aufnahmedauer im Bereich von 5-13200 Sekunden an

POST /interaction-recording-management-service/interactions/start-screen-interaction-recording?user-id=1234567&recordingDuration=3000

Antworten

  • Status 200 – Erfolgreich durchgeführte Operation.

    Beschreibung (Zeichenkette): Die Beschreibung der Antwort.

    Kontakt-ID (Nummer): Die ACD-Kontakt-ID.

    interactionId (Zeichenkette): Die globale Interaktions-ID.

    httpStatus (Zeichenkette): Die HTTP-Statusbeschreibung.

  • Status 202 – Die Operation ist in Bearbeitung.

    Kontakt-ID (Nummer): Die ACD-Kontakt-ID.

    interactionId (Zeichenkette): Die globale Interaktions-ID.

    httpStatus (Zeichenkette): Die HTTP-Statusbeschreibung.

  • 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 425 – Die Interaktion ist gesperrt, während eine vorherige Anfrage verarbeitet wird.

  • Status 500 – Interner Serverfehler.

  • Status 504 – Die Anfrage ist abgelaufen.

Bildschirminteraktionsaufzeichnung stoppen

Die API ermöglicht es, die Bildschirmaufzeichnung für die Kontakt-ID eines bestimmten Benutzers zu beenden, die mit dem Befehl start-screen-interaction-recording gestartet wurde. Sie sollten die Kontakt-ID verwenden, die in der Antwort des Befehls „Start-Screen-Interaction-Recording“ bereitgestellt wird. Wird diese Methode nicht aufgerufen, wird die Bildschirmaufzeichnung nach Ablauf der im Befehl start-screen-interaction-recording angegebenen Dauer automatisch beendet.

Methode: POST

Endpunkt: /interaction-recording-management-service/v1/interactions/stop-screen-interaction-recording

Parameter:

userId*:

String

Die ID des aufgezeichneten Benutzers, der gestoppt werden soll.
contactId*:

number

Die im Startbildschirm-Aufzeichnungsbefehl zurückgegebene Kontakt-ID.

POST /interaction-recording-management-service/interactions/stop-screen-interaction-recording?user-id=1234567&contactId=1122334455

Antworten

  • Status 200 – Erfolgreich durchgeführte Operation.

  • Status 202 – Die Operation ist in Bearbeitung.

  • 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 425 – Die Interaktion ist gesperrt, während eine vorherige Anfrage verarbeitet wird.

  • Status 500 – Interner Serverfehler.

  • Status 504 – Die Anfrage ist abgelaufen.