3.1.22 Запрос статистики вызовов

Доступность запроса определяется наличием включенной услуги на продукте ВАТС API_VBPX_STAT

Для работы API v1 статистика в настройке ВАТС должен быть указан адрес внешней системы: PROD

https://api-client.mango-office.ru/api/v1

Получение статистики состоит из следующих этапов:

1. Запуск формирования статистики
2. Получение статистики

3.1.22.1 Запуск формирования статистики

POST /адрес/callstat/request?USER_ID={ext}&DATE={date} Header[X-Mango-API-Token, X-Mango-API-Salt]

Команда предназначена для запуска формирования статистики. Выходные данные генерируются системой API с учётом заданных параметров. Все параметры запроса обязательны.

В ответе приходит ключ, с помощью которого можно будет получить статистику по завершении ее построения.

Параметры запроса:

Пример запроса:

POST /адрес/callstat/request?USER_ID=8000&DATE=2017-08-28

Параметры ответа:

Возможны следующие HTTP коды ответа:

• 200 - Resultcode=0
• 400 - Ключ подписи не задан. Resultcode=103, Resultmessage="Salt not present"
• 400 - неверный ключ создания подписи. Resultcode=103, Resultmessage="Salt is incorrect"
• 400 - дата некорректная. Resultcode=103, Resultmessage="Incorrect date"
• 400 - Пользователь не найден в интеграции. Resultcode=103, Resultmessage="User not found"
• 401 - Ключ интеграции не прошел валидацию. Resultcode=103
• 500 - ошибка сервера

Пример ответа:

{
"result": {
"code": "0",
"message": "OK"
},
"data": {
"key": "
aIpiD52TBgRGvACkg0tlaKo/aVIq2eM/1W88SCvrhOOvCebb6AG9IcwtZ2DKjEWuTLvFw=="
}
}

3.1.22.2 Получение статистики

Подготовленные данные хранятся до первого обращения за ними не менее 1 минуты. API предусматривает две стратегии получения результата: ожидание получения специального события API о завершении построения и периодический опрос сервиса.

Обращаться к сервису за готовыми данными следует запросом вида:

POST /v1/callstat/result?USER_ID={ext}&PAGE_LIMIT={pageLimit}&PAGE={page}
Header[X-Mango-API-Token, X-Mango-API-Salt]

Параметры запроса:

В теле запроса необходимо передавать следующие параметры:

Пример запроса:

POST /v1/callstat/result?USER_ID=8000&PAGE_LIMIT=3&PAGE=1

Параметры ответа:

Возможны следующие HTTP коды ответа:

• 200 - Resultcode=0
• 400 - Ключ не найден в интеграции. Resultcode=103, Resultmessage="Key not found"
• 400 - Ключ подписи не задан. Resultcode=103, Resultmessage="Salt not present"
• 400 - неверный ключ создания подписи. Resultcode=103, Resultmessage="Salt is incorrect"
• 401 - Ключ интеграции не прошел валидацию. Resultcode=103
• 500 - ошибка сервера

Пример ответа:

{
"result": {
"code": "0",
"message": "OK"
},
"data": {
"count": 1,
"page": 1,
"pageLimit": 3,
"pageCount": 1,
"stat": [{
"callDate": "1504791513",
"startDate": "0",
"disconnectReason": "1100",
"did": "74951204609",
"billSec": "0",
"fromExt": "8000",
"fromNumber": "sip:dshi@vpbx400022984.mangosip.ru",
"toNumber": "79269226127",
"toExt": "",
"type": "OUTBOUND",
"records": [""]
}
]
}
}