APIs zur Aufzeichnung von Bildschirminteraktionen

Mithilfe einer API kann die Bildschirmaufzeichnung der Desktop-Aktivität gestartet werden. Dies ermöglicht die Aufzeichnung der Bildschirme der Agenten, wenn kein Kontakt stattfindet, sowie die Aufzeichnung von Back-Office-Bildschirmen.

Diese API ist für Multi-ACD (Open)- und CXone MpowerACD-Benutzer verfügbar.

Bevor Sie beginnen

Bevor Sie diese APIs verwenden können, richten Sie eine Benutzerberechtigung ein, generieren Sie einen Zugriffsschlüssel und befolgen Sie den Registrierungs- und Authentifizierungsprozess, der im Entwicklerportal erläutert wird.

Diese APIs erfordern die Berechtigung Bildschirminteraktion aufzeichnen des Interactions Hub.

POST Aufzeichnung der Bildschirminteraktion starten

Die API ermöglicht die Einleitung einer Bildschirmaufzeichnung für einen bestimmten Benutzer, der sich nicht in einem aktiven Gespräch 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 generiert oder die Aufzeichnungsdauer aktualisiert.

userId*:

String

ID des aufzuzeichnenden Benutzers.
Aufnahmedauer*:

number

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

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

Antworten

  • Status 200 – Vorgang erfolgreich.

    contactId (Nummer): Die ACD-Kontakt-ID

    interactionId (Zeichenfolge): Die globale Interaktions-ID

  • Status 202 – Vorgang wird ausgeführt.

    contactId (Nummer): Die ACD-Kontakt-ID

    interactionId (Zeichenfolge): Die globale Interaktions-ID

  • Status 400 – Ungültige Anfrage.

  • Status 401 – Die Authentifizierung des anfordernden Benutzers ist fehlgeschlagen.

  • 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 während der Verarbeitung einer vorherigen Anfrage gesperrt.

  • Status 500 – Interner Serverfehler.

  • Status 504 – Die Anforderung ist abgelaufen.

POST Aufzeichnung der Bildschirminteraktion beenden

Die API ermöglicht es, die Bildschirmaufzeichnung für die Kontakt-ID eines bestimmten Benutzers zu stoppen, 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. Wenn diese Methode nicht aufgerufen wird, wird die Bildschirmaufzeichnung nach der im Befehl „Start-Screen-Interaction-Recording“ angegebenen Dauer automatisch gestoppt.

userId*:

String

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

number

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

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

Antworten

  • Status 200 – Vorgang erfolgreich.

  • Status 202 – Vorgang wird ausgeführt.

  • Status 400 – Ungültige Anfrage.

  • Status 401 – Die Authentifizierung des anfordernden Benutzers ist fehlgeschlagen.

  • 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 während der Verarbeitung einer vorherigen Anfrage gesperrt.

  • Status 500 – Interner Serverfehler.

  • Status 504 – Die Anforderung ist abgelaufen.