 |
UIS – Омниканальная система для управления коммуникациями в маркетинге и продажах. В этой статье мы рассмотрим функционал mybi connect для получения данных этого источника.
API UIS позволяет заказывать звонок, запрашивать статистику и интегрировать данные с вашей CRM.
Для того, чтобы получать данные с помощью API, в первую очередь, необходимо получить ключ для доступа (в сервисе используется Data API).
Это делается на уровне пользователя в меню администратора.
Здесь вы можете: выбрать тип доступа и активировать использование ключа (1), выбрать время жизни ключа (рекомендуем выбирать постоянный) (2), сгенерировать ключ (3).
Cкопируйте cгенерированный ключ.
Далее необходимо открыть доступ к ключу, который по умолчанию закрыт. Для этого зайдите в аккаунт через меню администратора,
затем перейдите в разделе «Правила и настройки безопасности» (1) на вкладку «API» (2) и нажмите на кнопку «+ Добавить» (3). После чего вводим IP «0.0.0.0/0» (4), описание (доступ всем) (5) и сохраняем (6).
Стоит отметить, что возможность использования Data API определяется тарифным планом/пакетом опций сервиса UIS.
Вторым шагом будет настройка выгрузки уже в самом сервисе mybi connect.
Для того, чтобы добавить новый источник данных, в интерфейсе mybi connect необходимо в левом боковом меню сервиса выбрать пункт “Источники данных” и нажать на кнопку “Добавить новый+”, после чего перейти в раздел “КОЛЛТРЕКИНГ” и выбрать источник UIS, нажав на кнопку “подключить”:
В открывшейся форме необходимо заполнить поля настройки источника:
Поле “Название источника” может быть любым и необходимо для того, чтобы вы могли однозначно идентифицировать этот источник среди других. В поле “Ключ доступа” необходимо вставить сгенерированный ранее в UIS API ключ.
После ввода всех необходимых данных необходимо завершить настройку источника, нажав на кнопку “Продолжить”.
Базовая выгрузка
После завершения подключения в таблице “Источники” появится новый источник данных с указанным в ходе настройки названием. Если вы используете Триал, то автоматически запустится выгрузка данных за 2 последних дня и вы можете сразу перейти к просмотру данных в БД. Далее для запуска исторической загрузки данных за нужный период выберите в колонке “Действия” в строке добавленного источника пункт меню “Загрузить”:
Обратите внимание, что период доступной исторической загрузки зависит от выбранных вами параметров тарифа, а для триального периода составляет 1 месяц.
Необходимо еще сказать о том, что в UIS установлены лимиты на обращение к API. Изначально доступно 3000 баллов в день, которые расходуются за каждый успешный запрос. Если вы превысите это значение, то с очередной выгрузкой в сервисе mybi connect вы увидите ошибку, описание которой можно посмотреть в журнале событий (напротив источника в столбце действий выбираем «Журнал событий»).
Чтобы исправить данную ситуацию, нужно в меню аккаунта сервиса UIS перейти в раздел «Тариф и опции» и увеличить показатель «Баллов DataAPI в день» за дополнительную плату.
Затем следует запустить загрузку данных за тот период, в котором вы получили эту ошибку.
По завершению загрузки в базе данных появятся сведения по звонкам в специально спроектированном нами виде, наиболее удобном для дальнейшего анализа:
Более детально ознакомиться со структурой выгрузки вы можете здесь. Если в каких-то из этих данных вы не нуждаетесь – вы можете воспользоваться функционалом по выбору необходимых таблиц и в настройках источника выбрать только те, в которые будут загружаться данные в процессе базовой выгрузки:
Для этого сервиса-источника выбор таблиц не очень большой, но это позволит вам как ограничить набор данных, так и в какой-то мере сэкономить количество расходуемых на выгрузку строк.
Кроме возможности выбора таблиц, в базовой выгрузке также существует функционал фильтрации, позволяющий ограничить данные, загружаемые в те или иные таблицы. Вот пример использования фильтра:
Этот фильтр позволяет хранить в БД только входящие звонки.
На этом настройка CoMagic закончена. В дальнейшем сведения по звонкам будут автоматически загружаться в базу данных, доступ к которой вы можете найти в разделе “Хранилище данных“.
Пользовательская выгрузка
Пользовательская выгрузка позволяет организовать загрузку произвольного набора полей с последующим автоматическим обновлением по текущий период. Необходимым условием создания выгрузки является наличие настроенного источника. Для ее создания необходимо перейти в раздел “Планировщик заданий“, нажать на кнопку “Добавить новое+” и выбрать из списка “Выгрузка отчетов из UIS”. Далее на экране будет отображена форма с параметрами выгрузки:
В первой строке указываем произвольное название задания (длиной не более 64-х символов), затем выбираем необходимый нам аккаунт. Далее выбираем тип отчета. Вам будут предложены следующие варианты отчетов:
- получение CDR по сессии звонка;
- получение всех сообщений чата;
- получение информации о сессии посетителя;
- получение информации о чатах;
- получение информации по оффлайн заявкам;
- получение отчета по сессиям звонков;
- получение списка всех обращений;
- получение списка достигнутых целей;
- получение статистики РК по дням.
Более подробно с типами отчетов можно ознакомиться в официальной документации API UIS.
В качестве примера мы выберем «Получение информации о сессии посетителя». После этого необходимо выбрать список полей, которые будет содержать ваш отчет.
По умолчанию загружаемые данные сохраняются в таблицу uis_reports в формате JSON.
Воспользовавшись опцией “Зафиксировать структуру” в поле “Описание таблиц” можно добавить специальное правило, описывающие каким образом полученные сведения должны обрабатываться mybi connect. Это даст возможность пользователю сохранять данные в удобном виде и в указанных таблицах. Для завершения настройки пользовательской выгрузки необходимо нажать на кнопку “Продолжить”.
Добавив отчет в список заданий, его можно запустить для загрузки данных. Это можно сделать, отобразив меню “Выбрать” в колонке “Действия” напротив созданного отчета и выбрав пункт меню “Выполнить”:
После указания периода загрузки данные будут загружены в хранилище.
Сверка загруженных данных
Задание “Проверка загруженных данных” позволяет выявить наличие расхождений между имеющимися сведениями в базе данных и сервисе-источнике (в данном случае UIS), а также актуализировать состояние загруженных данных за прошлые периоды в случае выявления расхождений.
При выявлении отклонений используется следующий набор параметров и показателей для сравнения:
- идентификатор кампании;
- код источника звонков;
- идентификатор тега;
- количество звонков;
- длительность ожидания;
- длительность разговоров.
Результаты проверки загруженных данных вы можете найти в журнале событий (колонка “Действия” -> Журнал событий -> Сверка):
Удаление устаревших данных
Учитывая объем накапливаемых данных, а также наличие зависимости максимального объема хранимых данных от параметров тарифного плана, в некоторых случаях можно воспользоваться дополнительным заданием “Удаление устаревших данных“. Это задание позволяет удалять данные по звонкам из хранилища, длительность хранения которых превышает количество дней, указанных при настройки задания. Для того, чтобы создать задание для удаления устаревших данных, необходимо перейти в раздел “Планировщик заданий“, нажать на кнопку “Добавить новое+”, выбрать из списка “Удаление устаревших данных”, далее будет отображена форма с параметрами задания:
Мы будем рады вашим вопросам и рациональным комментариям относительно функционала сервиса в чате нашего телеграм-канала @mybi connect