- Сервис онлайн-консультирования Webim
- -
- База знаний
- -
- Для разработчиков
- -
- Webim CRM postMessage Interface
-
-
-
- API сервиса Webim
- Webim Mobile SDK и мобильное приложение Webim для посетителя
- Встраивание чата Webim на сайт
- Идентификаторы посетителя
- Интеграция со сторонними сервисами
- Интерфейс виджета чата
- Логика обработки чатов
- Настройка сервиса Webim
- Операторы и РМО
- Отделы в сервисе Webim
- Панель приборов: ответы на вопросы
- Эксплуатация сервиса Webim
- Основные понятия и термины
- Сброс пароля
- Система управления ролями и правами доступа
- Шаг 1. Установка виджета Webim на сайт
- Шаг 2. Начальная настройка сервиса
- Шаг 3. Регистрация оператора
- Шаг 4. Подключение каналов общения
-
-
-
- 01. Обнаружение нового посетителя, ожидающего ответа
- 02. Выбор посетителя сайта из списка и начало диалога
- 03. Набор ответа посетителю, выбор шаблона
- 04. Запрос контактной информации у посетителя
- 05. Отправка файла посетителю
- 06. «Телепортация» пользователей
- 07. Переадресация диалога другому оператору
- 08. Отправка переписки на адрес электронной почты оператора
- 09. Назначение категории посетителю
- 10. Блокировка посетителя
- 11. Вставка гиперссылки в сообщение
- 12. Добавление cкрытых сообщений
- 13. Проверка орфографии
- Agent`s Handbook
- Горячие клавиши в РМО
- Загрузка файлов в диалог
- Исходящие диалоги
- Как включить оповещения в Google Chrome
- Очереди в РМО
- Работа с офлайн-обращениями в РМО
-
- Автоприглашения
- Активность сотрудников
- Алгоритмы назначения чатов
- Видимость диалогов
- Возможности и ограничения Webim в каналах общения
- Вход в систему
- Геолокация посетителей
- График работы
- Добавление кнопки Webim в E-mail
- Закрытие диалогов
- Логотип компании в заголовке чата
- Маршрутизация чатов между операторами и ботами
- Маска телефонного номера
- Настройка языков
- Общие настройки организации
- Ограничения по длине сообщений и полей
- Особенности функционала «Начать чат» в каналах общения
- Отделы
- Оценки
- Переназначение специализированных клавиш управления в РМО
- Приоритетные страницы
- Рассылки
- Регистрация операторов и назначение супервизоров
- Системные сообщения
- Список тайм-аутов
- Финансы
- Шаблоны ответов
-
-
- Встраивание административного интерфейса через iframe
- Горизонтальное масштабирование (кластеризация)
- Интеграция с почтовыми серверами
- Обработка файлов, загружаемых в чат
- Описание сервисных периодов Webim
- Параметры настроек сервера
- Редактор настроек аккаунта (account config)
- Редактор ресурсов
- Сетевые конфигурации сервиса Webim
-
-
-
- Webim Mobile SDK 3.0 для интеграции в мобильные приложения iOS
- Информация о выпусках (Release notes) – Webim Mobile SDK 3 для Android
- Информация о выпусках (Release notes) – Webim Mobile SDK 3 для iOS
- Справочник по Webim Mobile SDK – SDK для интеграции в мобильные приложения iOS (iPhone/iPad)
- Справочник по Webim Mobile SDK для интеграции в мобильные приложения Android
- Push-уведомления
- Webim Cordova Plugin
-
- Webim CRM postMessage Interface
- Как сделать ссылку кнопкой старта чата
- Маршрутизатор чатов
- Обработчики событий чата
- Процедура установки чата Webim на сайт в iframe
-
-
-
- Настройка интеграции с Facebook* (для версий до 10.0 включительно)
- Настройка интеграции с Facebook* с помощью приложения Webim
- Настройка интеграции с Instagram* с помощью приложения Webim
- Настройка приложения для интеграции с Facebook* (для версий до 10.0 включительно)
- Создание бизнес-аккаунта в Instagram*
- Создание страницы организации в Facebook*
- Skype
- Telegram
- Viber
- ВКонтакте
- Одноклассники
-
-
Webim CRM postMessage Interface
СОДЕРЖАНИЕ
Передаваемые события
При включении postMessage-интеграции Webim начинает передавать в родительское окно CRM-системы события типов, описанных в данном разделе.
Для того, чтобы отправлять наборы данных CRM, на сервере Webim должны быть заданы соответствующие настройки, так как по умолчанию это запрещено из соображений безопасности. Если сервис Webim размещён на облачных серверах, то необходимо обращаться в техническую поддержку Webim. Если на ваших серверах, в конфигурации аккаунта в поле operator_iframe_allowed_parent_origin
требуется добавить origin окна (окон), на которые требуется отправлять события.
В теории, РМО можно встроить в любую CRM, которая предусматривает возможность расширения своего интерфейса и вставки сторонних разработчиков в свой веб-интерфейс через iframe. На практике тестировалось встраивание через iframe в Siebel CRM.
Данные передаются в формате JSON.
Общий вид передаваемых данных:
{ "source": "webim", "event": (тип события), "params": (дополнительные параметры) }
Пример передаваемых данных:
{ "source": "webim", "event": "chatClosedByOperator", "params": { "webimVisitorId": "c3fa5841c772895f8645b33ac784f694", "providedVisitorId": "12345", "chatId": 1024, "siebelId": "4-1GQJDL78", "channelId": "073afd9ccfee448dba19a5c974940bfc", "channelType": "vk", "channelUserId": "16248561", "channelUserName": "Пётр Петрович" } }
Событие newMessageAdded
Событие вызывается, когда посетитель или оператор оставляет сообщение в чате.Пример полей объекта params
для события newMessageAdded
:
{ "webimVisitorId": "c3fa5841c772895f8645b33ac784f694", "providedVisitorId": "12345", "chatId": 483, "sessionId" : "c9905a4eab2a4148add9b1c8ac97ad7d", "kind": "visitor", "messageText": "Здравствуйте", "siebelId": "4-1GQDLH42" }
Описание полей:
Название параметра | Тип | Описание |
---|---|---|
webimVisitorId | String | Внутренний идентификатор посетителя в системе Webim. Пример: "e01baca71a28557b52b4e6038d12bcb8" |
providedVisitorId | String | Идентификатор посетителя, присваиваемый в системе клиента, сообщаемый клиентом сервису Webim. Его вид зависит от того, какого вида идентификаторы используются в системе клиента. |
chatId | Integer | Идентификатор чата Webim, который создаётся, как правило, после первого сообщения посетителя. Пример: 874 |
sessionId | String | Идентификатор сессии Webim. Пример: "c8405a4eab2a4945add9b1c8ac97ad7d" |
kind | String | Тип сообщения. Полный перечень типов и подтипов сообщений можно посмотреть здесь. |
messageText | String | Текст сообщения. |
SiebelId | String | Идентификатор посетителя в CRM Siebel. Пример: "4-1GQJDL78" |
Событие chatClosedByOperator
Событие вызывается, когда чат был закрыт оператором.Пример полей объекта params
для события chatClosedByOperator
(посетитель с канала общения ВКонтакте):
{ "webimVisitorId": "c3fa5841c772895f8645b33ac784f694", "providedVisitorId": "12345", "chatId": 1024 "siebelId": "4-1GQJDL78", "channelId": "073afd9ccfee448dba19a5c974940bfc", "channelType": "vk", "channelUserId": "16248561", "channelUserName": "Пётр Петрович" }
Пример полей объекта params
для события chatClosedByOperator
(посетитель из неавторизованной зоны):
{ "webimVisitorId": "c3fa5841c772895f8645b33ac784f694", "providedVisitorId": null, "chatId": 1024 "siebelId": null, "channelId": null, "channelType": null, "channelUserId": null, "channelUserName": null }
Описание полей:
Название параметра | Тип | Описание |
---|---|---|
webimVisitorId | String | Внутренний идентификатор посетителя в системе Webim. Пример: "e01baca71a28557b52b4e6038d12bcb8" |
providedVisitorId | String | Идентификатор посетителя, присваиваемый в системе клиента, сообщаемый клиентом сервису Webim. Его вид зависит от того, какого вида идентификаторы используются в системе клиента. |
chatId | Integer | Идентификатор чата Webim, который создаётся, как правило, после первого сообщения посетителя. Пример: 874 |
SiebelId | String | Идентификатор посетителя в CRM Siebel. Пример: "4-1GQJDL78" |
channelId | String | Идентификатор канала, из которого поступил чат, в системе Webim. Пример: "073afd9ccfee448dba19a5c974940bfc" |
channelType | String | Тип канала, откуда поступило обращение. Пример: "telegram" |
channelUserId | String | Идентификатор посетителя на стороне канала. Его вид зависит от того, какого вида идентификаторы используются в канале. Пример: "95851142" (id посетителя в telegram) |
channelUserName | String | Имя посетителя в канале, с которого поступил чат. Пример: "username" |
Событие visitorAuthorized
Событие вызывается, когда посетитель авторизуется. Общий вид:
{ "old": { //данные до авторизации "webimVisitorId": "66b46319af05e55ac9fd34aa541e9eee", "providedVisitorId": null, "siebelId": null }, "new": { //данные после авторизации "webimVisitorId": "52eed6ec3c12494a88e62e2ff636c2a9", "providedVisitorId": "7925", "siebelId": null } }
Описание полей:
Название параметра | Тип | Описание |
---|---|---|
webimVisitorId | String | Внутренний идентификатор посетителя в системе Webim. Пример: "e01baca71a28557b52b4e6038d12bcb8" |
providedVisitorId | String | Идентификатор посетителя, присваиваемый в системе клиента, сообщаемый клиентом сервису Webim. При каждой новой авторизации его значение заменяется на новое. Его вид зависит от того, какого вида идентификаторы используются в системе клиента. |
SiebelId | String | Идентификатор посетителя в CRM Siebel. Пример: "4-1GQJDL78" |
Событие visitorSelected
Событие вызывается, когда оператор открыл чат с посетителем в РМО. Пример:
{ "webimVisitorId": "c3fa5841c772895f8645b33ac784f694", "providedVisitorId": "12345", "chatId": 874, "sessionId" : "c9905a4eab2a4148add9b1c8ac97ad7d", "taskId": "20913584", "siebelId": "4-1GQJDL78" }
Описание полей:
Название параметра | Тип | Описание |
---|---|---|
webimVisitorId | String | Внутренний идентификатор посетителя в системе Webim. Пример: "e01baca71a28557b52b4e6038d12bcb8" |
providedVisitorId | String | Идентификатор посетителя, присваиваемый в системе клиента, сообщаемый клиентом сервису Webim. Его вид зависит от того, какого вида идентификаторы используются в системе клиента. |
chatId | Integer | Идентификатор чата Webim, который создаётся, как правило, после первого сообщения посетителя. Пример: 874 |
sessionId | String | Идентификатор сессии Webim. Пример: "c8405a4eab2a4945add9b1c8ac97ad7d" |
taskId | String | Идентификатор задачи в CRM, обогащающий объект посетителя. Связан с siebelId. Используется в маршрутизаторе чатов. |
SiebelId | String | Идентификатор посетителя в CRM Siebel. Пример: "4-1GQJDL78" |
Событие notificationAdded
Событие вызывается, когда приходит уведомление. Пример параметра params
для события notificationAdded
:
{ "notification": { "id": "c9905a4eab2a4148add9b1c8ac97ad7d", "kind": "visitor", "text": "Посетитель покинул чат", "sessionId": "c3fa5841c772895f8645b33ac784f694" } }
Описание полей параметра params:
Название параметра | Тип | Описание |
---|---|---|
id | String | Идентификатор уведомления. Пример: "c9905a4eab2a4148add9b1c8ac97ad7d" |
kind | String | Тип уведомления. |
text | String | Текст уведомления. |
sessionId | String | Идентификатор сессии Webim. Пример: "c3fa5841c772895f8645b33ac784f694" |
Событие notificationRemoved
Событие вызывается, если уведомление было удалено (вне зависимости от того, было ли оно отсмотрено пользователем). Пример параметра params
для события notificationRemoved
:
{ "notification": { "id": "c9905a4eab2a4148add9b1c8ac97ad7d", } }
Описание полей параметра params:
Название параметра | Тип | Описание |
---|---|---|
id | String | Идентификатор уведомления. Пример: "c9905a4eab2a4148add9b1c8ac97ad7d" |
Приходящие события
При включении postMessage-интеграции Webim получает из родительского окна CRM-системы события типа message
.
Событие message
message
, при помощи которого родительское окно CRM передаёт данные в РМО через iframe.Описание параметров события типа
message
:
Название параметра | Тип | Пример | Описание | Обязательность |
---|---|---|---|---|
source | Object | — | Ссылка на объект window, отправивший событие. Source может быть использован для установки соединения между окнами с разными origins. | Нет |
origin | String | https://somecrm.com | URL-адрес CRM-системы клиента. | Да |
data.action | String | start_outgoing_chat |
Событие, отправляемое CRM-системой клиента. Может принимать значение start_outgoing_chat , при котором оператором начинается исходящий чат. |
Да |
data.params.webimVisitorId | String | e01baca71a28557b52b4e6038d12bcb8 | Внутренний идентификатор посетителя в системе Webim. | Да |
data.params.sessionId | String | c8405a4eab2a4945add9b1c8ac97ad7d | Идентификатор сессии Webim. | Да |
При неудачной попытке начать чат могут быть возвращены следующие ошибки, текст которых определяется в редакторе ресурсов:
Код ошибки | Текст ошибки |
---|---|
operator_cant_start_chat_with_visitor_from_another_department |
Вы не можете приглашать к диалогу посетителей из другого отдела. |
visitor_starting_chat_from_his_side |
Вы не можете пригласить к диалогу посетителя в связи с тем, что он начинает диалог со своей стороны. |
visitor_already_in_chat |
Посетитель уже в диалоге |
no_tariff_option |
Для выполнения данного действия необходимо перейти на другой тариф либо подключить соответствующую тарифную опцию. |
unable_to_start_outgoing_chat |
При создании чата произошла ошибка [при неизвестной ошибке]. |