API d’extraction de données

Les API d'extraction de données vous permettent d'extraire des données de NiCE CXone à des fins de création de rapports externes. Par exemple, vous pouvez extraire les données de flux de travail QM, les données de question et réponse QM, les métadonnées d'interaction Recording Management (CXone), ou les données de Paie WFM. Les données ne peuvent être filtrées que selon la plage de dates spécifiée. Les données de Gestion de la qualité sont envoyées à l'API d'extraction de données toutes les 15 minutes.

Vous pouvez essayer les API d'extraction de données et revoir leur documentation dans le portail des développeursIcon of dark gray square with an arrow pointing out of its upper right corner.

When vous appelez POST /jobs, un jobId est renvoyé 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 de la tâche. Si l'état 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.

À partir du 17 Novembre 2026, vous pouvez extraire des données pour 15 jours uniquement par Appel API. Vous pouvez utiliser n'importe quelle date de début dans votre historique et une date DE fin jusqu'à 15 jours plus tard. Si vous souhaitez extraire des données pendant plus de 15 jours, vous devrez effectuer plusieurs Appels API.

Alice est responsable de la Conformité au centre de contact Classiques, Inc. Elle souhaite récupérer les enregistrements voix d'un agent spécifique sur une période de 60 jours. Alice crée quatre Appels API, un appel pour chaque période de 15 jours.

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.

L'utilisation de ces API requiert les autorisations suivantes :

  • Entité :

    • Si vous extrayez des métadonnées d'interaction, vous avez besoin de l'autorisation Search & Playback > APIs > Extract Interaction Metadata.

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

    • Si vous extrayez des QM données de questions et réponses, vous devez 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 Tools > API d'extraction de données > QM Evaluator Notes API.

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 terminé, 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 l'état d'une tâche spécifique en fonction de 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 Entité et Fichier csv Questions et réponses (Q&A)

L'API QM Q&A vous permet d'extraire les questions et réponses des QM évaluations, des auto-évaluations et des é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-evaluation-comment-entity

  • La version est : 1

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

Entité Métadonnées de l'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 au format UTC : yyyy-mm-dd hh:mm:ss

    À compter du 17 Novembre 2026, la période entre startDate et endDate ne peut pas dépasser 15 jours calendaires. Une plage d'exactement 15 jours est acceptée. Si vous demandez une plage de 16 jours ou plus, la demande est rejetée.

WFM Entité de paie et Fichier csv

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

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. Conservez à l'esprit que le fuseau horaire de la date et de l'heure correspond au fuseau horaire de l'unité DE planification.