API d’enregistrement à la demande

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

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.

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 faire 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 pour 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.

Commencer l'enregistrement sur 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.

Méthode  : POST

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

Paramètre :

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 - L'utilisateur demandeur n'a pas réussi à s'authentifier.

  • Statut 403 - L'utilisateur 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 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 sur 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 donne la priorité sur Recording politiques. L’enregistrement ne peut reprendre qu’en invoquant Démarrer l’enregistrement à la demande.

Méthode  : POST

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

Paramètre :

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 - L'utilisateur demandeur n'a pas réussi à s'authentifier.

  • Statut 403 - L'utilisateur 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 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

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, 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.

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, 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 enregistré 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*:

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 - L'utilisateur demandeur n'a pas réussi à s'authentifier.

  • Statut 403 - L'utilisateur 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 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é.