SDK
O SDK inclui um conjunto de API, consumidas por meio de uma plataforma baseada em Java, que facilita a transferência de dados em tempo real e históricos de ACDs de terceiros para NiCE CXone WFM. Essas APIs permitem:
-
Lidar com a autenticação de API.
-
Recuperar o terceiro.
-
Receber e processar dados intradia e de histórico de competências.
-
Receber e processar dados do relatório de atividades do agente.
-
Receber e processar dados do estado do agente.
-
Monitore a conexão entre o ACD e o NiCE CXone WFM.
A integração oferece suporte a 15 minutos de dados históricos e dados quase em tempo real para estados DO agente de 3 segundos ou mais. Ela também oferece suporte ao Paradigma When Contact Ended (WCE), mas não oferece suporte ao Paradigma True to Interval (TTI).
O SDK não oferece suporte à criação de Funcionários, Unidades de agendamento e/ou ao mapeamento dos Funcionários para as unidades de agendamento, à criação de Competências WEM e ao seu mapeamento para Competências ACD, e à execução de qualquer Configuração WFM, incluindo a criação de Códigos DE atividade e o mapeamento dos Eventos ACD. Para realizar a configuração, consulte os links abaixo:
A duração do relatório de atividade do agente é registrada no intervalo durante o qual a Atividade do Agente é concluída. Essas informações aparecem no Relatório de adesão do Agente.
API em ACD de Terceiro
ACDs de terceiros são integrados ao NiCE CXone WFM por meio de um Kit de Desenvolvimento de Software (SDK). Esse SDK vem equipado com APIs. Essas API facilitam a transferência de dados em tempo real e históricos de ACDs de terceiros para NiCE CXone WFM. Esse processo ocorre de forma integrada, garantindo um fluxo de dados e uma integração eficientes.
API de autenticação
Essa API obtém um token de acesso para autenticação.
{
"tenantName": "string",
"accessKeyTokenRequest": {
"accessKeyId": "string",
"accessKeySecret": "string"
}
}
Valor de exemplo
{
"accessKeyTokenRequest": {
"accessKeyId": "ICIK6JQHUUZANCQ====",
"accessKeySecret": "3MMUKO7PCQ===="
}
}
Respostas
{
"id_token": "",
"token_type": "Bearer",
"expires_in": 3600,
"refresh_token": "",
"access_token": ""
}
Essa API obtém um token de atualização para autenticação.
{
"token": "string",
"updateCookie": true,
"toggleEnabled": true
}
Valor de exemplo
{
"token": "use refresh token value from previous token request",
"updateCookie": true,
"toggleEnabled": false
}
Respostas
{
"token": "",
"tokenExpirationTimeSec": 3600,
"refreshToken": "",
"refreshTokenExpirationTimeSec": 7200,
"sessionId": null
}
API de Relatório
Essa API obtém um relatório de atividade do agente.
{
"acdType": "string",
"reportVersion": "string",
"startDate": "string",
"endDate": "string",
"reportData": [
{
"agentValue": "string",
"agentId": "string",
"userName": "string",
"agentActivity": [
{
"state": "string",
"startTime": "string",
"duration": 0,
"reason": "string"
}
]
}
]
}
Valor de exemplo
{
"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": ""
}
]
}
]
}
Respostas
<<EMPTY>>
Essa API recebe e processa dados intradia e do histórico de competências.
{
"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
}
]
}
}
Valor de exemplo
{
"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
}
]
}
}
Respostas
<<EMPTY>>
API de estado do agente
Essa API recebe e processa dados de estado do agente.
{
"agentStateList": [
{
"loginId": "string",
"acdId": "string",
"eventCode": "string",
"reasonCode": "string",
"eventUtcTime": "string"
}
]
}
Valores de exemplo
{
"agentStateList": [
{
"loginId": "aa4rszz@mmm.com",
"acdId": "Tenant_Name",
"eventCode": "CallContact",
"reasonCode": "",
"eventUtcTime": "2023-10-01T07:59:09.860Z"
}
]
}
Responses
<<EMPTY>>
Respostas
<<EMPTY>>