Статистика вызовов (/calls/stats/, /cdr/stats/)

_{Протестировать методы API можно на странице}_{интерактивного обозревателя API}_{и без написания кода}
_{Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см.}_{Создание и авторизация приложений}₎

Данный ресурс позволяет получить суммарные данные о вызовах и составных частях за указанный период времени либо по определенному внутреннему номеру (общее количество, количество пропущенных звонков и т.п.). С событиями на внутреннем номере можно ознакомиться по ссылке. При отправке запросов необходимо учитывать наличие лимитов на количество запросов к API.

1 Описание структур данных
2 Пример
3 Ресурсы раздела “Клиент”

Описание структур данных

Ресурсы call_stat/cdr_stat

Имя	Тип	Обяза-тельный	Описание

Имя	Тип	Обяза-тельный	Описание
answered	long	да	Количество отвеченных вызовов
bridged	long	да	Вызовы, соединенные с конечным абонентом. Отличие от answered: вызов может быть отвечен, но без соединения с конечным абонентом (например, вызов был принят очередью, но никто его не смог принять, тогда вызов будет answered, но не bridged)
bridged_duration	long	да	Суммарная длительность в секундах вызовов со статусом bridged
busy	long	да	Количество звонков, отбитых сигналом "занято"
duration	long	да	Суммарная длительность в секундах вызовов со статусом answered
failed	long	да	Вызовы, отклоненные по другим причинам (не busy, rejected или not answered)
not answered	long	да	Количество не отвеченных вызовов
rejected	long	да	Количество вызовов, отклоненных принимающей стороной
total	long	да	Общее количество вызовов
answered elsewhere	long	да	Вызов не отвечен получателем, но был отвечен кем-то другим (при одновременном вызове внутренних номеров через очередь либо одновременным переводом ("simple transfer") сразу на несколько номеров);
diverted	long	да	Вызов был переведен на принимающем вызов устройстве

Пример

Получить суммарные данные за первые 10 дней ноября 2019 года:

{
  "in": {
    "busy": 0,
    "bridged_duration": 6142,
    "answered": 15,
    "not answered": 5,
    "rejected": 0,
    "failed": 8,
    "bridged": 59,
    "duration": 6386,
    "total": 87
  },
    "out": {
    "busy": 0,
    "bridged_duration": 958,
    "answered": 0,
    "not answered": 37,
    "rejected": 0,
    "failed": 22,
    "bridged": 87,
    "duration": 958,
    "total": 146
  }
}

Ресурсы раздела “Клиент”

GET /client/{client_id}/calls/stats/

GET /client/{client_id}/cdr/stats/

Параметры URL

Имя	Тип

Имя	Тип
client_id	string

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

Name	Type

Name	Type
start_datetime	string
end_datetime	string
extension_id	Array[integer]

Поля ответа

Имя	Тип	Обязательный	Описание

Имя	Тип	Обязательный	Описание
in	call_stat/cdr_stat	нет	Суммарные данные по входящим вызовам
out	call_stat/cdr_stat	нет	Суммарные данные по исходящим вызовам

Ресурс cdr_stat

Имя	Тип

Имя	Тип
answered	long
bridged	long
bridged_duration	long
busy	long
duration	long
failed	long
not answered	long
rejected	long
total	long
diverted	long
answered elsewhere	long

Ресурс call_stat

Имя	Тип

Имя	Тип
answered	long
bridged	long
bridged_duration	long
busy	long
duration	long
failed	long
not answered	long
rejected	long
total	long

REST API Документация клиента 2.0

Статистика вызовов (/calls/stats/, /cdr/stats/)

Описание структур данных

Пример

Ресурсы раздела “Клиент”

Related content