Отправка запроса на API

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

Для авторизации и доступа к API нужно получить идентификатор клиента (client_id) и секретный ключ (secret_key).

Получить ключ и идентификатор для API вы можете в кабинете клиента (раздел Профиль → API).

Отправка запросов к API

Все запросы к API отправляются как HTTP-запрос на единый URL-адрес соответствующий команде которую нужно выполнить.

Параметры API передаются в URL-запросе как GET-параметры.

URL-адрес API:

https://leadback.ru/api/команда.php

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

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

Примеры запроса к API смотрите в описаниях команд API.

Ответы на команды API

На все команды API возвращает ответ в формате JSON. Примеры ответов API смотрите в описаниях команд API.

В случае ошибок в запросе к API возвращается тип ошибки и её описание в JSON вида:

{"error_type":"auth","error_message":"Invalid value client_id OR secret_key"}

 

Список команд к API
  • calls — список звонков за день или период;
  • chats — список диалогов с операторами за день или период;
  • bots — список диалогов в чат боте за день или период;
  • widgets — список виджетов;
  • referals — список привлеченных клиентов (для партнеров).
Поделиться ссылкой:

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