API d’extraction de données

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

Les API d’extraction de données sont disponibles sur le portail de la communauté des développeurs (Developer Community) DEVone.

Pour plus d’informations sur les domaines et les URL, consultez Premiers pas dans le portail de la communauté des développeurs (Developer Community) DEVone.

Lors de l’appel du nœud final (endpoint) /jobs avec la méthode POST, 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 nœud final /jobs/{jobId}, le statut du job est renvoyé. 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

Avant de commencer à utiliser l’API Données commerciales, vous devez configurer les autorisations des utilisateurs, générer une clé d’accès et suivre le processus d’enregistrement et d’authentification expliqué sur le portail des développeurs. Autorisations requises :

  • 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 CXone 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 CXone 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 CXone WFM, vous avez besoin de l’autorisation CXone WFM  > API d’extraction de données > API de paie CXone WFM.

GET Travaux

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

POST (Publier) Travaux

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

GET (obtenir) Emplois par ID de travail

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).

Entité de flux de travail CXone QM et fichier CSV

L’API de flux de travail CXone QM vous permet d’extraire des données de flux de travail CXone 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) CXone QM et fichier CSV

L’API Q&A CXone QM vous permet d’extraire les questions et les réponses des évaluations, des auto-évaluations et des calibrages CXone 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 CXone QM et fichier CSV

L’API Notes de l’évaluateur CXone QM vous permet d’extraire des notes d’évaluateurs CXone 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 CXone Recording.

Pour le travail POST :

  • entityName est: recording-interaction-metadata

  • version est : 7

  • 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 CXone WFM et fichier CSV

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

Le nom de l’entité Payroll (paie) CXone 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.