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 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 Management (CXone) ou des données de Paie WFM. Les données ne peuvent être filtrées qu'en fonction de la période spécifiée. Les données de Quality Management sont transmises à l'API d'extraction de données toutes les 15 minutes.

Vous pouvez essayer les API d'extraction de données et consulter leur documentation dans le portail des développeurs.

Lorsque vous appelez 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 retourne l'état du travail. Si l'état est réussite, une URL supplémentaire est également retourné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 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 NiCE CXone sur le portail des développeurs . Connectez-vous avec un compte NiCE CXone, puis vous pourrez faire des demandes avec le locataire 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 démarrer l'utilisation des API, vous devez vous enregistrer auprès de NiCE afin de recevoir des identifiants valides utilisés pour l'authentification. Revoyez la Page Démarrage sur le portail des développeurs pour connaître les instructions.

L'utilisation de ces API nécessite 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 les 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 les 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 les données de Paie WFM, vous devez disposer de l'autorisation WFM > API d'extraction de données > WFM API de Paie.
- Si vous extrayez les notes de l'évaluateur QM, vous devez disposer de l'autorisation QM Outils > API d'extraction de données > API des notes d'Évaluateur QM.

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

Méthode: GET

Terminal: /data-extraction/v1/jobs

Paramètres : none (aucun)

Préparer les 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é.

Méthode : POST

Terminal : /data-extraction/v1/jobs

Paramètres : none (aucun)

Exemple de valeur et de réponses

Corps de demande* :	application/json
exportRequest { description:	Paramètres à fournir pour extraire les données.
entityName	string Nom de l'entité à extraire. Pour les noms d'entités corrects, voir ci-dessous.
version	string Version de l'entité à extraire. Pour les versions correctes pour chaque entité, voir ci-dessous.
startDate	string($date) Date, en UTC, à partir de laquelle démarrer l'extraction des données. Le format de date est <YYYY-MM-DD>. Par exemple, pour extraire les données à partir du 22 mai 2019, entrez la date : 2019-05-22.
endDate	string($date) Date, en UTC, à partir de laquelle arrêter l'extraction des données. Le format de date est <YYYY-MM-DD>. 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. Travail asynchrone exporté avec succès.

string

Exemple : 12345d5h-c099-9303-j99j-w3ko9ppp1234
Statut 400 - demande non valide. filtres de date incorrects, etc.
Statut 401 - Non autorisé. Informations d’identification non valides.
Statut 403 - Interdit. L'utilisateur n'a pas l'autorisation d'afficher l'état du travail.
Statut 404 - Introuvable. entité manquante ou version non valide.
État 500 - Erreur de serveur interne.

Obtenir des travaux 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).

Méthode : GET

Terminal : /data-extraction/v1/jobs

Paramètres :

jobId*:

string

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

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é. Informations d’identification non valides.
Statut 403 - Interdit. L'utilisateur ne dispose pas de l'autorisation nécessaire pour afficher l'état de la tâche.
Statut 404 - Introuvable. entité manquante ou version non valide.
État 500 - Erreur de serveur interne.

QM Entité Workflow et CSV File

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 selon la Date de soumission (en UTC).

Champs du Fichier csv de flux de travail QM

Nom de colonne	Description
Nom du locataire	Nom du locataire.
ID de l’agent	Identifiant unique de l'agent. Type de Champ : Chaîne de caractères jusqu'à 36 caractères (VARCHAR)
Catégorie	Type d'évaluation, par exemple: Évaluation Auto-évaluation Type de Champ : Chaîne de caractères jusqu'à 24 caractères (VARCHAR)
Déclencheur du Flux d'évaluation	Événement qui a commencé l'évaluation : Calibrage Collaboratif Manuel QP Type de Champ : Chaîne de caractères jusqu'à 24 caractères (VARCHAR)
Statut du flux de travail	Statut du travail : Envoyé à l'agent En révision Contestation Terminé confirmé Auto-évaluation terminée Terminé avec révision Aucun examen terminé Terminé Supprimé Supprimé - terminé Expiré Supprimé - Expiré Supprimé - terminé confirmé Supprimé - terminé avec révision Supprimé - terminé sans révision Type de Champ : Chaîne de caractères jusqu'à 128 caractères (VARCHAR)
Accusé de réception automatique	Les valeurs possibles sont : VRAI : Si l’agent n’a pas accusé réception de l’évaluation, celle-ci 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 : Open Closed Expiré Type de Champ : Chaîne de caractères jusqu'à 128 caractères (VARCHAR)
ID du flux de travail (workflow)	L'identifiant unique de l'évaluation. type de Champ : Chaîne de caractères jusqu'à 36 caractères (VARCHAR) Version de l’API : 3 et plus
Nom du Plan	Le nom du plan qualité utilisé pour lancer cette évaluation. Type de Champ : Chaîne de caractères jusqu'à 128 caractères (VARCHAR)
Nom du Formulaire	Le nom du formulaire utilisé pour cette évaluation. Type de Champ : Chaîne de caractères jusqu'à 256 caractères (VARCHAR)
Version du formulaire	La version du formulaire d'évaluation utilisée pour cette évaluation. Type de Champ : Nombre (4,0)
Date de début	Date et heure (en UTC) du début de cette évaluation. Type de Champ : TIMESTAMP_LTZ(3)
Date de soumission	Date et heure (en UTC) auxquelles cette évaluation a été soumise. Type de Champ : TIMESTAMP_LTZ(3)
Dernière mise à jour	Estampille temporelle (en UTC) de la dernière modification de cette évaluation. Type de Champ : TIMESTAMP_LTZ(3) Dans le cas des appels, vous voulez extraire la Date de soumission, et non Dernière mise à jour.
Score - Pourcentage	Score d'évaluation en pourcentage. Type de Champ : FLOTTANT
Pointage	Score d'évaluation. Type de Champ : FLOAT
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 de caractères pouvant contenir jusqu’à 256 caractères (VARCHAR)
Échec de la question critique	Si la valeur est true (vrai), 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 (faux), l'utilisateur a répondu correctement à la question. Type de Champ : BOOLÉEN
Commentaires des utilisateurs	Les commentaires saisis par l'utilisateur (agent) lors de la contestation de l'évaluation. Type de Champ : chaîne de caractères pouvant contenir jusqu’à 256 caractères (VARCHAR)
Commentaires du résolveur de différends	Les commentaires saisis par l'utilisateur (gestionnaire / évaluateur) lors de la clôture du litige. Type de Champ : chaîne de caractères pouvant contenir jusqu’à 256 caractères (VARCHAR)
ID du segment	Id de segment de l'interaction en cours d'évaluation. Type de Champ : chaîne de caractères pouvant contenir jusqu’à 36 caractères (VARCHAR)
ID de l’ACD	Identifiant unique du distributeur automatique d'appels. Type de Champ : Nombre (38,0)
Type d'interaction	Type d'interaction : PHONE_CALL EMAIL CLAVARDAGE SMS WORKITEM GOOGLE_BUSINESS_MESSAGES_PRIVATE APPLE_BUSINESS_CHAT_PRIVATE TELEGRAM_PRIVATE LINE_PRIVATE WHATSAPP_PRIVATE SLACK_PRIVATE MICROSOFT_TEAMS_PRIVATE TW_PRIVATE VIBER_PRIVATE CUSTOM_PRIVATE WE_CHAT_PRIVATE FB_PRIVATE Type de Champ : chaîne de caractères pouvant contenir 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 : TIMESTAMP_LTZ(6)
Date de fin de l'interaction	Date-heure de fin (en UTC) de l'interaction. Type de Champ : TIMESTAMP_LTZ(6)
Direction d'interaction	Direction d'appel : Entrant Outbound (Sortant) Type de Champ : chaîne de caractères pouvant contenir jusqu’à 50 caractères (VARCHAR)
ID de l'équipe	L'identifiant unique de l'équipe de l'agent. Type de Champ : chaîne de caractères pouvant contenir jusqu’à 36 caractères (VARCHAR)
Nom de l’Équipe	Le nom de l’équipe de l’agent. Type de Champ : chaîne de caractères pouvant contenir jusqu’à 50 caractères (VARCHAR)
Numéro de Téléphone	Numéro de téléphone du client. Type de Champ : chaîne de caractères pouvant contenir jusqu’à 200. caractères (VARCHAR)
FirstName (Eva)	Prénom de l'évaluateur. Type de Champ : chaîne pouvant compter jusqu’à 255 caractères (VARCHAR)
LastName (Eva)	Nom de famille de l'évaluateur. Type de Champ : chaîne pouvant compter jusqu’à 255 caractères (VARCHAR)
FirstName (Agent)	Prénom de l'agent évalué. Type de Champ : chaîne pouvant compter jusqu’à 255 caractères (VARCHAR)
LastName (Agent)	Nom de famille de l'agent évalué. Type de Champ : chaîne pouvant compter jusqu’à 255 caractères (VARCHAR)
FirstName (Disp)	Prénom du résolveur de litige. Type de Champ : chaîne pouvant compter jusqu’à 255 caractères (VARCHAR)
LastName (Disp)	Nom de famille du résolveur de litige. Type de Champ : chaîne pouvant compter jusqu’à 255 caractères (VARCHAR)
FirstName (Assigner)	Prénom de l'utilisateur qui a attribué l'évaluation. Type de Champ : chaîne pouvant compter jusqu’à 255 caractères (VARCHAR)
LastName (Assigner)	Nom de famille de l'utilisateur qui a attribué l'évaluation. Type de Champ : chaîne pouvant compter jusqu’à 255 caractères (VARCHAR)
Raison	Raison de la suppression de l'évaluation. Type de Champ : chaîne pouvant compter jusqu’à 128 caractères (VARCHAR) Version de l’API : 4 et plus
ID Parent	ID de flux de travail parent de l'évaluation, tel que collaboratif et calibrage. Type de Champ : chaîne pouvant compter jusqu’à 36 caractères (VARCHAR) Version de l’API : 4 et plus
Sujet d'évaluation	Les valeurs possibles sont : Employé segment Type de Champ : chaîne pouvant compter jusqu’à 128 caractères (VARCHAR) Version de l’API : 4 et plus

QM Entité et Fichier csv des questions et réponses (Q&A)

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

Pour le travail POST :

entityName est: qm-questions
la version est : 2

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

Champs du Fichier csv Q&A QM

Nom de colonne	Description
Id de question	Identifiant unique de la question. Type de Champ : Nombre (38,0)
Titre de question	Le texte de la question. Type de Champ : chaîne de caractères 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 de caractères jusqu'à 15 caractères (VARCHAR)
Réponse	La réponse de l'évaluateur à la question. Type de Champ : chaîne de caractères 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 du formulaire	Identifiant unique du formulaire d'évaluation. Type de Champ : chaîne de caractères jusqu'à 36 caractères (VARCHAR)
Nom du Formulaire	Le nom du formulaire utilisé pour cette évaluation. Type de Champ : chaîne de caractères jusqu'à 256 caractères (VARCHAR)
Version du formulaire	La version du formulaire d'évaluation utilisée pour cette évaluation. Type de Champ : Nombre (4,0)
Date de début de l'évaluation	Date et heure (en UTC) du début de cette évaluation. Type de Champ : TIMESTAMP_LTZ(3)
Date de soumission de l'évaluation	Date et heure (en UTC) auxquelles cette évaluation a été soumise. Type de Champ : TIMESTAMP_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 de caractères jusqu'à 24 caractères (VARCHAR)
ID de section	Unique identifier of the section in evaluation form. Type de Champ : Nombre (38,0)
Section titre	Le nom de la section dans le formulaire d'évaluation. Type de Champ : chaîne de caractères jusqu'à 2048 caractères (VARCHAR)
Scorable	Indicateur vrai ou faux pour savoir si la question peut être notée. Type de Champ : BOOLÉEN
Score actuel	Le score que l'agent a reçu sur la question. Type de Champ : FLOTTANT
Note de la section (%)	Le score en pourcentage de la section où se trouvait la question. Type de Champ : FLOTTANT
Score maximum	Le score maximum qu'un agent aurait pu obtenir sur la question. Type de Champ : FLOTTANT
ID de l’agent	Identifiant unique de l'agent. Type de Champ : chaîne de caractères comportant jusqu'à 36 caractères (VARCHAR)
FirstName (Agent)	Prénom de l'agent évalué. Type de Champ : chaîne de caractères comportant jusqu'à 255. caractères (VARCHAR)
LastName (Agent)	Nom de famille de l'agent évalué. Type de Champ : chaîne de caractères comportant jusqu'à 255. caractères (VARCHAR)
ID de l'équipe	L'identifiant unique de l'équipe de l'agent. Type de Champ : chaîne de caractères comportant jusqu'à 36 caractères (VARCHAR)
Nom de l’Équipe	Le nom de l’équipe de l’agent. Type de Champ : chaîne de caractères comportant jusqu'à 50 caractères (VARCHAR)
FirstName (Eva)	Prénom de l'évaluateur. Type de Champ : chaîne de caractères comportant jusqu'à 255. caractères (VARCHAR)
LastName (Eva)	Nom de famille de l'évaluateur. Type de Champ : chaîne de caractères comportant jusqu'à 255. caractères (VARCHAR)
Critique	Indicateur vrai ou faux pour si la question était une question critique. Type de Champ : BOOLÉEN
Échec de la question critique	Si la valeur est true (vrai), 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 (faux), 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 Liste déroulante Date/Heure Type de Champ : chaîne de caractères comportant jusqu'à 64 caractères (VARCHAR)
Id de segment	Id de segment de l'interaction en cours d'évaluation. Type de Champ : chaîne de caractères comportant jusqu'à 36 caractères (VARCHAR)
Date de début d'interaction	Date-heure de début (en UTC) de l'interaction. Type de Champ : TIMESTAMP_LTZ(6)
Date de fin de l'interaction	Date-heure de fin (en UTC) de l'interaction. Type de Champ : TIMESTAMP_LTZ(6)
ID de WorkflowInstance	L'identifiant unique de l'évaluation. Type de Champ : chaîne de caractères comportant jusqu'à 36 caractères (VARCHAR)
Note 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 de caractères comportant jusqu'à 36 caractères (VARCHAR)
Nom caché	L’indicateur TRUE masque les questions et l’indicateur FALSE les affiche. Lorsque vous utilisez la règle QM Form dans un formulaire de qualité, elle masque une question de suivi selon le score d’une question précédente. Type de Champ : BOOLÉEN Version de l’API : 2 et plus

QM Notes de l’Évaluateur 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 selon la Date de soumission (en UTC).

Champs dans le Fichier csv des notes de l’évaluateur QM

Nom de colonne	Description
ID du commentaire	L’identifiant unique du commentaire. Type de Champ : Chaîne comportant jusqu’à 36 caractères (VARCHAR)
Commentaires	Le texte du commentaire. Type de Champ : Chaîne comportant jusqu’à 300 caractères (VARCHAR)
Date et heure du commentaire	Date et heure auxquelles le commentaire a été ajouté. Type de Champ : TIMESTAMP_LTZ(3)
Activité	Nom de l’action d’évaluation lors de l’ajout du commentaire. Type de Champ : Chaîne comportant jusqu’à 50 caractères (VARCHAR)
ID de l’auteur du commentaire	L’identifiant unique de l’utilisateur qui a ajouté le commentaire. Type de Champ : Chaîne comportant jusqu’à 36 caractères (VARCHAR)
Prénom de l’auteur du commentaire	Prénom de l’utilisateur qui a ajouté le commentaire. Type de Champ : Chaîne comportant jusqu’à 255 caractères (VARCHAR)
Nom de l’auteur du commentaire	Nom de famille de l’utilisateur qui a ajouté le commentaire. Type de Champ : Chaîne comportant jusqu’à 255 caractères (VARCHAR)
Id de question	L’identifiant unique de la question. Type de Champ : Chaîne comportant jusqu’à 36 caractères (VARCHAR)
Titre de question	Le texte de la question. Type de Champ : Chaîne comportant jusqu’à 2048 caractères (VARCHAR)
ID du formulaire	L’identifiant unique du formulaire d’évaluation. Type de Champ : Chaîne comportant jusqu’à 36 caractères (VARCHAR)
Nom du Formulaire	Le nom du formulaire utilisé pour l’évaluation. Type de Champ : Chaîne comportant jusqu’à 256 caractères (VARCHAR)
Version du formulaire	La version du formulaire d’évaluation utilisée pour l’évaluation. Type de Champ : Nombre (4,0)
ID du flux de travail (workflow)	L'identifiant unique de l'évaluation. Type de Champ : Chaîne comportant jusqu’à 36 caractères (VARCHAR)
Statut du flux de travail	L’état du flux de travail. Type de Champ : chaîne de caractères jusqu’à 128 caractères (VARCHAR)
ID de l’agent	L’identifiant unique de l’agent. Type de Champ : chaîne de caractères jusqu’à 36 caractères (VARCHAR)
FirstName (Agent)	Prénom de l’agent. Type de Champ : chaîne de caractères jusqu’à 255 caractères (VARCHAR)
LastName (Agent)	Nom de famille de l’agent. Type de Champ : chaîne de caractères jusqu’à 255 caractères (VARCHAR)
Id de l’équipe	L'identifiant unique de l'équipe de l'agent. Type de Champ : chaîne de caractères jusqu’à 36 caractères (VARCHAR)
Nom de l’Équipe	Le nom de l’équipe de l’agent. Type de Champ : chaîne de caractères 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 des métadonnées d’interaction Recording Management (CXone).

Pour le travail POST :

entityName est: recording-interaction-metadata
version est : 12
Pour filtrer les données par date et heure, utilisez startDate et endDate en UTC avec le format : yyyy-mm-dd 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, il s’agit du même identifiant que l’NiCE CXoneId du contact principal L’ID principal ou parent pour un ou plusieurs contacts associés. Un nouvel ID de contact principal est attribué si un contact est transféré trois fois ou plus.. Type de Champ : Numéro contenant jusqu’à 38 chiffres
ID du segment	Identifiant unique du segment. Un segment est une interaction avec deux utilisateurs, comme un client et un agent. Type de Champ : chaîne de caractères jusqu’à 36 caractères (VARCHAR UUID)
Raison du début du segment	Raison pour laquelle le segment a commencé : Conférence IVR/SRVI Segment : Premier segment du contact Transfert Contact Élevé Transféré vers un numéro Externe Transfert externe Type de Champ : chaîne de caractères comptant jusqu'à 100 caractères (VARCHAR)
Raison de fin de segment	Raison pour laquelle le segment s'est terminé : Conférence IVR/SRVI Segment : Dernier segment du contact Transférer Contact Élevé Transféré vers un numéro Externe Transfert externe Type de Champ : chaîne de caractères comptant jusqu'à 100 caractères (VARCHAR)
Direction	Direction du segment : Entrant Outbound (Sortant) Internal (Interne) Inconnue Type de Champ : chaîne de caractères comptant jusqu'à 150 caractères (VARCHAR)
Date de début	Date et heure de début (en UTC) du segment. Type de Champ : HORODATAGE
Date de Fin	Date et heure de fin (en UTC) du segment. Type de Champ : HORODATAGE
Type de canal	Type d'interaction : Voix Clavardage courriel IVR/SRVI Élément de travail SMS Canaux de messagerie : Facebook Messenger, WhatsApp, Apple Messages for Business, (Apple Business Chat), LINE Messaging,Telegram Messenger, Viber Messenger, Custom, Microsoft Teams, Slack. Canaux sociaux Public : Facebook, Google Endroits, Google Play,LinkedIn, YouTube, Apple Apps Reviews, Custom (publique). Type de Champ : chaîne de caractères comptant jusqu'à 150 caractères (VARCHAR)
Vidéocapture d'écran	Si le segment comprend a vidéocapture d'écran : Oui Non
État de l'enregistrement vocal	État du Recording : Réussite Partiellement enregistré : des 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 ne pas enregistrer : aucun enregistrement; une politique de ne pas enregistrer a été déclenchée pour cette interaction Consentement refusé dans IVR : aucun enregistrement Échec : aucun enregistrement Masqué : aucun enregistrement; l’enregistrement a été masqué Transfert d’enregistrements vers les numéros externes non sélectionné : aucun enregistrement Peut être enregistré (voix) non sélectionné : aucun enregistrement; l’attribut de l’agent Peut être enregistré (voix) n’a pas été sélectionné Type de Champ : Chaîne de caractères jusqu'à 250 caractères (VARCHAR)
Statut de vidéocapture d'écran	Statut de l'enregistrement : Réussite Partiellement enregistré : des 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 ne pas enregistrer : aucun enregistrement; une politique de ne pas enregistrer a été déclenchée pour cette interaction Consentement refusé dans IVR : aucun enregistrement Échec : aucun enregistrement Masqué : aucun enregistrement; l’enregistrement a été masqué Type de Champ : Chaîne de caractères 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 de vidéocapture d’écran : Il se peut que l’appel ne soit pas entièrement enregistré. Erreur de vidéocapture d’écran Erreur de configuration de la machine ScreenAgent Aucune connexion entre ScreenAgent et les écrans de l’agent Erreur de configuration 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 réussi à téléverser l’enregistrement en raison de la configuration du certificat autosigné Erreur de configuration du disque dur de la machine ScreenAgent ScreenAgent a atteint le nombre maximum d’appels parallèles La vidéocapture d’écran a atteint la durée maximum de l’appel Consultez Résoudre les Problèmes de ScreenAgent . Enregistrement trop court : La vidéocapture d’écran est trop courte. L’audio dure moins de 4 secondes et il se peut qu’il ne soit pas enregistré. Aucune connexion au serveur multimédia : Un problème est survenu avec le serveur multimédia, ce qui fait qu’aucun enregistrement n’est disponible. Cette erreur peut survenir pour diverses raisons, et la description de l’erreur pour l’alerte d’enregistrement fournit des renseignements plus détaillés. Pour la solution Engagement Hub (Multi-ACD/Open), cette erreur indique que des événements SIP sont manquants du client. Cela pourrait signifier que l’Invite entier est manquant 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 y avoir 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). Communiquez avec le Soutien NiCE CXone. Audio non disponible : paquets audio manquants : L’audio n’est pas disponible pour cette interaction (paquets audio manquants). Communiquez avec le Soutien NiCE CXone. Audio non disponible : paquets audio manquants de la source externe : (fonctionnalité en version contrôlée) L’audio n’est pas disponible pour cette interaction (paquets audio manquants dans le flux média). Communiquez avec le Soutien NiCE CXone. Erreur système : L’enregistrement n’a pas démarré ou une autre erreur générale est survenue. Communiquez avec le Soutien NiCE CXone. É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 les 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 de caractères jusqu'à 100. caractères (VARCHAR)
EAN (enregistrement automatique des numéros, ANI en anglais)	Pour les appels entrants, EAN (ANI) est le numéro de téléphone de l'appelant (identification de l'appelant). Type de Champ : Chaîne de caractères 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 de caractères jusqu'à 200. caractères (VARCHAR)
ACW (en secondes)	Combien de secondes de vidéocapture d'écran s'est poursuivi après la fin de l'appel pour capturer le traitement de l'agent après l'appel.
Disposition	L'étiquette que l'agent attribue avec des informations supplémentaires sur l'appel.
Id de segment Externe	L’ID d’un segment tel que défini dans la source externe de l’enregistrement. Les valeurs ne sont disponibles que pour les utilisateurs avec Recording AppLink. Type de Champ : Chaîne de caractères jusqu'à 100. caractères (VARCHAR) Version de l’API : 6 et plus
Id du contact Externe	L’ID d’un contact tel que défini dans la source externe de l’enregistrement. Les valeurs ne sont disponibles que pour les utilisateurs avec Recording AppLink. Type de Champ : chaîne de caractères pouvant contenir jusqu’à 100 caractères (VARCHAR) Version de l’API : 6 et plus
Source	La source de l’enregistrement — NiCE CXone ou une source externe. Les valeurs comprennent : Engage BrandEmbassy Uptivity InContactACD Multi-ACD MigratedCallsExternal MigratedCallsEngage MigratedCallsNim Outbound Engagement (SmartReach) Type de Champ : chaîne de caractères pouvant contenir jusqu’à 30 caractères (VARCHAR) Version de l’API : 6 et plus
Liste des numéros de contact associés	Liste des numéros des contacts des Agents associés au Segment. Les éléments de cette liste sont uniquement de type nombre. Type de Champ : Variante Version de l’API : 7 et plus
Id d’interaction	Un id unique (UUID) pour une interaction. Lorsque plusieurs segments sont associés à une même interaction, les segments peuvent avoir le même Id d’interaction. L’Id d’interaction n’est pas le même que l’Id de segment ou l’Id du contact. Type de Champ : chaîne de caractères pouvant contenir jusqu’à 36 caractères (VARCHAR) Version de l’API : 7 et plus
Nombre de mises en attente	The total number of times the agent placed the customer on hold during a call. Version de l’API : 8 et supérieures
Durée de mise en attente en Secondes	The total number of seconds that the customer was put on hold during a call (the sum of all holds). Version de l’API : 8 et supérieures
Appel Complexe	Indique si l'appel avait Multiple Participants. Type de Champ : Valeurs booléennes composées de VRAI ou FAUX (BOOLÉEN) API version : 9 et versions ultérieures
État du masquage de l'Enregistrement vocal	Indique l'état du masquage de l'enregistrement vocal pour une interaction. Type de Champ : Chaîne API version : 10 et versions ultérieures Les valeurs possibles sont : Réussite : L'Enregistrement vocal a été masqué avec succès Échec : Le masquage de l'Enregistrement vocal a échoué Partiel : L'Enregistrement vocal a été partiellement masqué NA : Sans objet
État du masquage de l'enregistrement d'écran	Indique l'état du masquage de l'enregistrement d'écran pour une interaction. Type de Champ : Chaîne API version : 10 et versions ultérieures Les valeurs possibles sont : Réussite : L'enregistrement d'écran a été masqué avec succès Échec : le masquage de l'enregistrement d'écran a échoué Partiel : l'enregistrement d'écran a été partiellement masqué NA : Sans objet
ID utilisateur de l'agent	Identifiant unique attribué à l'agent. Le Fichier csv contient ce champ comme 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 de caractères pouvant contenir jusqu'à 36 caractères (VARCHAR)
ID ACD de l'agent	Identifiant unique attribué à l'agent par l'ACD. Le Fichier csv contient ce champ comme 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 de caractères pouvant contenir jusqu'à 50 caractères (VARCHAR)
Numéro de contact de l'agent	Identifiant unique du contact créé pour cet agent. Ce champ n’est pas disponible pour Engagement Hub (Multi-ACD/Open). Le Fichier csv contient ce champ comme 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éro contenant jusqu’à 38 chiffres Version de l’API : 5 et plus
Nom de l’agent	Nom de l'agent tel que spécifié dans le compte employé NiCE CXone. Le Fichier csv contient ce champ comme 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 de caractères comportant 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 de caractères comportant jusqu'à 36 caractères (VARCHAR UUID)
Équipe d'agents	Le 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 de caractères comportant 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 Compétences, Agent 2 Compétences, ..., Agent 5 Compétences` Type de Champ : chaîne de caractères comportant jusqu'à 50 caractères (VARCHAR)
Nom des Données commerciales	Nom du champ de données commerciales tel que spécifié. Le Fichier csv contient ce champ sous forme de colonne distincte pour chaque entrée de données commerciales : Pour les versions API 7 à 10, le fichier prend en charge jusqu'à 50 entrées : 35 varchar, 10 numérique et 5 Booléen Pour la version API 11, 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 Exemple de noms de colonnes : `Nom des Données commerciales 1, Nom des Données commerciales 2, ..., Nom des Données commerciales 50` (ou jusqu'à `Nom des Données commerciales 250` pour CR) Type de Champ : Chaîne de 128 caractères maximum (VARCHAR) Version de l’API : 7 et plus
Valeur des Données commerciales	La valeur des données commerciales peut être un texte, un nombre ou vrai/faux. Le Fichier csv contient ce champ sous la forme d'une colonne distincte pour chaque entrée de données commerciales : Pour les versions API 7 à 10, le fichier prend en charge jusqu'à 50 entrées : 35 varchar, 10 numérique et 5 booléen Pour la version API 11, le fichier prend en charge jusqu'à 250 entrées : de 1 à 35 varchar, de 36 à 45 numérique, de 46 à 65 booléen, de 66 à 95 date, de 96 à 210 varchar, de 211 à 250 numérique Exemple de noms de colonnes : `Valeur des Données commerciales 1, Valeur des Données commerciales 2, ..., Valeur des Données commerciales 50` (ou jusqu'à `Valeur des Données commerciales 250` pour CR) Type de Champ : Chaîne de 4 000 caractères maximum (VARCHAR) Valeur numérique contenant jusqu'à 38 chiffres (NUMBER) Valeurs booléennes composées de VRAI ou FAUX (BOOLÉEN) Valeurs de date dans un format pris en charge (DATE) Version de l’API : 7 et plus
Adresse du client	Contient multiple valeurs ANI et DNIS pour un segment d'interaction unique, prenant en charge les scénarios où multiple clients sont impliqués dans un même appel. . Les valeurs sont stockées sous forme de Tableau, par exemple : ['ANI1', 'ANI2', 'ANI3'] Pour les appels entrants, le champ contiendra toutes les valeurs ANI sous forme de chaîne séparée par des virgules. Pour les appels sortants, le champ contiendra toutes les valeurs DNIS sous forme de chaîne séparée par des virgules. Type de Champ : Tableau de chaînes de 200 caractères maximum (VARCHAR) Version API : 12 et plus
Nom du système téléphonique	Indique le système téléphonique tiers à partir duquel les appels sont lancés. Type de Champ : chaîne de caractères pouvant contenir jusqu'à 50 caractères (VARCHAR) Version de l'API : 12

WFM Entité de Paie et Fichier csv

L'WFM API de Paie (version1) vous permet d'extraire des données d'activité WFM à des fins de production de rapports de paie externes.

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.

Champs du Fichier csv de la Paie WFM

Nom de colonne	Description
Prénom	Prénom de l'agent. Type de Champ : chaîne de caractères pouvant contenir jusqu'à 255 caractères (VARCHAR)
Nom de famille	Nom de famille de l'agent. Type de Champ : chaîne de caractères pouvant contenir jusqu'à 255 caractères (VARCHAR)
Username	Nom d'utilisateur de l'agent. Type de Champ : chaîne de caractères pouvant contenir jusqu'à 255 caractères (VARCHAR)
Unités de planification	Unité de planification de l'agent. Type de Champ : chaîne de caractères pouvant contenir 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 de caractères pouvant contenir jusqu'à 128 caractères (VARCHAR)
Code de paie	Code de paie contenant les données d’activité programmée. Type de Champ : chaîne de caractères pouvant contenir 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émarrage	Heure de début (dans le fuseau horaire de l'unité de planification) de l'activité. Type de Champ : TEMPS (9)
Durée en Secondes	La durée de l'activité en secondes. Type de Champ : Nombre (8,0)