API's voor scherminteractie-opname

Een API kan worden gebruikt om schermopname van desktop activiteit te starten. Hiermee is het mogelijk om de schermen van agenten op te nemen wanneer er geen contact gaande is en om de schermen van de backoffice op te nemen.

Deze API is beschikbaar voor Engagement Hub-gebruikers met spraak- of schermopnamefunctionaliteit en CXone MpowerACD-gebruikers.

Voordat u begint

U kunt CXone Mpower API's testen op de ontwikkelaarsportal . Meld u aan met een CXone Mpower-account, dan kunt u verzoeken doen met de tenantGesloten Een organisatorische eenheid op hoog niveau die wordt gebruikt om technische ondersteuning, facturering en globale instellingen voor uw CXone Mpower-systeem te beheren. van uw account.

Om de API's te kunnen gebruiken, moet u zich registreren bij NiCE. U ontvangt dan geldige inloggegevens die u voor authenticatie kunt gebruiken. Raadpleeg de pagina Aan de slag op de ontwikkelaarsportal voor instructies.

Voor het gebruik van deze API's is bovendien de machtiging Interactions Hub Scherminteractie opnemen vereist.

Start scherminteractie-opname

Met de API kunt u schermopnames maken voor een specifieke gebruiker die niet aan een actief gesprek deelneemt. U moet de opnameduur opgeven door deze als parameter in de startopdracht op te geven. De duur moet tussen de 5 seconden en 3:30 uur liggen, de maximaal toegestane tijd. De opname stopt automatisch wanneer de duur is bereikt. U kunt de schermopname ook stoppen door de opdracht stop-screen-interaction-recording uit te voeren.

  • Wanneer de opname is gestart (aangegeven door responscode 202) of succesvol is (aangegeven door responscode 200), wordt de contact-ID die aan het opgenomen scherm is gekoppeld, weergegeven. Deze contact-ID moet worden gebruikt wanneer u de Stop-opdracht geeft.

  • De API kan worden gebruikt tijdens een livegesprek tussen een agent en een klant, dat kan worden opgenomen. In dergelijke gevallen zijn er twee afzonderlijke opnamen: één die het gesprek vastlegt en de andere die is gebaseerd op API-interacties. Beide zijn gekoppeld aan verschillende contact-ID's.

  • Als maskering wordt toegepast op een livegesprek, heeft dit ook invloed op een API-schermopname-interactie die mogelijk parallel wordt opgenomen.

  • Bij gebruik van de API kan er slechts één keer een schermopname worden gemaakt. Als het scherm van een agent al via de API wordt opgenomen, wordt er bij eventuele volgende API-aanroepen voor diezelfde agent geen nieuwe schermopname gegenereerd en wordt de opnameduur niet bijgewerkt.

Methode: POST

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

Parameters:

userId*:

(vraag)

string

ID van de gebruiker die geregistreerd moet worden.

opnameduur*:

(vraag)

nummer

Geeft de vereiste opnameduur aan binnen het bereik van 5-13200 seconden

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

Reacties

  • Status 200-Succesvolle bewerking.

    beschrijving (tekenreeks): De beschrijving van het antwoord.

    contactId (nummer): De ACD-contact-ID.

    interactionId (tekenreeks): De globale interactie-ID.

    httpStatus (tekenreeks): De beschrijving van de HTTP-status.

  • Status 202-Bewerking is in uitvoering.

    contactId (nummer): De ACD-contact-ID.

    interactionId (tekenreeks): De globale interactie-ID.

    httpStatus (tekenreeks): De beschrijving van de HTTP-status.

  • Status 400-Onjuiste aanvraag.

  • Status 401 - De aanvragende gebruiker kon zich niet verifiëren.

  • Status 403 - De aanvragende gebruiker is niet geautoriseerd om de bewerking uit te voeren.

  • Status 404-Niet gevonden. Er zijn geen interactieve interacties gevonden.

  • Status 425 - De interactie is vergrendeld tijdens het verwerken van een eerder verzoek.

  • Status 500-Interne serverfout.

  • Status 504 - De aanvraag is verlopen.

Stop scherminteractie-opname

Met de API kunt u de schermopname voor de contact-ID van een specifieke gebruiker stoppen. Deze opname is gestart met de opdracht start-screen-interaction-recording. U moet de contact-ID gebruiken die is opgegeven in het antwoord op de opdracht start-screen-interaction-recording. Als deze methode niet wordt aangeroepen, wordt de schermopname automatisch gestopt na de duur die is opgegeven in de opdracht start-screen-interaction-recording.

Methode: POST

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

Parameters:

userId*:

string

De ID van de geregistreerde gebruiker die moet worden gestopt.
contact-ID*:

nummer

De contact-ID die is geretourneerd in de opdracht voor het opnemen van het startscherm.

POST /interactie-opname-beheer-service/interacties/stop-scherm-interactie-opname?gebruikers-id=1234567&contactId=1122334455

Reacties

  • Status 200-Succesvolle bewerking.

  • Status 202-Bewerking is in uitvoering.

  • Status 400-Onjuiste aanvraag.

  • Status 401 - De aanvragende gebruiker kon zich niet verifiëren.

  • Status 403 - De aanvragende gebruiker is niet geautoriseerd om de bewerking uit te voeren.

  • Status 404-Niet gevonden. Er zijn geen interactieve interacties gevonden.

  • Status 425 - De interactie is vergrendeld tijdens het verwerken van een eerder verzoek.

  • Status 500-Interne serverfout.

  • Status 504 - De aanvraag is verlopen.