API Enregistrement à la demande

Cette API est disponible pour les utilisateurs d'Engagement Hub disposant d'une fonctionnalité d'enregistrement vocal ou d'écran.

Ces API permettent de démarrer, d’arrêter et de désactiver l’enregistrement des appels à la demande, en vue de contrôler l’enregistrement via l’API.

La documentation relative aux API Record on Demand est disponible sur le portail de la communauté des développeurs .

Avant de commencer

Vous pouvez tester les API CXone Mpower sur le portail développeur . Connectez-vous avec un compte CXone Mpower, puis vous pourrez effectuer des requêtes avec le tenantFermé Regroupement organisationnel de haut niveau utilisé pour gérer le support technique, la facturation et les paramètres globaux de votre système CXone Mpower. de votre compte.

Pour commencer à utiliser les API, vous devez vous inscrire auprès de NiCE pour recevoir des identifiants valides utilisés pour l'authentification. Consultez la page Premiers pas du portail développeur pour obtenir des instructions.

De plus, l'utilisation de cette API nécessite l'autorisation Interactions Hub >API > Multi-ACD Record on Demand API.

Démarrer l'enregistrement à la demande

Cette API permet à un agent ou à une application de commencer à enregistrer un appel en cours pour un utilisateur spécifique. Vous pouvez l’utiliser pour capturer des interactions ou des conversations spécifiques qui sont pertinentes à des fins de conformité, d’assurance qualité ou de formation.

Vous pouvez spécifier de démarrer l’enregistrement de la voix uniquement, ou de la voix et de l’écran. Cette méthode d’API a la priorité sur les politiques d’enregistrement.

L’indicateur mediaType est facultatif et permet de contrôler les types de médias à enregistrer. Les valeurs prises en charge sont les suivantes : voice et voiceAndScreen, permettant de démarrer l’enregistrement de la voix uniquement ou de la voix et de l’écran. Si cet indicateur n’est pas transmis, la valeur par défaut est voice.

Méthode  : POST

Point de terminaison : /interaction-recording-management-service/interactions/start-recording-on-demand

Paramètre :

userId* :

chaîne de caractères

Type de média à enregistrer.

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

Réponse

  • Statut 200 - Succès de l'opération. La demande Lancer l’enregistrement à la demande a commencé.

  • Statut 202-Opération en cours. La demande Lancer l’enregistrement à la demande a été acceptée et est en cours de traitement.

  • Statut 400-Requête incorrecte

  • Statut 401 - L'utilisateur demandeur n'a pas pu s'authentifier.

  • Statut 403 - L'utilisateur demandeur n'est pas autorisé à effectuer l'opération.

  • Statut 404-Non trouvé. Aucune interaction active n’a été trouvée.

  • Statut 409 - La demande ne peut pas être exécutée en raison de l'état du service.

  • Statut 425 - L'interaction est verrouillée lors du traitement d'une demande d'enregistrement à la demande/d'arrêt à la demande précédente

  • Statut 500 - Erreur interne du serveur.

  • Statut 504 - La demande a expiré.

Arrêter l’enregistrement à la demande

Cette API permet d’arrêter l’enregistrement de la voix et de l’écran d’un appel en cours pour un utilisateur spécifique. Vous pouvez l’utiliser pour protéger la vie privée des clients ou pour vous conformer aux réglementations qui limitent l’enregistrement de certains types de conversations.

Cette méthode API donne la priorité sur Recording politiques. Après cette API, la demande Arrêter l’enregistrement à la demande peut reprendre uniquement après l’appel de Lancer l’enregistrement à la demande.

Méthode  : POST

Point de terminaison : /interaction-recording-management-service/interactions/stop-recording-on-demand

Paramètre :

userId* :

chaîne de caractères

ID utilisateur de l’agent à enregistrer.

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

Réponse

  • Statut 200 - Succès de l'opération. La demande Arrêter l’enregistrement à la demande a commencé.

  • Statut 202-Opération en cours. La demande Arrêter l’enregistrement à la demande a été acceptée et est en cours de traitement.

  • Statut 400-Mauvaise demande.

  • Statut 401 - L'utilisateur demandeur n'a pas pu s'authentifier.

  • Statut 403 - L'utilisateur demandeur n'est pas autorisé à effectuer l'opération.

  • Statut 404-Non trouvé. Aucune interaction active n’a été trouvée.

  • Statut 409 - La demande ne peut pas être exécutée en raison de l'état du service.

  • Statut 425 - L'interaction est verrouillée lors du traitement d'une demande d'enregistrement à la demande/d'arrêt à la demande précédente.

  • Statut 500 - Erreur interne du serveur.

  • Statut 504 - La demande a expiré.

Désactiver l’Option d'enregistrement de l'appel

Cette API permet de désactiver l’option d’enregistrement de la voix et de l’écran d’un appel dans le cas où le client refuse le consentement et n’accepte pas d’être enregistré. Ceci est particulièrement important pour se conformer au Règlement général sur la protection des données (RGPD) de l’UE. Si un client refuse son consentement, CXone Mpower Recording n'enregistrera pas l'appel, même s'il existe une politique d'enregistrement définie pour enregistrer l'appel, ou si l'agent enregistre l'appel à la demande ou à l'aide de l'API.

Après l’API, l’enregistrement des appels ne peut pas être initié pour l’ensemble du contact client, y compris les transferts, les consultations et les conférences. Si l'API a été appelée alors que l'enregistrement de l'appel était en cours, Recording arrêtera l'enregistrement, la partie enregistrée de l'appel sera disponible pour la recherche et la lecture.

Le consentement à l’enregistrement ne s’applique qu’à l’appel en cours. Il n’est pas sauvegardé pour le client en vue d’interactions futures.

Méthode  : POST

Point de terminaison : /interaction-recording-management-service/interactions/do-not-record

Paramètre :

userId* :

chaîne de caractères

ID utilisateur de l’agent à enregistrer.

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

Réponse

  • Statut 200 - Succès de l'opération. La demande Ne pas enregistrer a démarré.

  • Statut 202-Opération en cours. La demande Ne pas enregistrer a été acceptée et est en cours de traitement.

  • Statut 400-Mauvaise demande.

  • Statut 401 - L'utilisateur demandeur n'a pas pu s'authentifier.

  • Statut 403 - L'utilisateur demandeur n'est pas autorisé à effectuer l'opération.

  • Statut 404-Non trouvé. Aucune interaction active n’a été trouvée.

  • Statut 409 - La demande ne peut pas être exécutée en raison de l'état du service.

  • Statut 425 - L'interaction est verrouillée lors du traitement d'une demande précédente.

  • Statut 500 - Erreur interne du serveur.

  • Statut 504 - La demande a expiré.