API команда calls

Данная команда служит для получения звонков принятых через виджеты обратного звонка на ваших сайтах.  Смотрите так же другие API команды доступные в leadback.

Для получения списка звонков нужно отправить API запрос на URL команды.

URL команды calls:

https://leadback.ru/api/calls.php

Обязательный параметры:

  • secret_key — секретный ключ;
  • client_id — идентификатор клиента.

Параметры опционально:

  • date — дата за которую нужно получить звонки в формате YYYY-MM-DD (если не передана, то будут получены звонки за сегодня);
  • date_from — начало периода для получения звонков за интервал дат в формате YYYY-MM-DD (если передан параметр date, то date_from игнорируется);
  • date_to — конец периода для получения звонков за интервал дат в формате YYYY-MM-DD (если передан параметр date, то date_from игнорируется);
  • order — сортировка результата (значения: asc — по возрастанию, desc — по убыванию);
  • limit — кол-во возвращаемых звонков (по-умолчанию: 10, максимальное значение: 100).
  • offset — текущее смещение в выборке звонков. Позиция с которой нужно получать данные, нумерация начинается с 0 (по-умолчанию).

Обратите внимание: звонки выбираются по времени когда он был или будет осуществлен (это касается отложенных звонков).

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

https://leadback.ru/api/calls.php?secret_key=ВашСекретныйКлюч&client_id=ВашИдентификаторКлиента&date=2019-04-05

Данная команда вернет список звонков состоявщихся в дату 5 апреля 2019.

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

{
    "data": [
        {
            "id_call": "141003",
            "user_id": "1",
            "widget_id": "4475",
            "date_create": "2016-04-05 17:21:10",
            "date_update": "2016-04-05 17:22:55",
            "callback_phone": "79210000000",
            "operator_phone": "79600000000",
            "site": "oursite.ru",
            "user_tariff": "personal",
            "duration": "0",
            "record_url": "",
            "visit_uuid": "92614cb9-a58c-466b-d044-ac9c6c696bd1",
            "visit_ip": "5.19.200.60",
            "visit_source": "direct",
            "status": "failed"
        },
        {
            "id_call": "140976",
            "user_id": "1",
            "widget_id": "4475",
            "date_create": "2016-04-05 16:49:00",
            "date_update": "2016-04-05 16:51:10",
            "callback_phone": "79220000000",
            "operator_phone": "79600000000",
            "site": "oursite.ru",
            "user_tariff": "personal",
            "tariffed_minutes": "1",
            "duration": "5",
            "record_url": "http://www-ru-01-92.com/records/2016/04/05/8e03b.141790000.000000.mp3?record_id=000001",
            "visit_uuid": "75540dc7-19e2-420b-81e6-e51dd776c690",
            "visit_ip": "85.236.163.62",
            "visit_source": "cpc",
            "status": "complete"
        }
    ],
    "totalCount": "2"
}

Обратите внимание totalCount показывает общее число звонков выбранных по условию, и может быть больше так как возвращаются не все звонки а только кол-во указанное в limit.

Если за указанный период больше чем 100 звонков, то все звонки нужно получать постранично, используя параметры limit и offset. Для первой страницы это будет limit=100, offset=0. Для второй страницы:  limit=100, offset=100 и т.д.

 

Поделиться ссылкой:

Оставить комментарий