SaleBot - Конструктор чат-ботов
Как подключить сервис
1.Подключение компонента
Для настройки интеграции UIS c Salebot.pro в кабинете UIS необходимо подключить компонент API «Базовые отраслевые решения». Подключить компонент можно только под правами Администратора.
Для этого необходимо в верхнем правом углу нажать «Администратор — Аккаунт». Слева в меню выбрать раздел «Тарифы и опции», в предоставленном списке опций найти API «Базовые отраслевые решения» и нажать кнопку «Подключить».
2. Настройка доступов API
Для работы интеграции необходимо сформировать ключ API, а также добавить IP-адрес Salesbot.pro в список разрешенных.
Для формирования ключа API в верхнем правом углу перейдите в «Администратор — Управление пользователями».
Можно либо редактировать уже имеющегося пользователя, либо создать нового.
При редактировании или создании пользователя внизу должны быть выбраны следующие пункты:
При проставлении галочки Использовать ключ API генерируется сразу ключ, который нужно скопировать. Ключ отображается один раз до момента сохранения данных при редактировании или создании пользователя. Если вы не скопировали сразу ключ, то можно сгенерировать новый. Полученный ключ API укажите в настройках подключения телефонии UIS в вашем проекте Salebot:
В UIS после создания пользователя нужно перейти в «Администратор — Аккаунт», слева выбрать раздел «Правила и настройки безопасности», вкладка API. Нажать кнопку «Добавить», ввести в поле «IP/Маска» IP-адрес 138.68.73.64 и 62.84.125.172 (адрес salesbot.pro) и нажать на дискету, чтобы сохранить указанный адрес.
3. Настройка телефонии
Если у вас еще не подключен номер UISCOM, то его можно подключить, перейдя в «Администратор — Аккаунт», слева выбрать раздел «Управление номерами» и нажать кнопку «Подключить».
Во всплывающем окне выбрать понравившийся номер, проставить галочку «Согласен с условиями» и нажать кнопку «Подключить».
Для совершения звонков по сценарию требуется создать сценарий в разделе «Виртуальная АТС — Сценарии».
После создания сценария необходимо получить id сценария, по которому должны обрабатываться звонки. Для этого нужно перейти в редактирование сценария и в адресной строке найти значение параметра «controller.params=xxxxxx» (вам нужны цифры, которые в дальнейшем понадобятся для настроек в salesbot.pro).
Для того, чтобы звонки поступали конкретному сотруднику, требуется создать соответствующего сотрудника в разделе «Сотрудники».
После создания сотрудника необходимо получить id сотрудника, на которого должны поступать звонки. Для этого нужно перейти в редактирование сотрудника и в адресной строке найти значение параметра «controller.params.recorId=xxxxxxx» (вам нужны цифры, которые в дальнейшем понадобятся для настроек в salebot.pro).
Как получить полный вебхук от UISCOM
Вебхук — это уведомление о произошедшем событии. Такое уведомление содержит значения измененных переменных.
Для получения полного вебхука от UISCOM достаточно присвоить любое значение переменной save_webhook
Переменная может быть как константой проекта, так и переменной сделки.
Переменная сделки: присваиваем в Калькуляторе блока
Константы проекта
При этом ответ UISCOM будет записываться в переменную uiscom_request, которую вы найдете в карточке клиента среди переменных сделки.
Пример значения переменной uiscom_request
Как происходит сопоставление клиента
Для работы с телефонией используются номера в формате 71234567890 (должен начинаться с 7, состоять из 11 цифр и не иметь лишних знаков и отступов).
Последовательность сопоставления данных о клиенте:
1. Осуществляется поиск клиента Телефонии. Если клиент не найден, то происходит поиск по значениям всех переменных по всему списку клиентов проекта. Первая найденная запись о клиенте считается тем самым «искомым» клиентом.
2. Если клиент не найден среди клиентов Телефонии и:
Функция «Звонок сотруднику» в Salebot
Для того, чтобы совершить звонок сотруднику из бота, необходимо использовать функцию uiscom_employee_call(virtual_phone, client_phone, employee_id), которая принимает на вход следующие параметры:
virtual_phone — виртуальный номер, строка, пример — ’78001002752′
client_phone — номер клиента, которому должен быть совершен звонок, строка, пример — ’79004443322′
employee_id — идентификатор сотрудника, которому будет направлен звонок клиента, строка, пример — ‘2339292’
Пример бота:
Функция «Звонок по сценарию» в Salebot
Для того, чтобы совершить звонок сотруднику из бота, необходимо использовать функцию uiscom_scenario_call( virtual_phone, client_phone, scenario_id), которая принимает на вход следующие параметры:
virtual_phone — виртуальный номер, строка, пример — ’78001002752′
client_phone — номер клиента, которому должен быть совершен звонок, строка, пример — ’79004443322′
scenario_id — идентификатор сценария, по которому будет распределен звонок клиента, строка, пример — ‘328746’
Пример реализации функции в боте:
Настройка звонков из карточки клиента
Чтобы настроить осуществление звонков непосредственно из карточки клиента, нужно в систему Salebot внести своих сотрудников. После того, как вы зарегистрировали сотрудника, зайдите в редактирование его данных.
В позиции «Способ совершения телефонных звонков» выберите звонки по API Uiscom.
Далее потребуется указать виртуальный номер, зарегистрированный в Uiscom, а также id данного сотрудника в системе UIS.
Для осуществления звонка выбранным методом достаточно в карточке клиента нажать на иконку телефонной трубки рядом с его номером телефона:
Настройка вебхуков
Чтобы настроить прием вебхуков, в сервисе UIS нужно зайти в «Администратор — Управление пользователями — Уведомления» и нажать «Добавить уведомление».
Внизу нужно поставить свитчер HTTP в положение «ВКЛ», метод — POST, а URL прописать вида https://chatter.salebot.pro/uiscom_webhook/<апи-ключ>, например, https://chatter.salebot.pro/uiscom_webhook/9xd99uobn9efrkjlx9ybsuz99c9m9nmz9fossm93
В тело запроса следует вставить следующий список:
{ "external_id":{{external_id}},
"notification_name":{{notification_name}},
"virtual_phone_number":{{virtual_phone_number}},
"notification_time":{{notification_time}},
"scenario_name": {{scenario_name}},
"wait_time_duration" : {{wait_time_duration}},
"employee_ids":{{employee_ids}},
"contact_info":{
"contact_phone_number":{{contact_phone_number}},
"communication_number":{{communication_number}},
"contact_id": {{contact_id}}, "contact_full_name":{{contact_full_name}}
},
"call_session_id":{{call_session_id}}
}При подключении вебхуков после совершения звонка клиенту в боте будут приходить следующие уведомления (клиент их видеть не будет).
Прочий функционал UISCOM
1. Функция для загрузки офлайн-заявок в UIS
Для включения функциональности загрузки заявок в личном кабинете UIS в разделе «Тарифы и опции» требуется подключить опцию «Загрузка коммуникаций из внешних систем».
Если такой опции в личном кабинете нет, скорее всего, у вас тариф, на котором данная опция не поддерживается. В таком случае пользователю нужно будет обратиться к своему менеджеру UIS.
uiscom_offline_messages(message, site_id, campaign_id, visitor_session_id, phone, name)
Параметры:
message — текст заявки из параметров site_id, campaign_id, visitor_session_id должен быть передан только один
site_id — уникальный идентификатор сайта, с которого будет передана заявка (подробнее ниже)
campaign_id — уникальный идентификатор рекламной кампании в CoMagic (подробнее ниже)
Внимание! Если в campaign_id выберете id −1, то указывать надо site_id
visitor_session_id — Уникальный идентификатор сессии посетителя, полученный из CoMagic. Для получения ID необходимо использовать метод JS API Comagic.getSessionId()
Важно! Эти данные нужно будет получать с использованием JS API на своем сайте, а не через Salebot
phone — необязательный параметр, контактный номер телефона. Будет добавлен автоматически, если номер телефона присваивался какой-либо переменной ранее и не был передан в текущей функции.
name — имя клиента; если не передать в функции, то будет взято из раздела «Клиенты».
2. Функция для получения сайтов и их идентификаторов
uiscom_get_sites() — вернет словарь вида: {’test.ru’: 80913}. Ключ — доменное имя сайта, значение — его id.
3. Функция для получения рекламных кампаний и их идентификаторов
uiscom_get_campaigns() — вернет словарь вида: {’Тестовый источник’: 401745, ’Посетители без рекламной кампании’: −1}, где ключ — имя кампании, значение — его id.
