REST: imconnector (свой мессенджер)

Группа методов imconnector.* позволяет подключить любой внешний канал общения — собственный виджет, нестандартный мессенджер, стороннюю платформу — к Открытым линиям Битрикс24. Сообщения клиентов попадают операторам в единый интерфейс, а ответы уходят обратно в ваш канал. Разберём регистрацию коннектора и двусторонний обмен сообщениями.

Как устроен коннектор

Коннектор — это мост между вашим каналом и Открытыми линиями (Contact Center). Схема работы двусторонняя:

• Входящие: клиент пишет в вашем канале → ваш сервер вызывает imconnector.send.messages → сообщение появляется у оператора;
• Исходящие: оператор отвечает в Битрикс24 → портал вызывает ваш обработчик OnImConnectorMessageAdd → вы доставляете ответ клиенту.

Коннектор регистрируется в контексте приложения и привязывается к конкретной Открытой линии. Одно приложение может обслуживать несколько линий и порталов.

Регистрация: imconnector.register

Метод imconnector.register объявляет новый тип канала. Основные параметры:

После регистрации канал появляется в списке подключений Открытой линии. Удаляется коннектор методом imconnector.unregister.

Активация и данные линии

Регистрация лишь объявляет тип канала. Чтобы связать его с конкретной Открытой линией, коннектор нужно активировать:

1. imconnector.activate — включить коннектор для линии (CONNECTOR, LINE, ACTIVE);
2. imconnector.connector.data.set — записать данные подключения (название страницы, аватар, ссылка на канал);
3. imconnector.status — проверить, активен ли коннектор на линии.

Параметр LINE — это ID Открытой линии, к которой привязывается канал. Его можно получить из настроек Contact Center или через соответствующие методы imopenlines.*.

Входящие сообщения: send.messages

Сообщение клиента передаётся оператору методом imconnector.send.messages. В нём важна структура: кто написал (user), в каком чате (chat) и что именно (message).

{ "CONNECTOR": "my_channel", "LINE": 7, "MESSAGES": [ { "user": { "id": "client-88", "name": "Иван Петров" }, "chat": { "id": "client-88" }, "message": { "id": "m-1024", "text": "Здравствуйте, где мой заказ?" } } ] }

Поле user.id — стабильный идентификатор клиента в вашей системе; по нему Битрикс24 связывает сообщения в один диалог и создаёт контакт в CRM. Идентификатор message.id нужен для последующей отправки статусов доставки и прочтения.

Исходящие ответы и статусы

Когда оператор отвечает в Битрикс24, портал вызывает событие OnImConnectorMessageAdd на URL, указанный при регистрации приложения. Ваш сервер разбирает payload и доставляет текст клиенту в исходном канале.

Обратная связь о доставке возвращается двумя методами:

• imconnector.send.status.delivery — сообщение доставлено клиенту;
• imconnector.send.status.reading — сообщение прочитано клиентом.

Оба метода принимают идентификаторы сообщений, чтобы оператор в интерфейсе видел актуальные «галочки» доставки и прочтения — как в привычных мессенджерах.

Практика подключения

Типовой сценарий разработки коннектора выглядит так:

1. Создать локальное приложение с правами imconnector и imopenlines;
2. Зарегистрировать коннектор (imconnector.register);
3. Реализовать страницу настройки (placement) и обработчик исходящих событий;
4. Активировать коннектор на линии и записать данные подключения;
5. Настроить входящий поток через send.messages и статусы.

Итог

Группа imconnector.* превращает любой внешний канал в полноценный источник обращений для Открытых линий Битрikс24. Ключевые шаги — регистрация, активация на линии, входящий поток через send.messages и обработка исходящих через событие OnImConnectorMessageAdd, дополненная статусами доставки и прочтения.

Мы разрабатываем коннекторы под нестандартные каналы: собственные виджеты, отраслевые мессенджеры, сторонние платформы поддержки. Настроим корректное сопоставление клиентов с CRM, устойчивую доставку и обработку статусов, чтобы операторы вели все диалоги в одном окне.