Метод API: получение количества звонков

Примечание. В этой статье описан JavaScript API Коллтрекинга MANGO OFFICE. Информацию о других интеграциях, при помощи REST API MANGO OFFICE, вы можете найти в статье Кастомные интеграции

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

URL запроса: https://widgets-api.mango-office.ru/v1/calltracking/[widgetId]/calls.[ext] ,
где

widgetId - номер виджета. Где узнать id-номер виджета, Вы можете узнать в этой статье.
ext - расширение, определяющее тип экспорта (допустимый формат выгрузки csv).

Для авторизации запроса необходимо передать token, полученный в личном кабинете. Есть два способа указать token:

в параметре access_token=<token>
или в http заголовках: Authorization: Bearer <token>

Пример запроса GET: https://widgets-api.mango-office.ru/v1/calltracking/224/calls?dateStart=2017-06-01T00:00Z&da...

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

Название	Обязательность	Тип данных	Описание	Значение по умолчанию

dateStart	required	date (YYYY-MM-DDThh:mmZ)	Дата и время начала интервала отчёта в формате ISO 8601
dateEnd	required	date (YYYY-MM-DDThh:mmZ)	Дата и время окончания интервала отчёта в формате ISO 8601
callType	optional	number	Тип звонка: 0 - динамические и статические, 1 - динамические, 2 - статические, 3 - дефолтные	0
isNew	optional	boolean	Флаг нового звонка: 0 - только не новые звонки, 1 - только новые
isQuality	optional	boolean	Флаг качественного звонка: 0 - только некачественные звонки, 1 - только качественные
utmSource	optional	string	Источник
utmMedium	optional	string	Канал
utmCampaign	optional	string	Кампания
utmContent	optional	string	Содержание
utmTerm	optional	string	Ключевое слово

Максимальный интервал времени для запроса звонков - 31 день.

Набор полей в ответе:

Название	Тип данных	Описание

callId	number	id звонка
dateStart	date	Время поступления звонка в формате ISO 8601 YYYY-MM-DDThh:mmZ
dateEnd	date	Время окончания звонка в формате ISO 8601 YYYY-MM-DDThh:mmZ
callType	number	Тип звонка: 1 - динамический, 2 - статический, 3 - дефолтный
callStatus	number	Статус завершения звонка как в ВАТС API, 11XX- звонок был принят, иначе - отклонён
number	number	Динамический номер, на который был принят звонок
callerNumber	number	Номер звонившего
duration	number	Продолжительность звонка в секундах. Считается только продолжительность разговора с оператором. Без учета времени ожидания в IVR и ожидания распределения звонка внутри группы операторов.
waitDuration	number	Время ожидания до соединения с оператором в секундах
isNew	boolean
isQuality	boolean	Флаг качественного звонка
isDuplicate	boolean	Флаг того, что с этого номера звонили последние 3 месяца
uid	string	Уникальный идентификатор клиента MANGO OFFICE
gaCid	string	Идентификатор клиента Google Analytics
yaCid	string	Идентификатор клиента Яндекс.Метрики
utmSource	string	Источник
utmMedium	string	Канал
utmCampaign	string	Кампания
utmContent	string	Содержание (объявления)
utmTerm	string	Ключевое слово
countryCode	string	Код ISO страны
regionCode	string	Код ISO региона
city	string	Название города
dctTags	string	Поле отображается опционально. Теги обращения, через запятую. Если тегов нет, то поле отсутствует
device	string	Тип устройства: desktop, tablet или mobile
ip	string	IP адрес пользователя
URL	string	Адрес страницы сайта, с которой был совершён звонок
firstUrl	string	Адрес страницы входа пользователя на сайт
customParam	string	Дополнительные параметры, передаваемые в код виджета тем, кто разместил его на сайте. Ограничение - 100 символов.
isLead	boolean	Является ли лидом: 1 - да, пусто - нет. Систем автоматически выставляет признак лид, если звонок уникальный, качественный и не сомнительный, то 1. В Журнале звонков пользователь может изменить выбор системы

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

[
  {
    "callId": 5001483600,
    "dateStart": "2017-05-30 10:53:03.000Z",
    "dateEnd": "2017-05-30 10:53:22.000Z",
    "callType": 1,
    "callStatus": 1120,
    "number": 74955646568,
    "callerNumber": 74955404444,
    "duration": 10,
    "waitDuration": 9,
    "isNew": true,
    "isQuality": true,
    "isDuplicate": false,
    "uid": "gVVPVLjV1kTOqd0r4xtx",
    "gaCid": null,
    "yaCid": null,
    "utmSource": "apple",
    "utmMedium": "apple",
    "utmCampaign": "apple",
    "utmContent": "apple",
    "utmTerm": "apple",
    "countryCode": "",
    "regionCode": "",
    "city": "",
    "Tags": "лето","осень","зима","весна",
    "ip": "192.168.1.24",
    "url": "http://m-test.ma/dkt/forrep.html?utm_source=apple&utm_medium=apple&utm_campaign=appl...;,
    "firstUrl": "http://m-test.ma/dkt/forrep.html?utm_source=apple&utm_medium=apple&utm_campaign=appl...;
  },
  {
    "callId": 5001483602,
    "dateStart": "2017-05-30 10:55:26.000Z",
    "dateEnd": "2017-05-30 10:55:47.000Z",
    "callType": 1,
    "callStatus": 1110,
    "number": 74955646568,
    "callerNumber": 74955404444,
    "duration": 13,
    "waitDuration": 8,
    "isNew": false,
    "isQuality": false,
    "isDuplicate": true,
    "uid": "gVVPVLjV1kTOqd0r4xtx",
    "gaCid": null,
    "yaCid": null,
    "utmSource": "yandex",
    "utmMedium": "cpc",
    "utmCampaign": "(none)",
    "utmContent": "(none)",
    "utmTerm": "(none)",
    "countryCode": "RU",
    "regionCode": "MOW",
    "city": "Москва",
    "ip": "23.16.10.24",
    "url": "http://m-test.ma/dkt/testrep.html?utm_source=poland",
    "firstUrl": "http://m-test.ma/dkt/forrep.html?utm_source=apple&utm_medium=apple&utm_campaign=appl...;
  }
]

Примечание по параметрам API:

1. Параметр duration. Определяет продолжительность разговора с оператором без учета времени ожидания в IVR и ожидания распределения звонка внутри группы операторов.

2. Параметр isNew. Звонок считается новым, если выполнены два условия:

с данного номера (номер А или номер клиента) не было звонков в компанию в течение последних трех месяцев;
звонок распределился на группу продаж, которая указана в настройках коллтрекинга.

3. Параметр isQuality. Звонок считается качественным, если время разговора с оператором превысило порог времени, заданный в настройках коллтрекинга (по умолчанию - 30 секунд).

4. Параметр utmSource. Данный параметр формируется аналогично отчету Источник/канал в Google Analytics. Для звонков с прямых переходов значение параметра возвращается (direct). Для звонков из органического поиска возвращается название поисковой системы (например, google или yandex). Для звонков с реферального трафика возвращается URL сайта (источника), с которого был переход. Для платной рекламы в общем случае возвращается значение из метки utm_source.

5. Параметр utmMedium. Этот параметр формируется аналогично отчету Источник/канал в Google Analytics. Для звонков с прямых переходов значение параметра возвращается (none). Для звонков из органического поиска возвращается значение organic. Для звонков с реферального трафика возвращается значение refferal. Для платной рекламы в общем случае возвращается значение из метки utm_medium.

6. Параметр utmTerm. Параметр возвращает значение ключевого слова, если его удалось определить. Для платной рекламы в общем случае возвращается значение из метки utm_term.

7. Параметр Calltype. Определяет тип звонка:
     1 - звонки на динамический номер коллтрекинга,
     2 - звонки на статические номера коллтрекинга, которые указаны в настройках статических каналов,
     3 - звонки на основной номер компании, указанный в настройках коллтрекинга как номер по умолчанию.
Этот номер будет отображаться у посетителей сайта, в случае, если закончится бюджет на коллтрекинг или произойдет технический сбой.

8. Рекомендуется обращаться к данному методу раз в сутки, например, запрашивать данные за предыдущий день. Также возможны обращения с периодичностью один раз в час. Более частые обращения в моменты высокой загрузки сервера могут завершаться с ошибкой.