При помощи API вы сможете настроить синхронизацию Callibri со своей CRM-системой. Для этого вам нужно выгрузить данные из Callibri на свой сервер, обработать их и загрузить в CRM. API Callibri позволяет выгружать данные в одностороннем порядке.
Важно: это инструкция для разработчиков, передайте ее специалистам для реализации вашей задачи.
Callibri → Ваш Сервер → Ваша CRM.
Чтобы получить доступ к API, у вас должны быть права Аналитика и Настройка, а также вам нужно получить ваш уникальный токен. Для этого зайдите в настройки своей учетной записи (имя в левом верхнем углу личного кабинета) и нажмите кнопку Получить доступ к API:bbbbbbb.png 132 KB После этого мы отправим инструкции и методы на ваш 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 запрос в секунду.
