API d’enregistrement à la demande

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

Cette API permet de démarrer, d’arrêter et de désactiver l’enregistrement des appels à la demande, ce qui permet de contrôler l’enregistrement par le biais de l’API.

Avant de commencer

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

Cette API nécessite l’autorisation Recherche et lecture > API > Enregistrement Multi-ACD à la demande.

POST Démarrer l’enregistrement à la demande

L’API permet à un agent ou à une application de commencer à enregistrer un appel en cours pour un utilisateur spécifique. Cela peut être utilisé 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 commencer l’enregistrement de la voix uniquement, ou de la voix et de l’écran. Cette méthode API a la priorité sur les politiques d’enregistrement.

L’indicateur mediaType est facultatif et permet de contrôler les types de supports enregistrés. Les valeurs prises en charge sont voice et voiceAndScreen, ce qui permet de lancer l’enregistrement de la voix uniquement ou de la voix et de l’écran. Si l’indicateur n’est pas transmis, la valeur par défaut est voice.

userId*:

string

Le type de support à enregistrer.

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

Réponse

  • Statut 200 - Opération réussie. La demande « Démarrer l’enregistrement à la demande » a commencé.

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

  • Statut 400 - Mauvaise demande

  • Statut 401 - Le demandeur n’a pas réussi à s’authentifier.

  • Statut 403 - Le demandeur n’est pas autorisé à effectuer l’opération.

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

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

  • Statut 425 - L’interaction est bloquée pendant le traitement d’une demande précédente d’enregistrement à la demande ou d’arrêt de l’enregistrement à la demande.

  • Statut 500 - Erreur interne du serveur.

  • Statut 504 - La demande a expiré.

POST Arrêter l’enregistrement à la demande

L’API permet d’arrêter l’enregistrement de la voix et de l’écran d’un appel en cours pour un utilisateur spécifique. Elle peut être utilisée pour protéger la vie privée des clients ou pour se conformer aux réglementations qui limitent l’enregistrement de certains types de conversations.

Cette méthode API a la priorité sur les politiques d’enregistrement. L’enregistrement ne peut reprendre qu’en invoquant Démarrer l’enregistrement à la demande.

userId*:

string

ID d’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 - Mauvaise demande.

  • Statut 401 - Le demandeur n’a pas réussi à s’authentifier.

  • Statut 403 - Le demandeur n’est pas autorisé à effectuer l’opération.

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

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

  • Statut 425 - L’interaction est bloquée pendant le traitement d’une demande précédente d’enregistrement à la demande ou d’arrêt de l’enregistrement à la demande.

  • Statut 500 - Erreur interne du serveur.

  • Statut 504 - La demande a expiré.

POST Désactiver l’option d’enregistrement d’appel

L’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 pertinent pour le règlement général de l’UE sur la protection des données (GRPD). Si un client refuse son consentement, alors CXone Recording n’enregistrera pas l’appel, même si une politique d’enregistrement a été définie pour enregistrer l’appel, si l’agent enregistre l’appel à la demande ou si une API est utilisée.

L’enregistrement d’appel API (POST) ne peut pas être initié pour l’ensemble du contact du 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, alors CXone Recording arrêtera l’enregistrement et la partie enregistrée de l’appel sera disponible à la recherche et à la lecture.

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

userId*:

string

ID d’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 été lancée.

  • 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 - Le demandeur n’a pas réussi à s’authentifier.

  • Statut 403 - Le demandeur n’est pas autorisé à effectuer l’opération.

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

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

  • Statut 425 - L’interaction est verrouillée pendant le traitement d’une demande de précédente.

  • Statut 500 - Erreur interne du serveur.

  • Statut 504 - La demande a expiré.