API's voor handmatig opnemen

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

Met deze API's kunt u gespreksopnames handmatig starten, stoppen en uitschakelen, waardoor opnamebeheer via API mogelijk is.

Documentatie voor de Record on Demand API's is beschikbaar in de Developer Community portal .

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 is bovendien de toestemming Interactions Hub >API's > Multi-ACD Record on Demand API vereist.

Start met opnemen op aanvraag

Met de API kan een agent of applicatie starten met opnemen van een actieve oproep voor een specifieke gebruiker. Het kan worden gebruikt om specifieke interacties of conversaties vast te leggen, die relevant zijn voor nalevingsdoeleinden, kwaliteitscontrole of training.

U kunt opgeven of u het opnemen wilt starten van alleen spraak of van zowel spraak als scherm. Deze API-methode heeft prioriteit boven opnamebeleid.

De vlag mediaType is optioneel en hiermee kunt u beheren welke mediatypen worden opgenomen. Ondersteunde waarden zijn voice en voiceAndScreen, en hiermee kunt u het opnemen starten van alleen spraak of zowel spraak als scherm. Als de vlag niet wordt doorgegeven, is spraak de standaardwaarde.

Methode: POST

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

Parameter:

userId*:

string

Het mediatype dat moet worden opgenomen.

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

Respons

  • Status 200-Succesvolle bewerking. Het verzoek voor starten van handmatig opnemen is begonnen.

  • Status 202-Bewerking in uitvoering. Het verzoek voor starten van handmatig opnemen is geaccepteerd en wordt verwerkt.

  • Status 400-Slechte 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 409 - Het verzoek kan niet worden uitgevoerd vanwege de servicestatus.

  • Status 425 - De interactie is vergrendeld tijdens het verwerken van een eerdere Record on demand/Stop on demand-aanvraag

  • Status 500-Interne serverfout.

  • Status 504 - De aanvraag is verlopen.

Stop met opnemen op aanvraag

Met de API is het mogelijk de opname van spraak en het scherm van een actieve oproep voor een specifieke gebruiker te stoppen. Het kan worden gebruikt om privacy van klanten te beschermen of om te voldoen aan reguleringen voor het beperken van de opname van bepaalde typen conversaties.

Deze API-methode geeft prioriteit aan Recording-beleid. Post. Handmatig opnemen stoppen kan alleen worden hervat door Handmatig opnemen starten aan te roepen.

Methode: POST

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

Parameter:

userId*:

string

Gebruikers-ID van agent die moet worden opgenomen.

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

Respons

  • Status 200-Succesvolle bewerking. Het verzoek voor het stoppen van handmatig opnemen is begonnen.

  • Status 202-Bewerking in uitvoering. Het verzoek voor het stoppen van handmatig opnemen is geaccepteerd en wordt verwerkt.

  • 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 409 - Het verzoek kan niet worden uitgevoerd vanwege de servicestatus.

  • Status 425 - De interactie is vergrendeld tijdens het verwerken van een eerder Record on demand/Stop on demand-verzoek.

  • Status 500-Interne serverfout.

  • Status 504 - De aanvraag is verlopen.

Schakel de optie om het gesprek op te nemen uit

Met de API kunt u de optie uitschakelen om spraak en het scherm van een oproep op te nemen in het geval de klant toestemming afwijst en niet akkoord gaat met opname. Dit is met name relevant voor de Europese Algemene Verordening Gegevensbescherming (AVG). Als een klant geen toestemming geeft, neemt CXone Mpower Recording het gesprek niet op, zelfs niet als er een opnamebeleid is ingesteld om het gesprek op te nemen, of als de agent het gesprek op aanvraag opneemt of via een API.

Post. De API-gespreksopname kan niet worden gestart voor het hele klantcontact, inclusief doorschakelen, overleg en conferentiegesprekken. Als de API werd aangeroepen terwijl de gespreksopname bezig was, stopt Recording de opname. Het opgenomen gedeelte van het gesprek is dan beschikbaar voor zoeken en afspelen.

Opnametoestemming is alleen van toepassing op de huidige oproep. Deze wordt niet opgeslagen voor de klant voor toekomstige interacties.

Methode: POST

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

Parameter:

userId*:

string

Gebruikers-ID van agent die moet worden opgenomen.

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

Respons

  • Status 200-Succesvolle bewerking. Het verzoek om niet op te nemen is gestart.

  • Status 202-Bewerking in uitvoering. Het verzoek om niet op te nemen, is geaccepteerd en wordt verwerkt.

  • 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 409 - Het verzoek kan niet worden uitgevoerd vanwege de servicestatus.

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

  • Status 500-Interne serverfout.

  • Status 504 - De aanvraag is verlopen.