Событие при отправке сообщения ONIMBOTMESSAGEADD

Scope: imbot

Кто может подписаться: пользователь приложения, которое зарегистрировало чат-бота

DEPRECATED

Развитие события остановлено. Используйте ONIMBOTV2MESSAGEADD.

Событие ONIMBOTMESSAGEADD срабатывает при отправке сообщения в диалоге с чат-ботом. В групповом чате событие срабатывает, если упомянуть чат-бота.

События не будут отправляться в приложение, пока установка не завершена. Проверьте установку приложения

Что получает обработчик

Данные передаются в виде POST-запроса

Личный чат с ботом

Групповой чат

{
            "event": "ONIMBOTMESSAGEADD",
            "event_handler_id": "403",
            "data": {
                "BOT": {
                    "567": {
                        "access_token": "a98b9d690000071b0000084400000237f0f107589d1e",
                        "expires": "1771932585",
                        "expires_in": "3600",
                        "scope": "imbot",
                        "domain": "some-domain.bitrix24.ru",
                        "server_endpoint": "https://oauth.bitrix24.tech/rest/",
                        "status": "F",
                        "client_endpoint": "https://some-domain.bitrix24.ru/rest/",
                        "member_id": "bac1cd5c8940947a75e0d71b1a84e348",
                        "refresh_token": "990ac5690000071b0000084400000237",
                        "user_id": "567",
                        "client_id": "a7eff906dd1d950269258a599214f69e",
                        "application_token": "831c76b092f9f135d9b6b36c3a720757",
                        "AUTH": {
                            "access_token": "a98b9d690000071b0000084400000237f0f107589d1e",
                            "expires": "1771932585",
                            "expires_in": "3600",
                            "scope": "imbot",
                            "domain": "some-domain.bitrix24.ru",
                            "server_endpoint": "https://oauth.bitrix24.tech/rest/",
                            "status": "F",
                            "client_endpoint": "https://some-domain.bitrix24.ru/rest/",
                            "member_id": "bac1cd5c8940947a75e0d71b1a84e348",
                            "refresh_token": "990ac5690000071b0000084400000237",
                            "user_id": "567",
                            "client_id": "a7eff906dd1d950269258a599214f69e",
                            "application_token": "831c76b092f9f135d9b6b36c3a720757"
                        },
                        "BOT_ID": "567",
                        "BOT_CODE": "BOT1"
                    }
                },
                "PARAMS": {
                    "MESSAGE": "Привет",
                    "TEMPLATE_ID": "796c45aa-70e5-45aa-930c-c7fb32710c62",
                    "MESSAGE_TYPE": "P",
                    "FROM_USER_ID": "27",
                    "DIALOG_ID": "27",
                    "TO_CHAT_ID": "1407",
                    "AUTHOR_ID": "27",
                    "SYSTEM": "N",
                    "TO_USER_ID": "567",
                    "PUSH": "Y",
                    "PUSH_IMPORTANT": "N",
                    "RECENT_SKIP_AUTHOR": "N",
                    "CONVERT": "N",
                    "SKIP_COMMAND": "N",
                    "SKIP_COUNTER_INCREMENTS": "N",
                    "SILENT_CONNECTOR": "N",
                    "SKIP_CONNECTOR": "N",
                    "IMPORTANT_CONNECTOR": "N",
                    "NO_SESSION_OL": "N",
                    "FAKE_RELATION": "0",
                    "SKIP_URL_INDEX": "N",
                    "COMMAND_CONTEXT": "TEXTAREA",
                    "CHAT_USER_COUNT": "2",
                    "PLATFORM_CONTEXT": "web",
                    "MESSAGE_ID": "84331",
                    "CHAT_TYPE": "P",
                    "LANGUAGE": "ru"
                },
                "USER": {
                    "ID": "27",
                    "NAME": "Светлана Иванова",
                    "FIRST_NAME": "Светлана",
                    "LAST_NAME": "Иванова",
                    "WORK_POSITION": "",
                    "GENDER": "F",
                    "IS_BOT": "N",
                    "IS_CONNECTOR": "N",
                    "IS_NETWORK": "N",
                    "IS_EXTRANET": "N"
                }
            },
            "ts": "1771928985",
            "auth": {
                "access_token": "a98b9d690000071b000008440000001b0000071d8a2",
                "expires": "1771932585",
                "expires_in": "3600",
                "scope": "imbot",
                "domain": "some-domain.bitrix24.ru",
                "server_endpoint": "https://oauth.bitrix24.tech/rest/",
                "status": "F",
                "client_endpoint": "https://some-domain.bitrix24.ru/rest/",
                "member_id": "bac1cd5c8940947a75e0d71b1a84e348",
                "user_id": "27",
                "refresh_token": "990ac569071b000008440000001b000007f80ccc35b5e3",
                "application_token": "831c76b092f9f135d9b66c3a720757"
            }
        }

{
            "event": "ONIMBOTMESSAGEADD",
            "event_handler_id": "403",
            "data": {
                "BOT": {
                    "567": {
                        "access_token": "ccb69d690000071b0000084400000237f0f10799e08fc9016818e8b51ecc9f7b5342a5",
                        "expires": "1771943628",
                        "expires_in": "3600",
                        "scope": "imbot",
                        "domain": "some-domain.bitrix24.ru",
                        "server_endpoint": "https://oauth.bitrix24.tech/rest/",
                        "status": "F",
                        "client_endpoint": "https://some-domain.bitrix24.ru/rest/",
                        "member_id": "bac1cd5c8940947a75e0d71b1a84e348",
                        "refresh_token": "bc35c5690000071b0000084400000237f0f107abd386665cf9cfc96eaf25e017730bc5",
                        "user_id": "567",
                        "client_id": "a7eff906dd1d950269258a599214f69e",
                        "application_token": "831c76b092f9f135d9b6b36c3a720757",
                        "AUTH": {
                            "access_token": "ccb69d690000071b0000084400000237f0f10799e08fc9016818e8b51ecc9f7b5342a5",
                            "expires": "1771943628",
                            "expires_in": "3600",
                            "scope": "imbot",
                            "domain": "some-domain.bitrix24.ru",
                            "server_endpoint": "https://oauth.bitrix24.tech/rest/",
                            "status": "F",
                            "client_endpoint": "https://some-domain.bitrix24.ru/rest/",
                            "member_id": "bac1cd5c8940947a75e0d71b1a84e348",
                            "refresh_token": "bc35c5690000071b0000084400000237f0f107abd386665cf9cfc96eaf25e017730bc5",
                            "user_id": "567",
                            "client_id": "a7eff906dd1d950269258a599214f69e",
                            "application_token": "831c76b092f9f135d9b6b36c3a720757"
                        },
                        "BOT_ID": "567",
                        "BOT_CODE": "BOT1"
                    }
                },
                "PARAMS": {
                    "MESSAGE": ", как настроить левое меню",
                    "TEMPLATE_ID": "6d0eef7c-12b4-41e7-b709-887ba410ded3",
                    "MESSAGE_TYPE": "C",
                    "FROM_USER_ID": "27",
                    "DIALOG_ID": "chat1157",
                    "TO_CHAT_ID": "1157",
                    "AUTHOR_ID": "27",
                    "SYSTEM": "N",
                    "CHAT_ID": "1157",
                    "CHAT_TITLE": "Бурый чат №18",
                    "CHAT_AUTHOR_ID": "27",
                    "CHAT_TYPE": "C",
                    "CHAT_AVATAR": "0",
                    "CHAT_COLOR": "BROWN",
                    "CHAT_ENTITY_TYPE": "THREAD",
                    "CHAT_ENTITY_ID": "",
                    "CHAT_ENTITY_DATA_1": "",
                    "CHAT_ENTITY_DATA_2": "",
                    "CHAT_ENTITY_DATA_3": "",
                    "CHAT_EXTRANET": "N",
                    "CHAT_PREV_MESSAGE_ID": "80961",
                    "CHAT_CAN_POST": "MEMBER",
                    "RID": "27",
                    "IS_MANAGER": "N",
                    "PUSH": "Y",
                    "PUSH_IMPORTANT": "N",
                    "RECENT_SKIP_AUTHOR": "N",
                    "CONVERT": "N",
                    "SKIP_COMMAND": "N",
                    "SKIP_COUNTER_INCREMENTS": "N",
                    "SILENT_CONNECTOR": "N",
                    "SKIP_CONNECTOR": "N",
                    "IMPORTANT_CONNECTOR": "N",
                    "NO_SESSION_OL": "N",
                    "FAKE_RELATION": "0",
                    "SKIP_URL_INDEX": "N",
                    "COMMAND_CONTEXT": "TEXTAREA",
                    "CHAT_USER_COUNT": "2",
                    "MENTIONED_LIST": {
                        "567": "567"
                    },
                    "PLATFORM_CONTEXT": "web",
                    "MESSAGE_ORIGINAL": "[USER=567]NewBot[/USER] , как настроить левое меню",
                    "TO_USER_ID": "567",
                    "MESSAGE_ID": "84351",
                    "LANGUAGE": "ru"
                },
                "USER": {
                    "ID": "27",
                    "NAME": "Светлана Иванова",
                    "FIRST_NAME": "Светлана",
                    "LAST_NAME": "Иванова",
                    "WORK_POSITION": "",
                    "GENDER": "F",
                    "IS_BOT": "N",
                    "IS_CONNECTOR": "N",
                    "IS_NETWORK": "N",
                    "IS_EXTRANET": "N"
                }
            },
            "ts": "1771940028",
            "auth": {
                "access_token": "ccb69d690000071b000008440000001b0000078c69a6b996b744c26b73e80ddeda0052",
                "expires": "1771943628",
                "expires_in": "3600",
                "scope": "imbot",
                "domain": "some-domain.bitrix24.ru",
                "server_endpoint": "https://oauth.bitrix24.tech/rest/",
                "status": "F",
                "client_endpoint": "https://some-domain.bitrix24.ru/rest/",
                "member_id": "bac1cd5c8940947a75e0d71b1a84e348",
                "user_id": "27",
                "refresh_token": "bc35c5690000071b000008440000001b000007b7a839f68bc2cdd19de2677410425077",
                "application_token": "831c76b092f9f135d9b6b36c3a720757"
            }
        }

Параметр `тип`	Описание
event `string`	Символьный код события. В данном случае — `ONIMBOTMESSAGEADD`
event_handler_id `integer`	Идентификатор обработчика события
data `object`	Объект с данными события. Структура описана ниже
ts `timestamp`	Дата и время отправки события из очереди событий
auth `object`	Объект с параметрами авторизации пользователя, от имени которого сработало событие. Структура описана ниже

Параметр data

Параметр `тип`	Описание
BOT `object`	Набор параметров авторизации ботов, которым предназначено сообщение. Ключ объекта — идентификатор бота `BOT_ID`. Структура описана ниже
PARAMS `object`	Параметры сообщения. Структура описана ниже
USER `object`	Данные автора сообщения. Может быть пустым объектом, если `ID = 0`. Структура описана ниже

Параметр BOT

Параметр
тип

Описание

/{BOT_ID/}
object

Объект данных конкретного бота. Ключ соответствует идентификатору бота, например 567.

Структура описана ниже

Элемент /

Параметр `тип`	Описание
access_token `string`	OAuth-токен авторизации бота
expires `timestamp`	Момент окончания действия токена
expires_in `integer`	Время жизни токена в секундах
scope `string`	Скоуп, в рамках которого произошло событие
domain `string`	Адрес Битрикс24, на котором произошло событие
server_endpoint `string`	Адрес OAuth-сервера для REST-запросов
status `string`	Признак состояния приложения на портале
client_endpoint `string`	Общий путь для вызовов методов REST API для Битрикс24, на котором произошло событие
member_id `string`	Уникальный идентификатор Битрикс24
refresh_token `string`	OAuth-токен продления авторизации бота
user_id `integer`	Идентификатор пользователя-бота
client_id `string`	Идентификатор приложения, выданный при регистрации
application_token `string`	Токен приложения
AUTH `object`	Параметры авторизации бота в формате `auth`. Структура описана ниже
BOT_ID `integer`	Идентификатор бота
BOT_CODE `string`	Символьный код бота

Параметр PARAMS

Параметр `тип`	Описание
MESSAGE `string`	Текст сообщения
TEMPLATE_ID `string`	Идентификатор шаблона сообщения
MESSAGE_TYPE `string`	Тип сообщения. Возможные значения: `P` — private, личный чат `C` — group chat, групповой чат `O` — open chat, открытый чат `L` — open line, чат открытой линии `S` — system/notify, системное уведомление `N` — channel, канал `J` — open channel, открытый канал `T` — comment thread, ветка комментариев `A` — copilot chat, чат CoPilot `B` — collab, коллаб `X` — external, внешний чат
FROM_USER_ID `integer`	Идентификатор отправителя сообщения
DIALOG_ID `string`	Идентификатор диалога
TO_CHAT_ID `integer`	Идентификатор чата
AUTHOR_ID `integer`	Идентификатор автора сообщения
SYSTEM `string`	Признак системного сообщения: `Y` или `N`
TO_USER_ID `integer`	Идентификатор получателя сообщения
CHAT_ID `integer`	Идентификатор чата. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_TITLE `string`	Название чата. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_AUTHOR_ID `integer`	Идентификатор владельца чата. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_TYPE `string`	Тип чата. Возможные значения: `P` — private, личный чат `C` — group chat, групповой чат `O` — open chat, открытый чат `L` — open line, чат открытой линии `S` — system/notify, системное уведомление `N` — channel, канал `J` — open channel, открытый канал `T` — comment thread, ветка комментариев `A` — copilot chat, чат CoPilot `B` — collab, коллаб `X` — external, внешний чат
CHAT_AVATAR `string`	Идентификатор аватара чата. `0` — аватар не задан. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_COLOR `string`	Цветовая схема чата. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_ENTITY_TYPE `string`	Тип объекта, к которому привязан чат. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_ENTITY_ID `string`	Идентификатор объекта, к которой привязан чат. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_ENTITY_DATA_1 `string`	Дополнительные данные объекта чата — поле 1. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_ENTITY_DATA_2 `string`	Дополнительные данные объекта чата — поле 2. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_ENTITY_DATA_3 `string`	Дополнительные данные объекта чата — поле 3. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_EXTRANET `string`	Признак экстранет-чата: `Y` или `N`. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_PREV_MESSAGE_ID `integer`	Идентификатор предыдущего сообщения в чате. Параметр зависит от типа чата, в личном диалоге отсутствует
CHAT_CAN_POST `string`	Права текущего пользователя на отправку сообщений в чат. Параметр зависит от типа чата, в личном диалоге отсутствует
RID `integer`	Идентификатор записи связи пользователя с чатом, системный параметр
IS_MANAGER `string`	Признак роли менеджера: `Y` или `N`
PUSH `string`	Признак отправки push-уведомления: `Y` или `N`
PUSH_IMPORTANT `string`	Признак важного push-уведомления: `Y` или `N`
RECENT_SKIP_AUTHOR `string`	Признак исключения автора из списка Последние чаты: `Y` или `N`
CONVERT `string`	Признак конвертации форматирования сообщения: `Y` или `N`
SKIP_COMMAND `string`	Пропустить обработку команд в сообщении: `Y` или `N`
SKIP_COUNTER_INCREMENTS `string`	Не увеличивать счетчики непрочитанных: `Y` или `N`
SILENT_CONNECTOR `string`	Отправить сообщение в коннектор без уведомления: `Y` или `N`
SKIP_CONNECTOR `string`	Не отправлять сообщение во внешние коннекторы: `Y` или `N`
IMPORTANT_CONNECTOR `string`	Признак важного сообщения для коннектора: `Y` или `N`
NO_SESSION_OL `string`	Не создавать сессию открытой линии: `Y` или `N`
FAKE_RELATION `integer`	Системное значение связи пользователя с чатом
SKIP_URL_INDEX `string`	Не индексировать ссылки из сообщения: `Y` или `N`
COMMAND_CONTEXT `string`	Контекст ввода команды
CHAT_USER_COUNT `integer`	Количество участников чата. Параметр зависит от типа чата, в личном диалоге отсутствует
MENTIONED_LIST `object`	Упоминания пользователей в сообщении. Параметр зависит от типа чата, в личном диалоге отсутствует Структура описана ниже
PLATFORM_CONTEXT `string`	Платформа, из которой отправлено сообщение
MESSAGE_ORIGINAL `string`	Оригинальный текст сообщения с BB-кодом. Параметр зависит от типа чата, в личном диалоге отсутствует
MESSAGE_ID `integer`	Идентификатор сообщения
LANGUAGE `string`	Язык Битрикс24 по умолчанию

Параметр MENTIONED_LIST

Параметр `тип`	Описание
{USER_ID} `integer`	Идентификатор пользователя или бота, упомянутого в сообщении

Параметр USER

Параметр `тип`	Описание
ID `integer`	Идентификатор пользователя
NAME `string`	Имя и фамилия пользователя
FIRST_NAME `string`	Имя пользователя
LAST_NAME `string`	Фамилия пользователя
WORK_POSITION `string`	Должность пользователя
GENDER `string`	Пол пользователя: `M` или `F`
IS_BOT `string`	Признак пользователя-бота: `Y` или `N`
IS_CONNECTOR `string`	Признак пользователя-коннектора: `Y` или `N`
IS_NETWORK `string`	Признак внешнего сетевого пользователя: `Y` или `N`
IS_EXTRANET `string`	Признак экстранет-пользователя: `Y` или `N`

Параметр auth

Обязательные параметры отмечены *

Название `тип`	Описание
access_token `string`	Токен авторизации OAuth 2.0
expires_in `integer`	Время в секундах до истечения срока действия токена
scope* `string`	Скоуп, в рамках которого произошло событие
domain* `string`	Адрес Битрикс24, на котором произошло событие
server_endpoint* `string`	Адрес сервера авторизации Битрикс24, необходимый для обновления токенов OAuth 2.0
status* `string`	Статус приложения, подписавшегося на это событие: `L` — локальное приложение `F` — бесплатное тиражное приложение `S` — подписное тиражное приложение
client_endpoint* `string`	Общий путь для вызовов методов REST API для Битрикс24, на котором произошло событие
member_id* `string`	Идентификатор Битрикс24, на котором произошло событие
refresh_token `string`	Токен продления авторизации OAuth 2.0
application_token* `string`	Токен для безопасной обработки событий

Токены авторизации не всегда передаются в обработчик события. Если хит, инициировавший событие, не удалось привязать к конкретному пользователю Битрикс24, токены не передаются. Обязательно проверяйте содержимое ключа auth в коде.

Рекомендуем хранить токены, полученные ранее при установке приложения. Используйте их при работе с интерфейсом приложения в виде встроек, виджетов и так далее.

Продолжите изучение

Обзор событий

При изменении сообщения

Событие при отправке сообщения ONIMBOTMESSAGEADD

Что получает обработчикЧто получает обработчик

Параметр dataПараметр data

Параметр BOTПараметр BOT

Элемент /{BOT_ID/}Элемент /

Параметр PARAMSПараметр PARAMS

Параметр MENTIONED_LISTПараметр MENTIONED_LIST

Параметр USERПараметр USER

Параметр authПараметр auth

Продолжите изучениеПродолжите изучение