Блог проекта

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

Опубликовано 25.11.2015

По просьбе ряда клиентов в UpToCall появилось API для получения статистики звонков. API - это набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) для использования во внешних программных продуктах.

То есть, используя определенные функции, которые предоставляет UpToCall вы сможете получать данные (статистика звонков, информация об остатке минут и пр.) или совершать некоторые действия (например, продлить тариф).

На текущий момент API находится в разработке, но, как мы писали выше, уже доступна функция для получения статистики звонков по сайтам.


Описание API

Метод запроса — GET/POST
Обращение к API происходит по адресу: https://uptocall.com/api.php?method={method}&apikey={apikey}, где {method} — метод API.

Каждый запрос должен содержать параметр apikey. Для получение ключа, пожалуйста, обратитесь в техническую поддержку.

Формат ответа - JSON
Каждый ответ содержит status, который может принимать значения:

  • 0 - в случае успеха
  • в противном случе возращает код ошибки (описание ошибки содержится в атрибуте error)
Данные ответа содержатся в атрибуте data

Ограничение запросов: не более 200 обращений в час


Пример запроса к API

$get = array(
    'method' => 'calls',
    'site' => 1,
    'apikey' => '1546058f-5a25-4334-85ae-e68f2a44bbaf',
);

$url = 'https://uptocall.com/api.php?'.http_build_query( $get );
$result = file_get_contents( $url );
$response = json_decode( $result );


Описание существующих функций

callsСписок звонков

Параметры запроса:
  • site идентификатор сайта (обязательный параметр)
  • limit — ограничение на выгрузку звонков, но не более 500 записей, по умолчанию 50 записей (необязательный параметр)
  • period_start — фильтр начала периода создания звонков в формате YYYY-MM-DD hh:mm:ss (необязательный параметр)
  • period_end — фильтр конца периода создания звонков в формате YYYY-MM-DD hh:mm:ss (необязательный параметр)
Структура ответа:
Результатом выполнения запроса является массив, каждый элемент которого содержит:
  • date_created — время и дата создания звонка
  • status — статус звонка
    • accept — звонок принят
    • missed — звонок пропущен
    • waiting — отложенный звонок
    • no_answer — нет ответа
    • cancel — звонок отменен
  • phone_client — телефон клиента
  • phone_manager — телефон менеджера
  • duration — длительность звонка
  • record — запись звонка
  • call_date — время и дата отложенного звонка
  • referer — источник перехода
  • referer_domain — домен источника перехода
  • ip — IP клиента
  • region — регион клиента
  • page — страница с которой был заказан звонок