Para poder utilizar a API do Callwe, é necessário primeiro Gerar um Token.
|
Report URL |
/reports/calls_by_extension |
|
API URL |
/api/v1/report/calls_by_extension |
Atualmente, a maneira mais fácil de usar essa API é através do relatório original. Acessar a Report URL pela interface Web, escolher os filtros desejados e copiar os parâmetros GET que o relatório preenche na URL ao ser gerado.
https://example.callwe.io/reports/calls_by_extension?start_date=02%2F02%2F2017&end_date=02%2F02%2F2017&entity=extensions&extension_or_group=extensions&extension_numbers=all&generate_report=true&export_format=
Parâmetros GET da URL:
?start_date=02%2F02%2F2017&end_date=02%2F02%2F2017&entity=extensions&extension_or_group=extensions&extension_numbers=all&generate_report=true&export_format=
Acesso via API do Relatório (API URL)
curl 'http://example.callwe.io/api/v1/report/calls_by_extension?token=5fd17c78-95f4-42a9-afc3-2a67fdce0de9&start_date=01-07-2017&end_date=11-07-2017'
Parâmetros:
|
Parâmetro |
Possíveis Valores |
Necessário |
|
entity |
"extensions" ou "extensions_groups" (padrão: extensions) |
opcional |
|
extension_numbers |
lista com os númereos dos ramais (ex.: "5000,5001,5002") |
opcional |
|
extension_groups |
lista com os nomes dos grupos de ramais (ex.: "TestGroup,TestGroup2") |
opcional |
|
start_date |
datas no formato ISO 8601, "dd-mm-yyyy" ou "dd/mm/yyyy" |
necessário |
|
end_date |
datas no formato ISO 8601, "dd-mm-yyyy" ou "dd/mm/yyyy" |
necessário |
Retorno:
Relatório de chamadas por ramal
{
"data" : [
{
"total_calls" : 176,
"number" : "500",
"name" : "500",
"external_out" : 0,
"outbound" : 0,
"external_in" : 0,
"internal" : 176,
"total_duration" : 59502
},
{
"external_out" : 0,
"name" : "web600",
"number" : "600",
"total_calls" : 45,
"internal" : 45,
"total_duration" : 588,
"outbound" : 0,
"external_in" : 0
},
{
"number" : "601",
"name" : "web601",
"external_out" : 0,
"total_calls" : 25,
"total_duration" : 1043,
"internal" : 25,
"external_in" : 0,
"outbound" : 0
},
{
"number" : "501",
"name" : "501",
"external_out" : 0,
"total_calls" : 25,
"internal" : 25,
"total_duration" : 5201,
"external_in" : 0,
"outbound" : 0
}
],
"params" : {
"start_date" : "01-07-2017",
"end_date" : "11-07-2017",
"extension_or_group" : "extensions"
},
"meta" : {
"status" : 200,
"message" : "OK"
}
}
Relatório de chamadas por grupo de ramais
{
"params" : {
"end_date" : "11-07-2017",
"start_date" : "01-07-2017",
"extension_or_group" : "extensions_groups"
},
"meta" : {
"status" : 200,
"message" : "OK"
},
"data" : [
{
"total_duration" : 66334,
"total_calls" : 271,
"outbound" : 0,
"internal" : 271,
"external_in" : 0,
"external_out" : 0,
"name" : "TestGroup"
}
]
}