API d’extraction de données

Les API d’extraction de données vous permettent d’extraire des données de CXone Mpower à des fins de rapports externes. Par exemple, vous pouvez extraire des données de flux de travail QM, des données de questions et réponses QM, des métadonnées d’interaction Recording ou des données de paie WFM. Les données ne peuvent être filtrées qu’en fonction de la plage de dates spécifiée.

Vous pouvez essayer les API d'extraction de données et consulter leur documentation sur le portail développeur .

Lors de l'appel de POST /jobs, un jobId est retourné pendant la préparation des données. Vous pouvez vérifier si les données sont prêtes en interrogeant le service à partir du point de terminaison /jobs/{jobId}, qui retourne l'état du travail. Si le statut est Réussi, une URL supplémentaire est également renvoyée. L’URL sera accessible pendant 30 secondes (sans compter le temps de téléchargement du fichier).

Vous pouvez écrire des scripts pour appeler l’API périodiquement au lieu de récupérer manuellement les données à chaque fois. À tout moment, un seul utilisateur par locataire peut appeler une API. Vous ne pouvez appeler l’API qu’une seule fois au cours d’une période de 30 secondes.

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.

L'utilisation de ces API nécessite les autorisations suivantes :

  • Entité :

    • Si vous extrayez des métadonnées d’interaction, vous avez besoin de l’autorisation Recherche et lecture > API > Extraire les métadonnées d’interaction.

    • Si vous extrayez des données de flux de travail QM, alors vous avez besoin de l’autorisation Outils QM > API d’extraction de données > API QM Workflow (Flux de travail).

    • Si vous extrayez des données de questions-réponses QM, vous avez besoin de l’autorisation Outils QM > API d’extraction de données > API de flux de travail QM.

    • Si vous extrayez des Données de paie WFM, vous avez besoin de l’autorisation WFM  > API d’extraction de données > API de paie WFM.

    • Si vous extrayez des notes d'évaluateur QM, vous avez besoin de l'autorisation QM Tools > Data Extraction APIs > QM Évaluation Notes API.

Trouver un emploi

Afficher une liste de tous les statuts de travail par locataire. Les états possibles sont En cours d’exécution, Réussi, Échoué, Annulé et Expiré.

Méthode : GET

Point de terminaison : /data-extraction/v1/jobs

Paramètres : aucun

Préparer les emplois

Après une demande d’extraction de données, les données sont collectées et préparées pour l’extraction. Les données sont disponibles dans S3 sous forme de fichier CSV pendant 24 heures. Une fois terminé, un ID de travail est renvoyé.

Méthode  : POST

Point de terminaison : /data-extraction/v1/jobs

Paramètres : aucun

Trouver des offres d'emploi par identifiant

Affichez l’état d’un travail spécifique en fonction de son ID de travail. Si un travail a réussi, une URL pour accéder aux données extraites est renvoyée et est accessible pendant 30 secondes (sans compter le temps de téléchargement du fichier). Si le travail a échoué, un message d’erreur est renvoyé. Le lien peut être utilisé pour accéder aux données extraites. Les statuts de tâche possibles sont En cours d’exécution(Running), Réussi (Succeeded), Échoué (Failed), Annulé (Cancelled) et Expiré (Expired).

Méthode : GET

Point de terminaison : /data-extraction/v1/jobs

Paramètres :

jobId*:

string

Identificateur unique de la demande d’extraction des données client.

QM Entité de flux de travail et fichier CSV

L’API de flux de travail QM vous permet d’extraire des données de flux de travail QM, y compris des évaluations, des auto-évaluations et des calibrages.

Pour le travail POST :

  • entityName est: qm-workflows

  • La version est: 4

Les données sont filtrées en fonction de la Date de soumission (en UTC).

Entité Questions et réponses (Q&A) QM et fichier CSV

L’API Q&A QM vous permet d’extraire les questions et les réponses des évaluations, des auto-évaluations et des calibrages QM.

Pour le travail POST :

  • entityName est : qm-questions

  • la version est : 2

Les données sont filtrées en fonction de la Date de soumission (en UTC).

Notes de l’évaluateur QM et fichier CSV

L’API Notes de l’évaluateur QM vous permet d’extraire des notes d’évaluateurs QM.

Pour le travail POST :

  • entityName est : qm-evaluation-comment-entity

  • version est : 1

Les données sont filtrées en fonction de la Date de soumission (en UTC).

Entité de métadonnées d’interaction et fichier CSV

L’API de métadonnées d’interaction vous permet d’extraire des métadonnées d’interaction Recording.

Pour le travail POST :

  • entityName est: recording-interaction-metadata

  • version est : 10

  • Pour filtrer les données par date et heure, utilisez startDate et endDate en UTC avec le format : aaaa-mm-jj hh:mm:ss.

Entité de paie WFM et fichier CSV

L’API de paie WFM (version 1) vous permet d’extraire des données d’activité WFM à des fins de rapports de paie externe.

Le nom de l’entité Payroll (paie) WFM pour le travail POST est : wfm-payroll.

Les données sont filtrées selon la date du code de paie. Gardez à l’esprit que le fuseau horaire de la date et de l’heure correspond au fuseau horaire de l’unité de planification.