API Enregistrement à la demande

Cette API est uniquement disponible pour les utilisateurs de CXone Multi-ACD (CXone Open) .

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.

Avant de commencer

Avant de commencer à utiliser les API Masquer et Afficher, configurez une autorisation utilisateur, générez une clé d’accès et suivez le processus d’enregistrement et d’authentification présenté sur le portail des développeurs.

Pour utiliser cette API, vous devez disposer de l’autorisation Recherche et lecture >API > API Enregistrement multi-ACD à la demande.

POST Lancer 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.

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 : opération réussie. 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 : demande incorrecte

  • Statut 401 : l’utilisateur à l’origine de la requête ne s’est pas authentifié.

  • Statut 403 : l’utilisateur à l’origine de la requête n’est pas autorisé à exécuter l’opération.

  • Statut 404 : non trouvé. Aucune interaction active n’a été trouvée.

  • Statut 409 : il est impossible d’exécuter la demande en raison de l’état du service.

  • Statut 425 : l’interaction est verrouillée pendant le 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 requête a dépassé le délai imparti.

POST 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 d’API a la priorité sur les politiques d’enregistrement. 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.

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 : opération réussie. 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 : demande incorrecte.

  • Statut 401 : l’utilisateur à l’origine de la requête ne s’est pas authentifié.

  • Statut 403 : l’utilisateur à l’origine de la requête n’est pas autorisé à exécuter l’opération.

  • Statut 404 : non trouvé. Aucune interaction active n’a été trouvée.

  • Statut 409 : il est impossible d’exécuter la demande en raison de l’état du service.

  • Statut 425 : l’interaction est verrouillée pendant le 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 requête a dépassé le délai imparti.

POST 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 le consentement, CXone Recording n’enregistre pas l’appel, même si une politique d’enregistrement a été définie pour enregistrer l’appel, ou si l’agent enregistre l’appel à la demande ou utilise 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, CXone Recording arrête l’enregistrement et la partie enregistrée de l’appel est disponible à des fins de recherche et de 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.

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 : opération réussie. 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 : demande incorrecte.

  • Statut 401 : l’utilisateur à l’origine de la requête ne s’est pas authentifié.

  • Statut 403 : l’utilisateur à l’origine de la requête n’est pas autorisé à exécuter l’opération.

  • Statut 404 : non trouvé. Aucune interaction active n’a été trouvée.

  • Statut 409 : il est impossible d’exécuter la demande en raison de l’état du service.

  • Statut 425 : l’interaction est verrouillée pendant le traitement d’une demande précédente.

  • Statut 500 : erreur interne du serveur.

  • Statut 504 : la requête a dépassé le délai imparti.