Para utilizar a API do Callwe é necessário gerar um token de API.
API URL | /api/v1/report/complete_pause |
---|---|
Method |
GET |
Esta API coleta os dados do relatório completo de pausas.
Headers
token |
Token de autenticação da API. |
Parâmetros
start_date |
Data de inicio do período desejado. |
end_date |
Data do final do período desejado. |
limit |
Limite de dados por página. |
agent_id |
ID do agente. |
queue_id |
ID da fila. |
Todos os parâmetros são opcionais.
Os períodos são aceitos nos seguintes padrões: dd/mm/yyyy, yyyy-mm-dd ou iso8601.
O campo queue_id será ignorado caso seja informado o campo agent_id.
Exemplos de requisição
GET
URL: https://<SERVER NAME>.callwe.io/api/v1/report/complete_pause?start_date=2017-12-01&end_date=2017-12-27&limit=10&agent_id=1&token=<TOKEN>
cURL
curl -H "token:<TOKEN>" https://<SERVER NAME>.callwe.io/api/v1/report/complete_pause?start_date=<INICIO>&end_date=<FIM>
Exemplos de respostas
Sucesso
{
"data": [
{
"time_start": "2017-12-27T17:30:18+00:00",
"description": "10 minutos/NR17",
"time_end": "2017-12-27T17:59:49+00:00",
"agent": {
"login": "aline",
"id": 1,
"name": "Aline"
},
"limit": null,
"duration": 1771,
"overflow": 0
},
{
"time_start": "2017-12-27T17:59:53+00:00",
"description": "Almoço",
"time_end": "2017-12-27T17:59:55+00:00",
"agent": {
"login": "aline",
"id": 1,
"name": "Aline"
},
"limit": null,
"duration": 2,
"overflow": 0
},
{
"time_start": "2017-12-27T17:59:57+00:00",
"description": "Ativo",
"time_end": "2017-12-27T17:59:59+00:00",
"agent": {
"login": "aline",
"id": 1,
"name": "Aline"
},
"limit": null,
"duration": 2,
"overflow": 0
}
],
"pagination": {
"max_limit": 100,
"limit": 10,
"first_url":
"https://172.16.7.33/api/v1/report/complete_pause?limit=10&start_date=2017-12-01&end_date=2017-12-27&page=1",
"next_url": null,
"items": 3,
"last_url":
"https://172.16.7.33/api/v1/report/complete_pause?limit=10&start_date=2017-12-01&end_date=2017-12-27&page=1",
"total": 3,
"current_url":
"https://172.16.7.33/api/v1/report/complete_pause?limit=10&start_date=2017-12-01&end_date=2017-12-27&page=1",
"prev_url": null
},
"meta": {
"status": 200,
"message": "OK"
},
"params": {
"limit": "10",
"start_date": "2017-12-01",
"end_date": "2017-12-27"
}
}
Falhas
{"meta": {"status": 400, "message": "Missing token."}}
{"meta": {"status": 400, "message": "Missing to param."}}
{"meta": {"status": 400, "message": "Missing from param."}}