Colas
Los métodos aquí indicados irán siempre firmados con la cabecera "X-Api-Key" al igual que el resto de métodos.
Obtener las colas disponibles en la centralita
GET /queue
Obtiene todas las colas del sistema así como los miembros de cada cola.
Ejemplo
- Petición
GET /queue
- Respuesta
[
{
"id": "ff80818168e5d9b70168e5d9edda00cb",
"name": "Cola 1",
"dpNumber": 1,
"dialplanNumber": "*651",
"members": [
{
"extensionId": "ff80818168e5d9b70168e5d9edb300c3",
"extensionUsername": "101",
"extensionName": "Agente 101"
},
{
"extensionId": "ff80818168e5d9b70168e5d9eda900c2",
"extensionUsername": "100",
"extensionName": "Agente 100"
}
]
},
{
"id": "ff80818168e5d9b70168e5d9eddf00cc",
"name": "Cola 2",
"dpNumber": 2,
"dialplanNumber": "*652",
"members": [
{
"extensionId": "ff80818168e5d9b70168e5d9eda900c2",
"extensionUsername": "100",
"extensionName": "Agente 100"
},
{
"extensionId": "ff80818168e5d9b70168e5d9edbc00c4",
"extensionUsername": "102",
"extensionName": "Agente 102"
},
{
"extensionId": "ff80818168e5d9b70168e5d9edb300c3",
"extensionUsername": "101",
"extensionName": "Agente 101"
}
]
}
]
Obtener el tiempo de espera medio de las llamadas atendidas
GET /queue/{queueNumber}/waittime
El parámetro de la url queueNumber es el número entero que define el número de cola (se puede consultar en la interfaz web)
Devolverá un JSON con el tiempo de espera medio de las llamadas atentidadas.
Permisos
Obtener los cambios de estado de los agentes de la centralita asignada a la Api Key utilizada.
Ejemplo:
Petición para obtener el tiempo de espera de la cola "1":
GET /queue/1/waittime
Respuesta:
{
"waitTime":136
}
Obtener las llamadas en cola
GET /queue/{queueId}/callers
El parámetro de la url {queueId} es el identificador de la cola, puede obtenerse en el primer método.
Devolverá un JSON con un array de las llamadas en cola
Campos de las llamadas
Nombre del campo | Descripción |
---|---|
uuid | id de llamada |
cidNumber | Número del llamante |
cidName | Nombre del llamante |
join | Cuándo entro en la cola, timestamp en milisengundos |
answer | Cuándo le descolgó un agente, timestamp en milisengundos |
abandoned | Cuándo se consideró abandonada la llamada, timestamp en milisengundos |
state | Estado de la llamada: Waiting/Answered/Abandoned |
score | Tiempo en segundos desde que entró en la cola |
servingAgent | Agente que esta atendiendo la llamada |
Permisos
Obtener los cambios de estado de los agentes de la centralita asignada a la Api Key utilizada.
Ejemplo:
Petición para obtener el tiempo de espera de la cola "1":
GET /queue/ff80818168e5d9b70168e5d9edda00cb/callers
Respuesta:
[
{
"uuid":"0f5b4a5f-d1bc-41f5-9489-8c1a3dbbecff",
"cidNumber":"600000000",
"cidName":"600000000",
"join":1497856540000,
"answer":1497857602000,
"abandoned":null,
"state":"Answered",
"score":1562,
"servingAgent":"a201@demo.vpbx.me"
},
{
"uuid":"e19be2f9-fc8e-45ca-814a-fe7ed0b18b04",
"cidNumber":"610000001",
"cidName":"610000001",
"join":1497856616000,
"answer":1497858089000,
"abandoned":null,
"state":"Answered","score":1486,
"servingAgent":"a202@demo.vpbx.me"
},
{
"uuid":"baba409e-7a83-405d-ade2-bca9b2c1791b",
"cidNumber":"911123123",
"cidName":"911123123",
"join":1497856649000,
"answer":null,
"abandoned":null,
"state":"Waiting",
"score":1453,
"servingAgent":""
}