API Recording d'interaction à l'écran

Une API peut être utilisée pour lancer l'enregistrement de l'écran de l'activité de l'ordinateur de bureau . Cela permet l'enregistrement des écrans des agents lorsqu'aucun contact n'est en cours, ainsi que l'enregistrement des écrans du back-office.

Cette API est disponible pour les utilisateurs d'Engagement Hub disposant de la fonctionnalité d'enregistrement voix ou écran, ainsi que pour les utilisateurs NiCE CXoneACD.

Avant de Démarrer

Vous pouvez test les API NiCE CXone sur le portail développeur Icon of dark gray square with an arrow pointing out of its upper right corner. Connectez-vous avec un compte NiCE CXone, vous pourrez alors effectuer des demandes avec le locataireClosed High-level organizational grouping used to manage technical support, billing, and global settings for your NiCE CXone system. de votre compte.

Pour commencer à utiliser les API, vous devez vous enregistrer auprès de NiCE pour recevoir des informations d'identification valides utilisées pour l'authentification. Consultez la page Prise en main Icon of dark gray square with an arrow pointing out of its upper right corner sur le portail développeur pour obtenir des instructions.

En outre, l'utilisation de ces API nécessite l'autorisation Interactions Hub Record screen interaction.

Démarrer l'enregistrement de l'interaction d'écran

L'API permet de lancer l'enregistrement d'écran pour un utilisateur spécifique qui n'est pas en appel actif. Vous devez préciser 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 3:30 heures, le maximum autorisé. Recording s'arrêtera automatiquement lorsque la durée est atteinte. De plus, vous pouvez arrêter l'enregistrement d'écran en invoquant la commande stop-screen-interaction-recording.

  • Lorsque l'enregistrement est lancé (indiqué par un code de réponse de 202) ou terminé avec succès (indiqué par un code de réponse de 200), l'Id du contact associé à l'écran enregistré sera fourni. Cet Id du contact doit être utilisé lors de l'émission de la commande Arrêter.

  • L'API peut être utilisée pendant un appel en direct entre un Agent et un client, lequel peut être enregistré. Dans ce cas, il existera deux enregistrements distincts : l'un capturant la conversation voix et l'autre basé sur les interactions API, chacun associé à des id de contact différents.

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

  • Lorsque vous utilisez l'API, il peut y avoir jusqu'à 10 instances d'enregistrement d'interaction d'écran par utilisateur, chacune avec un id du contact différent. Tout Appel API ultérieur pour le même utilisateur entraînera une erreur (429).

Méthode : POST

Terminal : /interaction-recording-management-service/v1/interactions/start-screen-interaction-recording

Paramètres :

userId* :

(query)

chaîne de caractères

ID de l'utilisateur à enregistrer.

recordingDuration* :

(requête)

number

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

Arrêter l'enregistrement de l'interaction à l'écran

L'API permet d'arrêter l'enregistrement de l'écran pour l'id du 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 du 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 s'arrête automatiquement après la durée indiquée dans la commande start-screen-interaction-recording.

Méthode : POST

Terminal : /interaction-recording-management-service/v1/interactions/stop-screen-interaction-recording

Paramètres :

userId* :

chaîne de caractères

L'id de l'utilisateur enregistré à arrêter.

contactId* :

number

L'id du contact renvoyé dans la commande Start Screen Recording.