API d'enregistrement des interactions à l'écran

Une API peut être utilisée pour lancer l'enregistrement d'écran de l'activité bureau . Cela permet d'enregistrer les écrans des agents lorsqu'aucun contact n'est en cours et l'enregistrement des écrans de back-office.

Cette API est disponible pour les utilisateurs d'Engagement Hub avec fonctionnalité d'enregistrement vocal ou d'écran et les utilisateurs CXone MpowerACD.

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 ces API nécessite l'autorisation Interactions Hub Enregistrer l'interaction à l'écran.

Enregistrement des interactions de l'écran d'accueil

L'API permet de lancer l'enregistrement d'écran pour un utilisateur spécifique qui n'est pas en appel actif. Vous devez spécifier la durée d'enregistrement en la fournissant comme paramètre dans la commande de démarrage. La durée doit être comprise entre 5 secondes et 3h30, le temps maximum autorisé. L'enregistrement s'arrêtera automatiquement lorsque la durée sera atteinte. De plus, vous pouvez arrêter l'enregistrement de l'écran en invoquant la commande stop-screen-interaction-recording.

  • Lorsque l'enregistrement est lancé (indiqué par un code de réponse de 202) ou réussi (indiqué par un code de réponse de 200), l'ID du contact associé à l'écran enregistré sera fourni. Cet ID de contact doit être utilisé lors de l'émission de la commande Stop.

  • L'API peut être utilisée lors d'un appel en direct entre un agent et un client, qui peut être enregistré. Dans de tels cas, il y aura deux enregistrements distincts - l'un capturant la conversation vocale et l'autre basé sur les interactions API - chacun associé à des identifiants de contact différents.

  • Si le masquage est appliqué à un appel en direct, il affectera également une interaction d'enregistrement d'écran API qui pourrait être enregistrée en parallèle.

  • Lors de l'utilisation de l'API, il peut y avoir une seule instance d'enregistrement d'écran. Si l’écran d’un agent est déjà enregistré via l’API, tous les appels d’API ultérieurs pour ce même agent ne généreront pas de nouvel enregistrement d’écran ni ne mettront à jour la durée de l’enregistrement.

Méthode  : POST

Point de terminaison : /interaction-recording-management-service/v1/interactions/start-screen-interaction-recording

Paramètres :

userId*:

(requête)

string

ID de l'utilisateur à enregistrer.

durée d'enregistrement* :

(requête)

numéro

Spécifie la durée d'enregistrement requise dans la plage de 5 à 13 200 secondes

POST /interaction-recording-management-service/interactions/start-screen-interaction-recording?user-id=1234567&recordingDuration=3000

Réponses

  • Statut 200 - Opération réussie.

    description (chaîne de caractères) : La description de la réponse.

    contactId (nombre) : L'identifiant de contact ACD.

    interactionId (chaîne de caractères) : L’identifiant global de l’interaction.

    httpStatus (chaîne de caractères) : Description du statut HTTP.

  • Statut 202 - L'opération est en cours.

    contactId (nombre) : L'identifiant de contact ACD.

    interactionId (chaîne de caractères) : L’identifiant global de l’interaction.

    httpStatus (chaîne de caractères) : Description du statut HTTP.

  • 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 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é.

Arrêter l'enregistrement des interactions à l'écran

L'API permet d'arrêter l'enregistrement d'écran pour l'ID de contact d'un utilisateur spécifique qui a été démarré à l'aide de la commande start-screen-interaction-recording. Vous devez utiliser l'ID de contact fourni dans la réponse de la commande start-screen-interaction-recording. Si cette méthode n'est pas appelée, l'enregistrement de l'écran est arrêté automatiquement après la durée fournie dans la commande start-screen-interaction-recording.

Méthode  : POST

Point de terminaison : /interaction-recording-management-service/v1/interactions/stop-screen-interaction-recording

Paramètres :

userId*:

string

L'ID de l'utilisateur enregistré à arrêter.
contactId* :

numéro

L'ID de contact renvoyé dans la commande d'enregistrement de l'écran de démarrage.

POST /interaction-recording-management-service/interactions/stop-screen-interaction-recording?user-id=1234567&contactId=1122334455

Réponses

  • Statut 200 - Opération réussie.

  • Statut 202 - L'opération est en cours.

  • 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 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é.