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

Адрес

https://api.chaser.ru/v1/

Авторизация

Каждому пользователю Chaser API выдается приватный ключ ($private_key) и идентификатор пользователя ($client_id) в системе Chaser. Эти данные используются для авторизации при обращении к Chaser API. С помощью приватного ключа генерируется публичный ключ, которым подписывается каждый запрос. 

Допустимые заголовки запросов

  • GET - Получение объекта или списка объектов
  • POST - Создание звонка

Допустимые заголовки ответов

  • 200 OK - все хорошо
  • 401 Unauthorized - не удалось авторизовать пользователя
  • 403 Forbidden - доступ запрещен
  • 404 Not Found - объект не найден

Методы API

https://api.chaser.ru/v1/websites

GET - получение списка сайтов данного пользователя.

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

[
    {
        id: "12345",
        name: "chaser.ru",
        title: ""
    },
    {
        id: "54321",
        name: "test.ru",
        title: "Для тестов"
    }
]


https://api.chaser.ru/v1/statistics

GET - список звонков сайта

Параметры: 

НазваниеТипОписание
site_idintID сайта в системе. Можно получить методом websites. Обязательный параметр
date_fromdate, Формат: dd-mm-YYYYНачало периода. Необязательный параметр
date_todate, Формат: dd-mm-YYYYКонец периода. Необязательный параметр
filterstring

Фильтр по статусу звонка.

Возможные значения:

  • success_calls - успешные звонки
  • failed_calls - пропущенные звонки

Необязательный параметр

https://api.chaser.ru/v1/call

POST - создание звонка

Параметры: 

НазваниеТипОписание
site_idintОбязательный параметр. ID сайта в системе. Можно получить методом websites.
client_phoneintОбязательный параметр. Телефон клиента
   
manager_phoneintТелефон менеджера.
Если этот параметр не указан, то телефон берется из настроек сайта.
planned_timeunixtimeЧерез какое время инициировать звонок. Например, time() + 7 * 60 - через 7 минут.
Если этот параметр не указан, то звонок будет инициирован сразу же после вызова метода.
active_pagestringСтраница, с которой было вызвано событие.
client_ipstringIP-адрес клиента
message_on_ringstringГоловосове сообщение менеджеру при звонке.
nwt_actionenum

Действие в нерабочее время. Допустимые значения:
create_leed - создавать лид (отправлять на почту)
always_call - ставить звонок в очередь на следующий день.

В случае, если выбран параметр always_call, имеют смысл следующие два параметра: call_stack_start_hour и call_stack_interval

call_stack_start_hourint, [0-24]Время начала звонков, которые были созданы ночными обращениями. Если пользователь запросил обратный звонок в 3 часа ночи, то нет смысла звонить ему в 8 часов утра. Мы предполагаем, что есть смысл начинать обзвон с определенного времени с интервалом.
call_stack_intervalint, [0-60]Интервал между запланированными звонками.
referrerstringРеферер страницы, с которой был совершен звонок.

Примеры

Пример получения публичного ключа

Каждый запрос необходимо подписывать публичным ключом. Публичный ключ представляет собой md5-хэш от строки параметров с добавлением приватного ключа.

$params["SecurityKey"] = md5(http_build_query($params)."&PrivateSecurityKey=".$this->private_key);


Пример класса для вызовов API

apitest.php (2 Кб)