Документация по API

При помощи API вы сможете настроить синхронизацию Callibri со своей CRM-системой. Для этого вам нужно выгрузить данные из Callibri на свой сервер, обработать их и загрузить в CRM. API Callibri позволяет выгружать данные в одностороннем порядке.

Важно: это инструкция для разработчиков, передайте ее специалистам для реализации вашей задачи.

Callibri → Ваш Сервер → Ваша CRM.

Чтобы получить доступ к API, у вас должны быть права Аналитика и Настройка, а также вам нужно получить ваш уникальный токен. Для этого зайдите в настройки своей учетной записи (имя в левом верхнем углу личного кабинета) и нажмите кнопку Получить доступ к API:

После этого мы отправим инструкции и методы на ваш email-адрес.

Вы можете изучить методы ниже, но в них нет вашего уникального токена и email, а также указаны примеры ID и дат.

Список доступных проектов

Тип: GET
URL: /get_sites
Описание: Возвращает массив доступных вам проектов sites с параметрами: site_id (идентификатор проекта в Callibri), sitename (название проекта в Callibri), domains (список доменов, указанных в настройках проектов).

Список обращений в проекте

Тип: GET
URL: /site_get_statistics
Параметры: site_id — идентификатор проекта в Callibri, date1 — начальная дата, date2 — конечная дата (в формате dd.mm.yyyy).

Максимальный период, за который можно выгрузить данные по количеству обращений одним запросом — неделя. Если нужно выгрузить данные за период больше недели, то период нужно разбить на несколько запросов, каждый не больше недели.

Описание: Возвращает массив channels_statistics c параметрами:

name_channel — название канала подмены,
number — подменный номер, на который звонил клиент.

calls — массив звонков:

date — дата звонка,
phone — номер телефона клиента,
status — класс обращения,
comment — комментарий,
link_download — ссылка на скачивание файла,
call_status — статус звонка,
name — имя клиента,
is_lid — уникальность обращения (первое или повторное),
region — регион клиента,
accurately — точность трекинга, возвращает «нет» в случае, если один номер видели несколько пользователей одновременно, и не ясно, кто совершил обращение,
responsible_manager — имя менеджера, который принял звонок,
lid_catcher — ловец лидов, если вы используете МультиЧат.

feedbacks — массив заявок:

date — дата заявки,
phone — телефон, который оставил клиент,
status — класс обращения,
comment — комментарий,
name — имя клиента,
is_lid — уникальность обращения (первое или повторное),
region — регион клиента,
content — содержание заявки,
lid_landing — страница заявки,
form_name — название формы,
responsible_manager — имя менеджера, который принял заявку,
lid_catcher — ловец лидов, если вы используете МультиЧат.

chats — массив чатов:

date — дата обращения,
ip — ip-адрес клиента,
status — класс обращения,
comment — комментарий,
name — имя клиента,
is_lid — уникальность обращения (первое или повторное),
region — регион клиента,
responsible_manager — имя менеджера, который принял заявку,
lid_catcher — ловец лидов, если вы используете МультиЧат.

Дополнительные поля для динамического канала подмены в массивах chats, feedbacks, calls:

id — уникальный идентификатор обращения,
source — источник перехода,
query — ключевые слова,
landing_page — посадочная страница,
conversations_number — номер обращения,
ym_uid — идентификатор посетителя Callibri для Яндекс.Метрики,
ua_client_id — ClientID в Google Analytics,
metrika_client_id — ClientID в Яндекс.Метрике,
utm_source,
utm_medium,
utm_campaign,
utm_content,
utm_term,
clbvid— id визита для сквозной аналитики.

*Если вам необходимо, чтобы в передаваемых данных были metrika_client_id и ua_client_id, необходимо включить синхронизации (с Метрикой и Аналитиксом соответственно). Включение синхронизации активирует сбор этих ID.

История переписки в чате

Тип: GET
URL: /chat/history
Параметры: id — идентификатор лида в Callibri
Описание: Возвращает массив сообщений c параметрами:

date — дата сообщения,
name — имя пользователя,
message — текст сообщения.

Данные о контакте из CRM Callibri

Тип: GET
URL: /crm/contact
Параметры:

lid_id — уникальный идентификатор обращения,

или

site_id — идентификатор проекта в Callibri,

phone — телефон клиента,

или

email — email клиента.

Описание: Возвращает объект c параметрами:

name — имя контакта,
family — фамилия контакта,
town — город,
company — компания,
status — тип клиента,
phones — массив телефонов контакта,
emails — массив электронных адресов контакта.

Информация о посетителе в Яндекс.Метрике

Тип: GET
URL: /metrika_visitor_info
Параметры: ym_uid — идентификатор посетителя Callibri для Яндекс.Метрики
Описание: Возвращает массив значений, с параметрами:

dimetion_name — атрибут визита,
dimetion_value — значение.

Список оценок качества обслуживания (ОКО)

Тип: GET
URL: /oko_statistics
Параметры: site_id — идентификатор сайта в Callibri, date1 — начальная дата, date2 — конечная дата (в формате dd.mm.yyyy)
Описание: Возвращает массив oko_values с параметрами:

lid_id — уникальный идентификатор обращения,
rating — оценка (от 1 до 5),
date — дата получения оценки.

Возможные ошибки

Ошибка «‎callibri_too_many_requests» появляется, если отправляется слишком много запросов. Максимальное количество запросов — 1 запрос в секунду.

Связанные страницы

Интеграция с Яндекс.Метрикой

Как синхронизировать ваш аккаунт Callibri со счетчиком Яндекс.Метрики.

Новая интеграция с Яндекс.Метрикой

Как синхронизировать ваш аккаунт Callibri со счетчиком Яндекс.Метрики.

Интеграция с Google Analytics

Как передавать события звонок, чат, заявка и email в Google Analytics.

Интеграция с Яндекс.Директ

Настраиваем синхронизацию Callibri и Яндекс.Директ, чтобы выводить стоимость лида.

Интеграция с VK Ads

Пошаговое руководство по настройке синхронизации Callibri с рекламным кабинетом ВКонтакте.

Интеграция с VK реклама

Пошаговое руководство по настройке синхронизации Callibri с рекламным кабинетом ВКонтакте.

Интеграция с ВКонтакте

Собираем обращения из сообщений страницы в ВК и форм сбора заявок.

Интеграция с Одноклассниками

Отвечайте на сообщения из Одноклассников в Диалогах МультиЧата Callibri.

Интеграция с Telegram

Создайте бота, чтобы отвечать на сообщения из Telegram в интерфейсе Диалогов МультиЧата Callibri.

Интеграция с WhatsApp

Отвечайте на сообщения клиентов в WhatsApp через Диалоги Callibri.

Интеграция с Avito

Работайте с клиентами, которые пишут вам на Авито, через Диалоги Callibri.

Интеграция с Авто.ру

Получайте сообщения клиентов из Авто.ру в Диалоги и Единый Журнал Лидов Callibri.

Интеграция с Drom.ru

Работайте с клиентами, которые пишут вам в Drom.ru, через Диалоги Callibri.

Кастомные интеграции

Настройка передачи данных в сервисы, с которыми нет готовый интеграций.

Интеграция с облачным Битрикс24

Настройте передачу данных из Callibri в облачный Битрикс24.

Кастомная интеграция с Битрикс24

Настройте передачу данных из Callibri в облачный или коробочный Битрикс24 кастомным способом.

Интеграция с amoCRM

Где взять данные, по каким условиям создаются карточки и сделки.

Кастомная настройка синхронизации с amoCRM

Настройте передачу данных из Callibri в amoCRM.

Интеграция с RetailCRM

Настройте передачу данных из Callibri в RetailCRM

Интеграция с Мегаплан

Настройте передачу данных из Callibri в CRM Мегаплан.

Интеграция с Aspro.Cloud

Как настроить синхронизацию с CRM Aspro.Cloud.

Интеграция с Medods

Настройте передачу данных из Callibri в CRM Medods.

Интеграция с CRM МойСклад

Настройка и передача данных в CRM МойСклад.

Интеграция с Клиентикс

Настройте передачу данных из Calliibri в CRM Клиентикс для медицинских клиник.

Интеграция с GetCource

Как настроить передачу данных в CRM GetCource.

Документация по Webhook

Узнайте, как настроить передачу данных о каких-либо событиях через Webhook.

Документация по API

Инструкция поможет получить доступ к API Callibri и разобраться с методами.

Расхождение данных с CRM

Как проверить синхронизацию с CRM и что отправить техподдержке, если проблема не обнаружена.

Расхождение данных с Яндекс.Метрикой

Вероятные причины расхождения и как их устранить.

Интеграция с Sendsay

Как настроить интеграцию с сервисом для рассылок Sendsay.

Интеграция с DashaMail

Как настроить интеграцию с сервисов email-маркетинга DashaMail.

Интеграция с Unisender

Как настроить интеграцию с сервисом для массовых рассылок Unisender.

Интеграция с Yclients

Как настроить передачу лидов и контактов из Yclients в Callibri.

Интеграция с Лид-формами VK Рекламы

Как настроить получение заявок из лид-форм в Сallibri.

Не нашли решение проблемы? Обратитесь в техподдержку, мы поможем

Создать обращение