API d’extraction de données

Les API d'extraction de données vous permettent d'extraire des données depuis NiCE CXone à des fins de reporting externe. 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 Management (CXone) ou des données de Paie WFM. Les données ne peuvent être filtrées que selon la période spécifiée. Les données de Gestion de la qualité sont transmises à l'API d'extraction de données toutes les 15 minutes.

Vous pouvez tester les API d'extraction de données et revoir leur documentation dans le portail développeur.

Lors de l'appel de POST /jobs, un jobId est retourné pendant que les données sont en cours de préparation. Vous pouvez vérifier si les données sont prêtes en interrogeant le service à partir du terminal /jobs/{jobId}, qui renvoie l'état du job. Si le statut est réussite, une URL supplémentaire est également renvoyée. L'URL sera accessible pendant 30 secondes (sans compter le temps nécessaire pour télécharger le fichier).

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

Avant de Démarrer

Vous pouvez tester les API NiCE CXone sur le portail développeur . Connectez-vous avec un compte NiCE CXone, puis vous pourrez effectuer des demandes avec le locataireClosed Regroupement organisationnel de haut niveau utilisé pour gérer le soutien technique, la facturation et les paramètres globaux de votre système NiCE CXone. de votre compte.

Pour commencer à utiliser les API, vous devez vous enregistrer auprès de NiCE pour recevoir des identifiants valides utilisés pour l'authentification. Consultez la page Prise en main sur le portail des développeurs 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 > Extract Interaction Metadata.

    • Si vous extrayez des QM données de flux de travail, vous devez alors disposer de l'autorisation QM Outils > API d'extraction de données > API de flux de travail QM.

    • Si vous extrayez des QM données de Q&A, vous devez alors disposer de l'autorisation QM Outils > API d'extraction de données > QM Workflow API.

    • Si vous extrayez des WFM données de Paie, vous devez disposer de l'autorisation WFM > API d'extraction de données > WFM API Paie.

    • Si vous extrayez des QM notes de l'évaluateur, vous avez alors besoin de l'autorisation QM Outils > API d'extraction de données > API de notes de l'Évaluateur QM.

Obtenir les Travaux

Afficher une liste de tous les statuts de travail par locataire. Les statuts possibles sont le Fonctionnement, Réussi,Manqué, annulé etExpiré.

Méthode : GET

Terminal : /data-extraction/v1/jobs

Paramètres : rien

Préparer les travaux

Une fois qu'une demande d'extraction de données est effectuée, 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 l'opération terminée, un id de tâche est renvoyé.

Méthode : POST

Terminal : /data-extraction/v1/jobs

Paramètres : rien

Obtenir les travaux par Id de tâche

Affichez le statut d'une tâche spécifique selon son id de tâche. 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 nécessaire pour télécharger le 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 travail possibles sontFonctionnement,Réussi,Manqué ,annulé , etExpiré.

Méthode : GET

Terminal : /data-extraction/v1/jobs

Paramètres :

jobId*:

chaîne de caractères

Identifiant unique de la demande effectuée pour extraire les données clients.

QM Entité Workflow et CSV fichier

L’API de Flux de travail de QM vous permet d'extraire les données de flux de travail de QM, ce qui inclut les évaluations, les auto-évaluations et les étalonnages.

Pour le travail POST :

  • L’entityName est : qm-workflows

  • La version est : 4

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

QM Questions and Answers (Q&A) Entité et Fichier csv

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

Pour le travail POST :

  • L’entityName est : qm-questions

  • La version est : 2

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

QM Notes de l'évaluateur et Fichier csv

L’API Notes de l’Évaluateur QM vous permet d’extraire les notes de l’évaluateur QM.

Pour le travail POST :

  • entityName a la valeur : qm-évaluation-commentaire-entité

  • La version est : 1

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

Entité Métadonnées d'interaction et Fichier csv

L'API de Métadonnées d'interaction vous permet d'extraire Recording Management (CXone) métadonnées d'interaction.

Pour le travail POST :

  • L’entityName : recording-interaction-metadata

  • version est : 12

  • Pour filtrer les données par date et heure, utilisez startDate et endDate en UTC au format : yyyy-mm-dd hh:mm:ss

WFM Entité de paie et Fichier csv

L'API WFM Paie (version1) vous permet d'extraire les données d'activité WFM à des fins de reporting externe sur la paie.

Le WFM nom de l'entité Paie pour le travail POST est : wfm-payroll.

Les données sont filtrées selon Date de 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.