API's voor handmatig opnemen

Deze API is alleen beschikbaar voor gebruikers van CXone Multi-ACD (CXone Open) .

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

Voordat u begint

Voordat u de API's Maskeren en Maskering opheffen kunt gebruiken, dient u eerst een gebruikersmachtiging in te stellen, een toegangssleutel te genereren en het registratie- en authenticatieproces te doorlopen dat wordt uitgelegd op Developers Portal.

Voor deze API zijn de machtigingen Zoeken en afspelen >API's > API Multi-ACD opnemen op aanvraag vereist.

POST Handmatig opnemen starten

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.

userId*:

string

Het mediatype dat moet worden opgenomen.

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

Respons

  • Status 200 — Gelukte bewerking. Het verzoek voor starten van handmatig opnemen is begonnen.

  • Status 202 — Bewerking is bezig. Het verzoek voor starten van handmatig opnemen is geaccepteerd en wordt verwerkt.

  • Status 400 — Ongeldig verzoek

  • Status 401 — De vragende gebruiker kan niet worden geverifieerd.

  • Status 403 — De vragende gebruiker is niet gemachtigd 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 wordt vergrendeld tijdens het verwerken van een eerder verzoek voor handmatig opnemen/stoppen

  • Status 500 — Interne serverfout.

  • Status 504 — Er is een time-out van de aanvraag opgetreden.

POST handmatig opnemen stoppen

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 heeft prioriteit boven opnamebeleid. Post. Handmatig opnemen stoppen kan alleen worden hervat door Handmatig opnemen starten aan te roepen.

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 — Gelukte bewerking. Het verzoek voor het stoppen van handmatig opnemen is begonnen.

  • Status 202 — Bewerking is bezig. Het verzoek voor het stoppen van handmatig opnemen is geaccepteerd en wordt verwerkt.

  • Status 400 — Ongeldig verzoek.

  • Status 401 — De vragende gebruiker kan niet worden geverifieerd.

  • Status 403 — De vragende gebruiker is niet gemachtigd 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 wordt vergrendeld tijdens het verwerken van een eerder verzoek voor handmatig opnemen/stoppen.

  • Status 500 — Interne serverfout.

  • Status 504 — Er is een time-out van de aanvraag opgetreden.

POST De optie om de oproep op te nemen uitschakelen

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, zal CXone Recording de oproep niet opnemen, zelfs niet als er opnamebeleid is ingesteld om de oproep op te nemen of als de agent de oproep handmatig of met een API opneemt.

Post. De API-gespreksopname kan niet worden gestart voor het hele klantcontact, inclusief doorschakelen, overleg en conferentiegesprekken. Als de API is aangeroepen terwijl gespreksopname bezig was, stopt CXone Recording de opname en komt het opgenomen deel van de oproep beschikbaar voor zoeken en afspelen.

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

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 — Gelukte bewerking. Het verzoek om niet op te nemen is gestart.

  • Status 202 — Bewerking is bezig. Het verzoek om niet op te nemen, is geaccepteerd en wordt verwerkt.

  • Status 400 — Ongeldig verzoek.

  • Status 401 — De vragende gebruiker kan niet worden geverifieerd.

  • Status 403 — De vragende gebruiker is niet gemachtigd 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 wordt vergrendeld tijdens het verwerken van een eerder verzoek.

  • Status 500 — Interne serverfout.

  • Status 504 — Er is een time-out van de aanvraag opgetreden.