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 reporting externe. Par exemple, vous pouvez extraires QM données de flux de travail, QM données de questions et réponses,Recording métadonnées d'interaction ou WFM Données de paie. 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 renvoyé 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 renvoie l'état du travail. Si le statut est Succès, puis 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 commencer

Vous pouvez tester les API CXone Mpower sur le portail développeur . Connectez-vous avec un compte CXone Mpower, puis vous pourrez effectuer des requêtes avec le tenant Regroupement organisationnel de haut niveau utilisé pour gérer le support technique, la facturation et les paramètres globaux de 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 requiert les autorisations suivantes :

Entité :
- Si vous extrayez les métadonnées d’interaction, vous devez disposer de l’autorisation Recherche et lecture > API > Extraire les métadonnées d'interaction.
- Si vous extrayez QMdonnées de flux de travail, alors vous avez besoin duOutils QM > API d'extraction de données > API de flux de travail QM autorisation.
- Si vous extrayezQMDonnées de questions / réponses, alors vous avez besoin duOutils QM > API d'extraction de données > API de flux de travail QM autorisation.
- Si vous extrayez WFMDonnées de paie, alors vous avez besoin du WFM > API d'extraction de données > autorisation WFM API de paie.
- Si vous extrayez des notes d'évaluateur QM, vous avez besoin de l'autorisation QM Tools > Data Extraction APIs > QM Evaluator Notes API.

Trouver un emploi

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

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

Paramètres : aucun

Préparer les emplois

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 travail est renvoyé.

Méthode : POST

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

Paramètres : aucun

Exemple de valeur et de réponses

Demander le corps*:	application / json
exportRequest { la description:	Paramètres à fournir pour extraire les données.
entityName	chaîne de caractères Nom de l'entité à extraire. Pour les noms d'entités corrects, voir ci-dessous.
version	chaîne de caractères Version de l'entité à extraire. Pour les versions correctes pour chaque entité, voir ci-dessous.
startDate	chaîne de caractères($ date) Date, en UTC, à partir de laquelle commencer l'extraction des données. Le format de la date est <AAAA-MM-JJ>. Par exemple, pour extraire les données du 22 mai 2019, entrez la date: 2019-05-22.
endDate	chaîne de caractères($ date) Date, en UTC, à partir de laquelle arrêter l'extraction des données. Le format de la date est <AAAA-MM-JJ>. Par exemple, pour extraire les données jusqu'au 29 mai 2019, entrez la date: 2019-05-29.
}

Exemple de valeur

{ "entityName": "qm-workflows", "version": "3", "startDate": "2019-05-22", "endDate": "2019-05-29" }

Réponses

Statut 202 - Succès. Tâche asynchrone exportée avec succès.

chaîne de caractères

Exemple: 12345d5h-c099-9303-j99j-w3ko9ppp1234
Statut 400 - Demande non valide. Filtres de date incorrects, etc.
Statut 401 - Non autorisé. Les informations d'identification invalides.
Statut 403 - Interdit. L'utilisateur n'a pas l'autorisation d'afficher l'état du travail.
État 404 - introuvable. Entité manquante ou version non valide.
État 500 - Erreur de serveur interne.

Trouver des offres d'ID de travail par identifiant

Afficher le statut d'un travail spécifique par 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 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

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

Paramètres :

jobId*:

chaîne de caractères

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

Exemple de valeur et de réponses

Exemple de valeur

 12345d5h-r3ds-9303-0pw3-w3ko9ppp1234

Réponses

Statut 202 - Succès. Statut du travail récupéré.

 jobResponse{ description: Displays the job status jobStatus: { description: Job Status, includes job ID and job status id:	string Unique identifier of the job. status: string example: SUCCEEDED Job status that can be returned. Enum: [ RUNNING, SUCCEEDED, FAILED, CANCELLED, EXPIRED ] result: { description:	Job result. If successful, contains the url, if failed, an error message is displayed. url: string example: https://s3.example.amazonaws.com/results-bucket/data-extraction/{details} A url to access the extracted data is returned when a job for extracting data is successful. errorMessage: string Error message displayed when a request for extracting data fails. } } }

Statut 400 - Demande non valide. Filtres de date incorrects, etc.
Statut 401 - Non autorisé. Les informations d'identification invalides.
Statut 403 - Interdit. L'utilisateur n'a pas l'autorisation d'afficher l'état du travail.
État 404 - introuvable. Entité manquante ou version non valide.
État 500 - Erreur de serveur interne.

QM Entité de flux de travail et fichier CSV

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 duDate de soumission (en UTC).

Champs dans le QM fichier CSV du flux de travail

Nom de colonne	Description
Nom du locataire	Nom du tenant.
Identifiant de l'agent	Identifiant unique de l'agent. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Type	Type d'évaluation, par exemple: Évaluation Auto-évaluation Type de champ : chaîne avec jusqu’à 24 caractères (VARCHAR)
Déclencheur de flux d'évaluation	Événement qui a démarré l'évaluation: Étalonnage Collaboratif Manuel Plan qualité Type de champ : chaîne avec jusqu’à 24 caractères (VARCHAR)
Statut du flux de travail	État du flux de travail: Envoyé à l’agent En révision Contestation Terminé Confirmé Auto-évaluation terminée Complété avec revue Complété sans revue Terminé Supprimé Supprimé - Terminé Expiré Supprimé - Expiré Supprimé - Complété reconnu Supprimé - Terminé Révisé Supprimé - Terminé Pas d'examen Type de champ : chaîne avec jusqu’à 128 caractères (VARCHAR)
Reconnaissance automatique	Les valeurs possibles sont : VRAI : si l’agent n’a pas accusé réception de l’évaluation, elle a été automatiquement acquittée. FAUX : si l’agent a accusé réception de l’évaluation. Valeur vide : en cas d’auto-évaluation, aucun accusé de réception n’est nécessaire. Type de champ : BOOLÉEN
État du flux de travail	État du flux de travail: Ouvert Fermé Fin du temps Type de champ : chaîne avec jusqu’à 128 caractères (VARCHAR)
ID de flux de travail	L'identifiant unique de l'évaluation. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR) Version de l’API : 3 au minimum
Nom du plan	Le nom du plan qualité utilisé pour lancer cette évaluation. Type de champ : chaîne avec jusqu’à 128 caractères (VARCHAR)
Nom du formulaire	Le nom du formulaire utilisé pour cette évaluation. Type de champ : chaîne avec jusqu’à 256 caractères (VARCHAR)
Version du formulaire	La version du formulaire d'évaluation utilisée pour cette évaluation. Type de champ : numérique (4,0)
Date de début	Date et heure (en UTC) du début de cette évaluation. Type de champ : HORODATAGE_LTZ(3)
Date de soumission	Date et heure (en UTC) auxquelles cette évaluation a été soumise. Type de champ : HORODATAGE_LTZ(3)
Dernière mise à jour	Horodatage (en UTC) de la dernière modification de cette évaluation. Type de champ : HORODATAGE_LTZ(3) Dans le cas des appels, vous souhaitez extraire la date de soumission, et non la dernière mise à jour.
Note - Pourcentage	Score d'évaluation en pourcentage. Type de champ : FLOTTANT
Score	Score d'évaluation. Type de champ : FLOTTANT
Score maximum possible	Le score le plus élevé possible pour chaque question du formulaire d'évaluation. Type de champ : FLOTTANT
Rang	Plage de valeurs personnalisée définie par l'utilisateur pour définir le classement du formulaire. Type de champ : chaîne avec jusqu’à 256 caractères (VARCHAR)
Question critique échouée	Si la valeur est true, l'utilisateur a échoué à une question critique et le score du formulaire d'évaluation est défini sur zéro. Si la valeur est false, l'utilisateur a répondu correctement à la question. Type de champ : BOOLÉEN
Commentaires sur les avis des utilisateurs	Les commentaires saisis par l'utilisateur (agent) lors de la contestation de l'évaluation. Type de champ : chaîne avec jusqu’à 256 caractères (VARCHAR)
Commentaires du résolveur de litige	Les commentaires saisis par l'utilisateur (responsable / évaluateur) lors de la clôture du litige. Type de champ : chaîne avec jusqu’à 256 caractères (VARCHAR)
ID de segment	ID de segment de l'interaction en cours d'évaluation. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
ID ACD	Identifiant unique de la distribution automatique des appels. Type de champ : numérique (38,0)
Type d'interaction	Type d'interaction: APPEL TÉLÉPHONIQUE E-MAIL CHAT SMS ÉLÉMENT DE TRAVAIL GOOGLE_BUSINESS_MESSAGES_PRIVÉ APPLE_BUSINESS_CHAT_PRIVÉ TELEGRAM_PRIVÉ LINE_PRIVÉ WHATSAPP_PRIVÉ SLACK_PRIVÉ MICROSOFT_TEAMS_PRIVÉ TW_PRIVÉ VIBER_PRIVÉ PERSONNALISÉ_PRIVÉ WE_CHAT_PRIVÉ FB_PRIVÉ Type de champ : chaîne avec jusqu’à 50 caractères (VARCHAR)
Date de début de l'interaction	Date-heure de début (en UTC) de l'interaction. Type de champ : HORODATAGE_LTZ(6)
Date de fin de l'interaction	Date-heure de fin (en UTC) de l'interaction. Type de champ : HORODATAGE_LTZ(6)
Direction de l'interaction	Direction de l'appel: Entrant Sortant Type de champ : chaîne avec jusqu’à 50 caractères (VARCHAR)
ID de l'Équipe	L'identifiant unique de l'équipe de l'agent. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Nom de l’équipe	Nom de l’équipe de l’agent. Type de champ : chaîne avec jusqu’à 50 caractères (VARCHAR)
Numéro de téléphone	Numéro de téléphone du client. Type de champ : chaîne avec jusqu’à 200 caractères (VARCHAR)
Prénom (Eva)	Prénom de l'évaluateur. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Nom (Eva)	Nom de famille de l'évaluateur. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Prénom (agent)	Prénom de l'agent évalué. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Nom de famille (agent)	Nom de famille de l'agent évalué. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Prénom (Disp)	Prénom du résolveur de litige. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Nom de famille (Disp)	Nom de famille du résolveur de litige. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Prénom (attributaire)	Prénom de l'utilisateur qui a attribué l'évaluation. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Nom (attributaire)	Nom de famille de l'utilisateur qui a attribué l'évaluation. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Motif	Raison de la suppression de l'évaluation. Type de champ : chaîne avec jusqu’à 128 caractères (VARCHAR) Version de l’API : 4 au minimum
Identifiant parent	L’ID de flux de travail parent de l’évaluation, tel que collaboratif et calibrage. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR) Version de l’API : 4 au minimum
Sujet d’évaluation	Les valeurs possibles sont : Employé Segment Type de champ : chaîne avec jusqu’à 128 caractères (VARCHAR) Version de l’API : 4 au minimum

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

L'API Q&A QM vous permet d'extraire les questions et réponses des évaluations QM, 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 duDate de soumission (en UTC).

Champs dans leQM Fichier CSV Q&A

Nom de colonne	Description
QuestionID	Identifiant unique de la question. Type de champ : NUMÉRIQUE (38,0)
titre de question	Le texte de la question. Type de champ : chaîne avec jusqu’à 2048 caractères (VARCHAR)
Numéro de question	Le numéro de la question dans le formulaire d'évaluation. Type de champ : chaîne avec jusqu’à 15 caractères (VARCHAR)
Réponse	La réponse de l'évaluateur à la question. Type de champ : chaîne avec jusqu’à 10000 caractères (VARCHAR)
Options	Les options de réponse disponibles pour la question, telles que oui / non, les options numériques, les options de bouton radio, etc. Type de champ : TABLEAU
ID de formulaire	Identifiant unique du formulaire d'évaluation. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Nom du formulaire	Le nom du formulaire utilisé pour cette évaluation. Type de champ : chaîne avec jusqu’à 256 caractères (VARCHAR)
Version du formulaire	La version du formulaire d'évaluation utilisée pour cette évaluation. Type de champ : NUMÉRIQUE (4,0)
Date de début de l'évaluation	Date et heure (en UTC) du début de cette évaluation. Type de champ : HORODATAGE_LTZ(3)
Date de soumission de l'évaluation	Date et heure (en UTC) auxquelles cette évaluation a été soumise. Type de champ : HORODATAGE_LTZ(3) Dans le cas des appels, vous souhaitez extraire la date de soumission, et non la date de dernière modification.
Type de flux de travail	Type d'évaluation, par exemple: Évaluation Auto-évaluation Type de champ : chaîne avec jusqu’à 24 caractères (VARCHAR)
ID de section	Identifiant unique de la section dans le formulaire d'évaluation. Type de champ : NUMÉRIQUE(38,0)
Section titre	Le nom de la section dans le formulaire d'évaluation. Type de champ : chaîne avec jusqu’à 2048 caractères (VARCHAR)
Coté	Indicateur vrai ou faux pour savoir si la question peut être notée. Type de champ : BOOLÉEN
Score réel	Le score que l'agent a reçu sur la question. Type de champ : FLOTTANT
Score de la section (%)	Le score en pourcentage de la section où se trouvait la question. Type de champ : FLOTTANT
Score max.	Le score maximum qu'un agent aurait pu obtenir sur la question. Type de champ : FLOTTANT
Identifiant de l'agent	Identifiant unique de l'agent. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Prénom (agent)	Prénom de l'agent évalué. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Nom de famille (agent)	Nom de famille de l'agent évalué. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
ID de l'Équipe	L'identifiant unique de l'équipe de l'agent. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Nom de l’équipe	Nom de l’équipe de l’agent. Type de champ : chaîne avec jusqu’à 50 caractères (VARCHAR)
Prénom (Eva)	Prénom de l'évaluateur. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Nom (Eva)	Nom de famille de l'évaluateur. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Critique	Indicateur vrai ou faux pour si la question était une question critique. Type de champ : BOOLÉEN
Question critique échouée	Si la valeur est true, l'utilisateur a échoué à une question critique et le score du formulaire d'évaluation est défini sur zéro. Si la valeur est false, l'utilisateur a répondu correctement à la question. Type de champ : BOOLÉEN
Obligatoire	Indicateur vrai ou faux pour si la question était obligatoire. Type de champ : BOOLÉEN
Type de question	Le type de question: Radio Oui/Non Case à cocher Menu déroulant Date/Heure Type de champ : chaîne avec jusqu’à 64 caractères (VARCHAR)
ID de segment	ID de segment de l'interaction en cours d'évaluation. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Date de début de l'interaction	Date-heure de début (en UTC) de l'interaction. Type de champ : HORODATAGE_LTZ(6)
Date de fin de l'interaction	Date-heure de fin (en UTC) de l'interaction. Type de champ : HORODATAGE_LTZ(6)
ID de WorkflowInstance	L'identifiant unique de l'évaluation. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Score d'évaluation (%)	Le pourcentage de score de l'évaluation. Type de champ : FLOTTANT
ID de la banque	Identifiant unique de la banque de questions où se trouve la question. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Nom masqué	L’indicateur « vrai » masque les questions et l’indicateur « faux » les affiche. Lorsque la règle QM Form est utilisée dans un formulaire de qualité, elle masque une question de suivi sur la base du score d'une question précédente. Type de champ : BOOLÉEN Version de l’API : 2 au minimum

Notes de l’évaluateur QM 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 duDate de soumission (en UTC).

Champ du fichier CSV de notes de l’évaluateur QM

Nom de colonne	Description
ID de commentaire	L'identificateur unique du commentaire. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Commentaires	Le texte du commentaire. Type de champ : chaîne avec jusqu’à 300 caractères (VARCHAR)
Heure de commentaire	Date et heure de création d’ajout du commentaire. Type de champ : HORODATAGE_LTZ(3)
Activité	Le nom d’action de l’évaluation lorsque le commentaire a été ajouté. Type de champ : chaîne avec jusqu’à 50 caractères (VARCHAR)
Commenté par ID	L'identificateur unique de l'utilisateur qui a ajouté le commentaire. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Commentaire par prénom	Prénom d'utilisateur qui a ajouté le commentaire. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Commenté par prénom	Le prénom d'utilisateur qui a ajouté le commentaire. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
QuestionID	L'identificateur unique de la question. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
titre de question	Le texte de la question. Type de champ : chaîne avec jusqu’à 2048 caractères (VARCHAR)
ID de formulaire	L'identificateur unique du formulaire d'évaluation. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Nom du formulaire	Le nom du formulaire utilisé pour cette évaluation. Type de champ : chaîne avec jusqu’à 256 caractères (VARCHAR)
Version du formulaire	La version du formulaire d'évaluation utilisé pour cette évaluation. Type de champ : NUMÉRIQUE (4,0)
ID de flux de travail	L'identifiant unique de l'évaluation. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Statut du flux de travail	Le statut du flux de travail. Type de champ : chaîne avec jusqu’à 128 caractères (VARCHAR)
Identifiant de l'agent	L'identificateur unique de l’agent. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Prénom (agent)	Le prénom de l'agent. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Nom de famille (agent)	Le nom de famille de l'agent. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
ID de l'Équipe	L'identifiant unique de l'équipe de l'agent. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
Nom de l’équipe	Nom de l’équipe de l’agent. Type de champ : chaîne avec jusqu’à 50 caractères (VARCHAR)

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

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

Pour le travail POST :

L’entityName : recording-interaction-metadata
version est : 10
Pour filtrer les données par date et heure utilisez startDate et endDate au format UTC : aaaa-mm-jj hh:mm:ss

Champs du fichier CSV de métadonnées d'interaction

Nom de colonne	Description
ID d'appel ACD (par exemple, ID de contact principal)	L'ID d'appel ACD dépend de la solution ACD, par exemple, c'est le même que le CXone MpowerID de contact principal L'ID maître ou parent d'un ou de plusieurs contacts associés. Un nouvel ID de contact principal est attribué si un contact est transféré à trois reprises ou plus.. Type de champ : numérique avec jusqu’à 38 chiffres
ID de segment	Identifiant unique du segment. Un segment est une interaction avec deux parties, comme un client et un agent. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR UUID)
Raison du début du segment	Raison pour laquelle le segment a commencé: Conférence SVI Segment : premier segment du contact Transférer Contact Converti Transféré à un numéro externe Transfert externe Type de champ : chaîne avec jusqu’à 100 caractères (VARCHAR)
Raison de fin de segment	Raison pour laquelle le segment s'est terminé: Conférence SVI Segment : dernier segment du contact Transférer Contact Converti Transféré à un numéro externe Transfert externe Type de champ : chaîne avec jusqu’à 100 caractères (VARCHAR)
Direction	Direction du segment: Entrant Sortant Interne Inconnu Type de champ : chaîne avec jusqu’à 150 caractères (VARCHAR)
Date de début	Date-heure de début (en UTC) du segment. Type de champ : HORODATAGE
Date de fin	Date-heure de fin (en UTC) du segment. Type de champ : HORODATAGE
Type de canal	Type d'interaction: Voix Conversation E-mail SVI Élément de travail SMS Canaux de messagerie : Facebook Messenger, WhatsApp, Apple Messages for Business, (Apple Business Chat), LINE Messagerie, Telegram Messenger, Viber Messenger, Personnalisé, Microsoft Teams, Slack. Canaux sociaux publics : Facebook, Google Lieux, Google Play, LinkedIn, YouTube, Apple Avis sur les applications, Personnalisé (public). Type de champ : chaîne avec jusqu’à 150 caractères (VARCHAR)
Enregistrement de l’écran	Si le segment comprend l'enregistrement d'écran: Oui Non
État de l'enregistrement vocal	Statut de l'enregistrement: Succès Partiellement enregistré : certaines parties de ce segment n’ont pas été enregistrées, mais l’interaction peut toujours être lue Ne correspond à aucune politique : aucun enregistrement : aucune des politiques d'enregistrement n'a été déclenchée par cette interaction Non enregistré en raison du pourcentage d'enregistrement : aucun enregistrement : une politique d'enregistrement a été déclenchée par cette interaction, mais n'a pas été enregistrée en raison du pourcentage d'enregistrement défini dans la politique Politique de non-enregistrement : aucun enregistrement : une politique de non-enregistrement a été déclenchée pour cette interaction Consentement refusé dans le système de réponse vocale interactive (RVI) : pas d’enregistrement Échec : pas d’enregistrement Masqué : Aucun enregistrement – l'enregistrement a été masqué Transferts d’enregistrements aux numéros externes non sélectionnés : pas d’enregistrement Peut être enregistré (voix) non sélectionné : aucun enregistrement - l'attribut Agent Peut être enregistré (voix) n'a pas été sélectionné Type de champ : chaîne avec jusqu’à 250 caractères (VARCHAR)
Statut d'enregistrement d'écran	Statut de l'enregistrement: Succès Partiellement enregistré : certaines parties de ce segment n’ont pas été enregistrées, mais l’interaction peut toujours être lue Ne correspond à aucune politique : aucun enregistrement : aucune des politiques d'enregistrement n'a été déclenchée par cette interaction Non enregistré en raison du pourcentage d'enregistrement : aucun enregistrement : une politique d'enregistrement a été déclenchée par cette interaction, mais n'a pas été enregistrée en raison du pourcentage d'enregistrement défini dans la politique Politique de non-enregistrement : aucun enregistrement : une politique de non-enregistrement a été déclenchée pour cette interaction Consentement refusé dans le système de réponse vocale interactive (RVI) : pas d’enregistrement Échec : pas d’enregistrement Masqué : Aucun enregistrement – l'enregistrement a été masqué Type de champ : chaîne avec jusqu’à 250 caractères (VARCHAR)
Alertes d’enregistrement	Les alertes d'enregistrement incluent: ScreenAgent est inaccessible : ScreenAgent n'est pas configuré correctement ou n'est pas en cours d'exécution. Erreur d'enregistrement d'écran : L'appel peut ne pas être entièrement enregistré Erreur d’enregistrement de l’écran Erreur de configuration de la machine ScreenAgent Aucune connexion entre ScreenAgent et les écrans de l'agent Erreur de configuration du réseau de la machine ScreenAgent ScreenAgent n'a pas démarré l'enregistrement en raison de la configuration de la machine ScreenAgent n'a pas pu télécharger l'enregistrement en raison d'une configuration de certificat auto-signé Erreur de configuration du disque dur de la machine ScreenAgent ScreenAgent a atteint le nombre maximal d'appels parallèles L'enregistrement d'écran a atteint la durée maximale de l'appel Voir Résolution des problèmes de ScreenAgent. Enregistrement trop court: L'enregistrement d'écran est trop court. L'audio dure moins de 4 secondes et peut ne pas être enregistré. Aucune connexion au serveur multimédia : un problème est survenu avec le serveur multimédia, ce qui a entraîné l'absence d'enregistrement disponible. Cette erreur peut se produire pour diverses raisons, et la description de l'erreur pour l'alerte d'enregistrement fournit des informations plus détaillées. Pour la solution Multi-ACD (Open), cette erreur indique des événements SIP manquants du client. Cela peut signifier que l'invitation entière est manquante ou qu'un seul côté (Nearend ou Farend) est reçu. L’enregistreur vocal n’a pas pu enregistrer l’appel : pas d’enregistrement. Il y a eu un problème avec l’enregistreur vocal. Il peut exister plusieurs raisons. La description de l’erreur pour l’alerte d’enregistrement fournit des informations plus détaillées. Audio non disponible : données audio incomplètes : l’audio n’est pas disponible pour cette interaction (données audio incomplètes). Contactez le support CXone Mpower. Audio non disponible : paquets audio manquants : l’audio n’est pas disponible pour cette interaction (paquets audio manquants). Contactez le support CXone Mpower. Audio non disponible : paquets audio manquants depuis la source externe : l’audio n’est pas disponible pour cette interaction (paquets audio manquants dans le flux média). Contactez le support CXone Mpower. Erreur système : l’enregistrement n’a pas commencé ou autre erreur générale. Contactez le support CXone Mpower. Échec du masquage : échec du masquage de l’enregistrement. Vous pouvez lire l'enregistrement pour vérifier s'il existe des données sensibles. Pour supprimer l'enregistrement, cliquez sur action et sélectionnez Supprimer des enregistrements. Enregistrement arrêté à la demande : enregistrement arrêté par l’utilisateur.
Nom de la politique	Nom de la stratégie d'enregistrement ou ne pas enregistrer la stratégie qui a été appliquée à cette interaction. Type de champ : chaîne avec jusqu’à 100 caractères (VARCHAR)
ANI	Pour les appels entrants, ANI est le numéro de téléphone de l'appelant (identification de l'appelant). Type de champ : chaîne avec jusqu’à 200 caractères (VARCHAR)
DNIS	Pour les appels entrants, DNIS est le numéro de téléphone qui a été appelé (numéro composé). Type de champ : chaîne avec jusqu’à 200 caractères (VARCHAR)
ACW (en secondes)	Combien de secondes l'enregistrement d'écran s'est poursuivi après la fin de l'appel pour capturer le travail après l'appel de l'agent.
Disposition	Marquer les attributions d'agent avec des informations supplémentaires sur l'appel
ID segment externe	ID d’un segment tel que défini dans la source externe de l’enregistrement. Les valeurs sont uniquement disponibles pour les utilisateurs disposant de AppLink. Type de champ : chaîne avec jusqu’à 100 caractères (VARCHAR) Version de l’API : 6 au minimum
ID contact externe	ID d’un contact tel que défini dans la source externe de l’enregistrement. Les valeurs sont uniquement disponibles pour les utilisateurs disposant de AppLink. Type de champ : chaîne avec jusqu’à 100 caractères (VARCHAR) Version de l’API : 6 au minimum
Source	La source de l'enregistrement - CXone Mpower ou une source externe. Les valeurs sont les suivantes : Engager BrandEmbassy Uptivity InContactACD Multi-ACD MigratedCallsExternal MigratedCallsEngage MigratedCallsNim SmartReach Type de champ : chaîne avec jusqu’à 30 caractères (VARCHAR) Version de l’API : 6 au minimum
Liste des numéros de contact associés	Liste des numéros de contact des agents associés au segment. Les éléments de cette liste sont de type numérique uniquement. Type de champ : Variante Version de l’API : 7 au minimum
ID d’interaction	ID unique (UUID) pour une interaction. Lorsque plusieurs segments sont associés à une seule interaction, les segments peuvent avoir le même ID d’interaction. L’ID d’interaction ne doit pas être confondu avec l’ID de segment ou l’ID de contact. Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR) Version de l’API : 7 au minimum
Nombre d'appels en attente	Le nombre total de fois où l'agent a mis le client en attente pendant un appel. Version de l'API : 8 et supérieure
Durée de maintien en secondes	Le nombre total de secondes pendant lesquelles le client a été mis en attente lors d'un appel (la somme de toutes les mises en attente). Version de l'API : 8 et supérieure
Appel complexe	Indique si un appel comptait plusieurs participants. Type de champ : valeurs booléennes composées de VRAI ou FAUX (BOOLÉEN) Version de l'API : 9 et supérieure
État de masquage de l'enregistrement vocal	Indique l'état du masquage de l'enregistrement vocal pour une interaction. Type de champ : Chaîne Version de l'API : 10 et supérieure Les valeurs possibles sont : Succès : l'enregistrement vocal a été masqué avec succès Échec : Échec du masquage de l'enregistrement vocal Partiel : L'enregistrement vocal a été partiellement masqué NA : Non applicable
État de masquage de l'enregistrement d'écran	Indique l'état du masquage de l'enregistrement d'écran pour une interaction. Type de champ : Chaîne Version de l'API : 10 et supérieure Les valeurs possibles sont : Succès : l'enregistrement d'écran a été masqué avec succès Échec : Échec du masquage de l'enregistrement d'écran Partiel : L'enregistrement d'écran a été partiellement masqué NA : Non applicable
ID utilisateur de l'agent	Identifiant unique attribué à l'agent. Le fichier CSV contient ce champ sous forme de colonne distincte pour chaque agent, prenant en charge jusqu'à 5 agents. Exemples de noms de colonnes : `Agent 1 User ID, Agent 2 User ID, ..., Agent 5 User ID` Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR)
ID ACD de l'agent	Identifiant unique attribué à l'agent par l'ACD. Le fichier CSV contient ce champ sous forme de colonne distincte pour chaque agent, prenant en charge jusqu'à 5 agents. Exemples de noms de colonnes : `Agent 1 ACD ID, Agent 2 ACD ID, ..., Agent 5 ACD ID` Type de champ : chaîne avec jusqu’à 50 caractères (VARCHAR)
Numéro du contact de l’agent	Identifiant unique du contact créé pour cet agent. Ce champ n’est pas disponible pour Multi-ACD (Open). Le fichier CSV contient ce champ sous forme de colonne distincte pour chaque agent, prenant en charge jusqu'à 5 agents. Exemples de noms de colonnes : `Agent 1 Contact Number, Agent 2 Contact Number, ..., Agent 5 Contact Number` Type de champ : numérique avec jusqu’à 38 chiffres Version de l’API : 5 au minimum
Nom de l’agent	Nom de l'agent tel que spécifié dans leCXone Mpower compte d'employé. Le fichier CSV contient ce champ sous forme de colonne distincte pour chaque agent, prenant en charge jusqu'à 5 agents. Exemples de noms de colonnes : `Agent 1 Name, Agent 2 Name, ..., Agent 5 Name` Type de champ : chaîne avec jusqu’à 100 caractères (VARCHAR)
ID de l'équipe d'agent	Identifiant unique attribué à l'équipe de l'agent. Le fichier CSV contient ce champ sous forme de colonne distincte pour chaque agent, prenant en charge jusqu'à 5 agents. Exemples de noms de colonnes : `Agent 1 Team ID, Agent 2 Team ID, ..., Agent 5 Team ID` Type de champ : chaîne avec jusqu’à 36 caractères (VARCHAR UUID)
Équipe d'agents	Nom de l’équipe de l’agent. Le fichier CSV contient ce champ sous forme de colonne distincte pour chaque agent, prenant en charge jusqu'à 5 agents. Exemples de noms de colonnes : `Agent 1 Team, Agent 2 Team, ..., Agent 5 Team` Type de champ : chaîne avec jusqu’à 40 caractères (VARCHAR)
Compétences de l'agent	Classification attribuée à l'agent dans l'ACD, basée sur ses capacités, ses spécialités et ses connaissances. Le fichier CSV contient ce champ sous forme de colonne distincte pour chaque agent, prenant en charge jusqu'à 5 agents. Exemples de noms de colonnes : `Agent 1 Skills, Agent 2 Skills, ..., Agent 5 Skills` Type de champ : chaîne avec jusqu’à 50 caractères (VARCHAR)
Nom des données métier	Nom du champ des données métier, tel que spécifié. Le fichier CSV contient ce champ sous forme de colonne distincte pour chaque entrée de données d'entreprise : Pour les versions d'API 7 à , le fichier prend en charge jusqu'à 50 entrées : 35 de type varchar, 10 numériques et 5 booléens. Pour la version d'API 11, disponible pour les clients dans le cadre du programme Controlled Release (CR), le fichier prend en charge jusqu'à 250 entrées : 1 à 35 varchar, 36 à 45 numérique, 46 à 65 booléen, 66 à 95 date, 96 à 210 varchar, 211 à 250 numérique Exemples de noms de colonnes : `Business Data Name 1, Business Data Name 2, ..., Business Data Name 50` (ou jusqu’à `Business Data Name 250` pour CR) Type de champ : chaîne avec jusqu’à 128 caractères (VARCHAR) Version de l’API : 7 au minimum
Valeur des données métier	La valeur des données métier peut être au format texte, numérique ou vrai/faux. Le fichier CSV contient ce champ sous forme de colonne distincte pour chaque entrée de données d'entreprise : Pour les versions d'API 7 à , le fichier prend en charge jusqu'à 50 entrées : 35 de type varchar, 10 numériques et 5 booléens. Pour la version d'API 11, disponible pour les clients dans le cadre du programme Controlled Release (CR), le fichier prend en charge jusqu'à 250 entrées : 1 à 35 varchar, 36 à 45 numérique, 46 à 65 booléen, 66 à 95 date, 96 à 210 varchar, 211 à 250 numérique Exemples de noms de colonnes : `Business Data Value 1, Business Data Value 2, ..., Business Data Value 50` (ou jusqu’à `Business Data Value 250` pour CR) Type de champ : chaîne avec jusqu’à 4 000 caractères (VARCHAR) Valeur numérique contenant jusqu'à 38 chiffres (NUMÉRO) Valeurs booléennes composées de TRUE ou FALSE (BOOLEAN) Valeurs de date au format pris en charge (DATE) Version de l’API : 7 au minimum Les mises à jour des données commerciales effectuées plus de 2 jours après la création de l'interaction ne sont pas incluses dans la sortie de l'API d'extraction de données.

WFM Entité de paie et fichier CSV

Le WFM API de paie (version1) permet d'extraire WFM données d'activité à des fins de reporting externe de la paie.

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

Les données sont filtrées selon Date de code de paie. if it's clear, not need to doc)Gardez à l'esprit que le fuseau horaire de la date et de l'heure correspond au fuseau horaire de l'unité de planification.

Des champs dans le WFM Fichier CSV de paie

Nom de colonne	Description
Prénom	Prénom de l'agent. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Nom	Nom de famille de l'agent. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Nom d’utilisateur	Nom d'utilisateur de l'agent. Type de champ : chaîne avec jusqu’à 255 caractères (VARCHAR)
Unité de planification	Unité de planification de l'agent. Type de champ : chaîne avec jusqu’à 256 caractères (VARCHAR)
Fuseau horaire de l'unité de planification	Fuseau horaire de l'unité de planification de l'agent. Type de champ : chaîne avec jusqu’à 128 caractères (VARCHAR)
Code de paie	Le code de paie qui contient les données d'activité planifiées. Type de champ : chaîne avec jusqu’à 50 caractères (VARCHAR)
Date	Date (dans le fuseau horaire de l'unité de planification) de l'activité. Type de champ : DATE
Heure de début	Heure de début (dans le fuseau horaire de l'unité de planification) de l'activité. Type de champ : DATE/HEURE (9)
Durée en secondes	La durée de l'activité en secondes. Type de champ : NUMÉRIQUE (8,0)