Le SDK comprend une suite d'API, utilisée par l'intermédiaire d'une plateforme basée sur Java, qui facilite le transfert de données en temps réel et de données historiques depuis des ACD tiers vers NiCE CXone WFM. Ces API vous permettent de :
-
Gérer l’authentification API.
-
Récupérer le tiers.
-
Recevoir et traiter les données historiques intrajournalières et de compétences.
-
Recevoir et traiter les données des rapports d’activité des agents.
-
Recevoir et traiter les données relatives à l’état de l’agent.
-
Surveiller la connexion entre ACD et NiCE CXone WFM.
L'intégration prend en charge 15 minutes de données historiques et des données quasi en temps réel pour les états de l'agent de 3 secondes ou plus. Elle prend également en charge le Paradigme When Contact Ended (WCE), mais ne prend pas en charge le Paradigme True to Interval (TTI).
Le SDK ne prend pas en charge la création d'employés, d'Unités de planification et/ou le mappage des employés aux UP, la création de compétences WEM et leur mappage aux Compétences acd, ni l'exécution de toute configuration de WFM, y compris la création de Codes d'Activité et le mappage des Événements acd. Pour effectuer la configuration, consultez les liens ci-dessous :
La durée du rapport d'activité de l'agent est enregistrée dans l'intervalle pendant lequel l'Activité de l'agent est terminée. Ces informations apparaissent dans le Rapport de conformité de l'agent.
API dans ACD tiers
Les ACD tiers sont intégrés à NiCE CXone WFM au moyen d'un kit de développement logiciel (SDK). Cette trousse SDK est équipée d’API. Ces API facilitent le transfert de données en temps réel et de données historiques des ACD tiers vers NiCE CXone WFM. Ce processus se déroule de manière transparente, garantissant un flux de données et une intégration efficaces.
API d’authentification
Cette API obtient un jeton d’accès pour l’authentification.
Paramètres dans la demande
{
"tenantName": "string",
"accessKeyTokenRequest": {
"accessKeyId": "string",
"accessKeySecret": "string"
}
}
Exemple de valeur et de réponses
Exemple de valeur
{
"accessKeyTokenRequest": {
"accessKeyId": "ICIK6JQHUUZANCQ====",
"accessKeySecret": "3MMUKO7PCQ===="
}
}Réponses
{
"id_token": "",
"token_type": "Bearer",
"expires_in": 3600,
"refresh_token": "",
"access_token": ""
}
Cette API obtient un jeton d’actualisation pour l’authentification.
Paramètres dans la demande{
"token": "string",
"updateCookie": true,
"toggleEnabled": true
}
Exemple de valeur et de réponses
Exemple de valeur
{
"token": "use refresh token value from previous token request",
"updateCookie": true,
"toggleEnabled": false
}Réponses
{
"token": "",
"tokenExpirationTimeSec": 3600,
"refreshToken": "",
"refreshTokenExpirationTimeSec": 7200,
"sessionId": null
}API de rapport
Cette API permet d’obtenir le rapport d’activité de l’agent.
Paramètres dans la demande{
"acdType": "string",
"reportVersion": "string",
"startDate": "string",
"endDate": "string",
"reportData": [
{
"agentValue": "string",
"agentId": "string",
"userName": "string",
"agentActivity": [
{
"state": "string",
"startTime": "string",
"duration": 0,
"reason": "string"
}
]
}
]
}
Exemple de valeur et de réponses
Exemple de valeur
{
"acdType": "Generic_acdName",
"reportVersion": "0",
"startDate": "2024-01-15T16:45:00.000Z",
"endDate": "2024-01-15T17:00:00.000Z",
"reportData": [
{
"agentValue": "19837005",
"agentId": "11eb0706-b268-988f-811b-005056a15ae6",
"userName": "aa4rszz@mmm.com",
"agentActivity": [
{
"state": "CallContact",
"startTime": "2023-10-01T07:59:09.860Z",
"duration": 139090,
"reason": ""
}
]
}
]
}
Réponses
<<VIDE>>
Cette API reçoit et traite des données historiques intrajournalières et de compétences.
Paramètres dans la demande
{
"acdType": "string",
"reportVersion": "string",
"startDate": "string",
"endDate": "string",
"status": "string",
"statusReason": "string",
"reportData": {
"queueReport": [
{
"queueValue": "string",
"queueName": "string",
"isOutbound": true,
"rightPartyHandleTime": "Unknown Type: double",
"rightPartyContacts": 0,
"wrongPartyHandleTime": "Unknown Type: double",
"wrongPartyContacts": 0,
"holdTime": "Unknown Type: double",
"active": 0,
"contactsReceived": 0,
"abandonedShort": 0,
"abandonedLong": 0,
"handledShort": 0,
"handledLong": 0,
"handleTime": "Unknown Type: double",
"workTime": "Unknown Type: double",
"queueDelayTime": "Unknown Type: double",
"svcLvlPct": "Unknown Type: double",
"backlog": 0,
"backlogNotExpired": 0,
"backlogExpired": 0
}
]
}
}
Exemple de valeur et de réponses
Exemple de valeur
{
"acdType": "Generic_LiveVox",
"reportVersion": "0",
"startDate": "2024-04-17T10:00:12.000Z",
"endDate": "2024-04-17T10:15:12.000Z",
"status": "SUCCESS",
"statusReason": "",
"reportData": {
"queueReport": [
{
"queueValue": "8057",
"queueName": "ChatSkill_11",
"isOutbound": false,
"contactsReceived": 1,
"abandonedShort": 0,
"abandonedLong": 0,
"handledShort": 1,
"handledLong": 0,
"handleTime": 276,
"workTime": 3,
"queueDelayTime": 405,
"svcLvlPct": 100.0,
"rightPartyHandleTime": 0,
"rightPartyContacts": 0,
"wrongPartyHandleTime": 0,
"wrongPartyContacts": 0,
"backlog": 0,
"backlogNotExpired": 0,
"backlogExpired": 0,
"holdTime": 0,
"active": 0
},
{
"queueValue": "8056",
"queueName": "EmailSkill",
"isOutbound": false,
"contactsReceived": 1,
"abandonedShort": 0,
"abandonedLong": 0,
"handledShort": 1,
"handledLong": 10,
"handleTime": 276,
"workTime": 3,
"queueDelayTime": 10,
"svcLvlPct": 100.0,
"rightPartyHandleTime": 0,
"rightPartyContacts": 0,
"wrongPartyHandleTime": 0,
"wrongPartyContacts": 0,
"backlog": 0,
"backlogNotExpired": 0,
"backlogExpired": 0,
"holdTime": 0,
"active": 0
}
],
"agentQueueReport": [
{
"queueValue": "8056",
"queueName": "EmailSkill",
"isOutbound": false,
"agentValue": "967385",
"agentId": "11eceb46-1528-7bf0-8adf-0242ac110003",
"handled": 1,
"handledTime": 276,
"workTime": 3,
"rightPartyHandleTime": 0,
"rightPartyContacts": 0,
"wrongPartyHandleTime": 0,
"wrongPartyContacts": 0,
"holdTime": 0,
"active": 0
},
{
"queueValue": "8057",
"queueName": "ChatSkill_11",
"isOutbound": false,
"agentValue": "967382",
"agentId": "11eceb46-1527-7bf0-8adf-0242ac110002",
"handled": 1,
"handledTime": 276,
"workTime": 3,
"rightPartyHandleTime": 0,
"rightPartyContacts": 0,
"wrongPartyHandleTime": 0,
"wrongPartyContacts": 0,
"holdTime": 0,
"active": 0
}
],
"agentSystemPerformanceReport": [
{
"agentValue": "945987",
"agentId": "11e9f619-855d-0dc7-80e6-005056a16bed",
"readyTime": 0,
"notReadyTime": 0,
"loginTime": 900
},
{
"agentValue": "945988",
"agentId": "11e9f619-855e-0ec7-80e6-005089a16bed",
"readyTime": 10,
"notReadyTime": 9,
"loginTime": 900
}
]
}
}Réponses
<<VIDE>>
API d’état de l’agent
Cette API reçoit et traite les données relatives à l’état de l’agent.
Paramètres dans la demande
{
"agentStateList": [
{
"loginId": "string",
"acdId": "string",
"eventCode": "string",
"reasonCode": "string",
"eventUtcTime": "string"
}
]
}
Exemple de valeur et de réponses
Exemples de valeurs
{
"agentStateList": [
{
"loginId": "aa4rszz@mmm.com",
"acdId": "Tenant_Name",
"eventCode": "CallContact",
"reasonCode": "",
"eventUtcTime": "2023-10-01T07:59:09.860Z"
}
]
}
Responses
<<EMPTY>>
Réponses
<<VIDE>>