Agentes
Los métodos aquí indicados irán siempre firmados con la cabecera "X-Api-Key" al igual que el resto de métodos.
Obtener los agentes disponibles
GET /agent
Con éste método se obtendrá un array JSON con los agentes dados de alta en el sistema, la respuesta sería así:
[
{
"extension":"100",
"name":"a100",
"status":"AVAILABLE",
"breakType":null
},
{
"extension":"200",
"name":"a200",
"status":"AVAILABLE",
"breakType":null
}
]
Obtener los cambios de estado de una serie de agentes
Para hacer las peticiones de los cambios de estado de uno o varios agentes se deberá enviar con un POST un objeto JSON con el filtro que necesitemos.
Propiedades disponibles en el filtro
Nombre | Tipo | Valor por defecto | Opcional | Descripción |
---|---|---|---|---|
start | numérico | - | No | Fecha de inicio, timestamp en milisengundos |
end | numérico | - | No | Fecha fin, timestamp en milisegundos |
statuses | array de strings | Sí | Sí | Array con los valores que queremos filtrar |
agents | array de strings | Sí | Sí | Array con los agentes que queremos filtrar |
offset | numérico | 0 | No | En el método de count se ignora. De todos los registros existentes, desde dónde se empieza |
limit | numérico | 50 | No | En el método de count se ignora. A partir del offset, cuántos registros queremos |
Los "statuses" posibles son los indicados en Estados de un agente
Contar los registros existentes para un filtro
POST /agent/statuscount
Descripción
Devuelve en JSON la propiedad count indicando cuántos registros existen para el filtro pasado como JSON en el POST para poder paginar los resultados.
Permisos
Obtener los cambios de estado de los agentes de la centralita asignada a la Api Key utilizada.
Ejemplo:
Petición para filtrar el estado "ON_BREAK" en los agentes "201" y "202" el día 19/05/2017 (desde las 00:00 hasta las 23:59 horas)
{
"start":1495144800000,
"end":1495231200000,
"statuses": ["ON_BREAK"],
"agents": ["201","202"],
}
La respuesta sería:
{
"count": 2
}
Obtener los registros existentes para un filtro
POST /agent/status
Descripción
Devuelve en JSON con un array de los cambios de estado registrados para el filtro indicado pasado como JSON en el POST.
Permisos
Obtener los cambios de estado de los agentes de la centralita asignada a la Api Key utilizada.
Ejemplo:
Petición para filtrar el estado "ON_BREAK" en los agentes "201" y "202" el día 19/05/2017 (desde las 00:00 hasta las 23:59 horas)
{
"start":1495144800000,
"end":1495231200000,
"statuses": ["ON_BREAK"],
"agents": ["201","202"],
"offset": 0,
"limit": 2
}
La respuesta sería:
[
{
"agent":"201",
"date":1495189860000,
"status":"ON_BREAK",
"agentBreakType":"Gestión"
}
{
"agent":"202",
"date":1495189860000,
"status":"AVAILABLE",
"agentBreakType":null
}
]