API Reportes WFM
- Carina Soca
Analytics
Con nuestra API puede interactuar mediante diversos canales, y así mantener su contat center siempre conectado.
Recordar que para poder usar la API se necesita.
Autenticarse y obtener un token para la sesión.
Usar el token en el Header Authorization.
Finalizar sesión.
Estadísticas de Campañas
Listado de métricas de una o varias campañas entre un periodo e intervalo determinado.
Puedes consultar las métricas disponibles aquí.
Considerar:
Fecha desde y hasta son obligatorias.
Debes enviar una campaña, como mínimo.
Las métricas son opcionales, retornarán todas por defecto.
El intervalo es opcional, por defecto son de 15 minutos.
Invocación:
https://dominio.ucontactcloud.com/Integra/resources/WFMApi/campaigns
Método: GET
Content-type: application/json; charset=UTF-8
Parámetros: from (Fecha desde en formato YYYY-MM-DD HH:mm)
to (Fecha hasta en formato YYYY-MM-DD HH:mm)
campaigns (Lista de campañas separadas por coma en formato canal-Campaña Ejemplo: sms-WhatsApp_Consultas,webchat-AtencionAlCliente,...)
metrics (Lista de métricas separadas por coma Ejemplo: arts,inMessages,serviceLevel,...)
interval (Intervalo 15, 30 o 60)
Respuesta: Formato JSONEjemplo de solicitud:
curl --location --request GET 'https://dominio.ucontactcloud.com/Integra/resources/WFMApi/campaigns?from=2021-06-10%2000:00&to=2021-06-10%2023:00&metrics=&campaigns=sms-WhatsApp_Campaign&interval=30' \
--header 'Authorization: Basic YXBpOjgzYTk1YzMwLWYyMjYtNDBkYS04NTc5LWZjYmMxMjAzZDE0NQ==' \
--header 'Content-Type: application/json; charset=UTF-8'Ejemplo de respuesta:
[
{
"date": "2021-06-10 00:00",
"campaign": "WhatsApp_Campaign",
"channel": "sms",
"data": {
"arts": 713.86,
"inMessages": 5,
"outMessages": 15,
"serviceLevel": 0.0,
"inInteractions": 0,
"averageHoldTime": 650.25,
"outInteractions": 0,
"transferedAgents": 0,
"averageAttendedTime": 5947.665,
"transferedCampaigns": 0,
"averageFirstResponse": 0.835,
"attendedInInteractions": 2,
"completedInInteractions": 4,
"completedOutInteractions": 0,
"averageTimeInInteractions": 5949.665,
"averageTimeOutInteractions": 0.0
}
},
{
"date": "2021-06-10 00:30",
"campaign": "WhatsApp_Campaign",
"channel": "sms",
"data": {
"arts": 596.0,
"inMessages": 8,
"outMessages": 9,
"serviceLevel": 50.0,
"inInteractions": 2,
"averageHoldTime": 0.5,
"outInteractions": 0,
"transferedAgents": 0,
"averageAttendedTime": 1009.75,
"transferedCampaigns": 0,
"averageFirstResponse": 0.25,
"attendedInInteractions": 1,
"completedInInteractions": 2,
"completedOutInteractions": 0,
"averageTimeInInteractions": 1010.75,
"averageTimeOutInteractions": 0.0
}
}
]
Estadísticas de Agentes
Listado de métricas de uno o más agentes entre un periodo e intervalo determinado.
Invocación:
Ejemplo de solicitud:
Ejemplo de respuesta:
Estadísticas de Interacciones
Listado de métricas de interacciones de una o más campañas entre un periodo determinado.
Invocación:
Ejemplo de solicitud:
Ejemplo de respuesta: