Событие при добавлении бота в чат ONIMBOTJOINCHAT

Scope: imbot

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

DEPRECATED

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

Событие ONIMBOTJOINCHAT срабатывает при добавлении бота в чат.

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

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

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

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

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

{
            "event": "ONIMBOTJOINCHAT",
            "event_handler_id": "459",
            "data": {
                "BOT": {
                    "571": {
                        "access_token": "e703a069000071b00084400023bf0f10751a702af1e",
                        "expires": "1772094439",
                        "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": "d782c76900071b00084400023bf0f1077047d2feeb6c5f3fb",
                        "user_id": "571",
                        "client_id": "a7eff906dd1d950269258a599214f69e",
                        "application_token": "831c76b092f9f135d9b6b36c3a720757",
                        "AUTH": {
                            "access_token": "e703a069000071b00084400023bf0f10751a702af1e",
                            "expires": "1772094439",
                            "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": "d782c76900071b00084400023bf0f1077047d2feeb6c5f3fb",
                            "user_id": "571",
                            "client_id": "a7eff906dd1d950269258a599214f69e",
                            "application_token": "831c76b092f9f135d9b6b36c3a720757"
                        },
                        "BOT_ID": "571",
                        "BOT_CODE": "BOT"
                    }
                },
                "PARAMS": {
                    "CHAT_TYPE": "P",
                    "MESSAGE_TYPE": "P",
                    "BOT_ID": "571",
                    "USER_ID": "27",
                    "TO_USER_ID": "27",
                    "FROM_USER_ID": "571",
                    "DIALOG_ID": "27",
                    "LANGUAGE": "ru"
                },
                "USER": {
                    "ID": "27",
                    "NAME": "Светлана Иванова",
                    "FIRST_NAME": "Светлана",
                    "LAST_NAME": "Иванова",
                    "WORK_POSITION": "",
                    "GENDER": "F"
                }
            },
            "ts": "1772090839",
            "auth": {
                "access_token": "e703a06900071b00084400001b00074523806a5537056abff",
                "expires": "1772094439",
                "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",
                "application_token": "831c76b092f9f135d9b6b36c3a720757"
            }
        }

{
            "event": "ONIMBOTJOINCHAT",
            "event_handler_id": "459",
            "data": {
                "BOT": {
                    "571": {
                        "access_token": "4d12a06900071b00084400023bf0f1079c6f8b9190c698fd2",
                        "expires": "1772098125",
                        "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": "3d91c7690000071b00084400023bf0f107580dad11018e",
                        "user_id": "571",
                        "client_id": "a7eff906dd1d950269258a599214f69e",
                        "application_token": "831c76b092f9f135d9b6b36c3a720757",
                        "AUTH": {
                            "access_token": "4d12a06900071b00084400023bf0f1079c6f8b9190c698fd2",
                            "expires": "1772098125",
                            "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": "3d91c7690000071b00084400023bf0f107580dad11018e",
                            "user_id": "571",
                            "client_id": "a7eff906dd1d950269258a599214f69e",
                            "application_token": "831c76b092f9f135d9b6b36c3a720757"
                        },
                        "BOT_ID": "571",
                        "BOT_CODE": "BOT"
                    }
                },
                "PARAMS": {
                    "CHAT_TYPE": "C",
                    "MESSAGE_TYPE": "C",
                    "BOT_ID": "571",
                    "USER_ID": "27",
                    "CHAT_ID": "1157",
                    "CHAT_AUTHOR_ID": "27",
                    "CHAT_ENTITY_TYPE": "THREAD",
                    "CHAT_ENTITY_ID": "",
                    "ACCESS_HISTORY": "1",
                    "DIALOG_ID": "chat1157",
                    "LANGUAGE": "ru"
                },
                "USER": {
                    "ID": "27",
                    "NAME": "Светлана Иванова",
                    "FIRST_NAME": "Светлана",
                    "LAST_NAME": "Иванова",
                    "WORK_POSITION": "",
                    "GENDER": "F"
                }
            },
            "ts": "1772094525",
            "auth": {
                "access_token": "4e12a06900071b00084400001b000070de69612254f5f11a912b908",
                "expires": "1772098126",
                "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",
                "application_token": "831c76b092f9f135d9b6b36c3a720757"
            }
        }

Параметр `тип`	Описание
event `string`	Символьный код события. В данном случае — `ONIMBOTJOINCHAT`
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

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

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

Элемент /

Параметр `тип`	Описание
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 на портале, где произошло событие
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

Параметр `тип`	Описание
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, внешний чат
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, внешний чат
BOT_ID `integer`	Идентификатор бота
USER_ID `integer`	Идентификатор пользователя, который добавил бота
TO_USER_ID `integer`	Идентификатор пользователя, с которым создан личный диалог. Параметр только для личного чата
FROM_USER_ID `integer`	Идентификатор бота в личном диалоге. Параметр только для личного чата
CHAT_ID `integer`	Идентификатор группового чата. Параметр только для группового чата
CHAT_AUTHOR_ID `integer`	Идентификатор владельца группового чата. Параметр только для группового чата
CHAT_ENTITY_TYPE `string`	Тип объекта, к которой привязан групповой чат. Параметр только для группового чата
CHAT_ENTITY_ID `string`	Идентификатор объекта, к которой привязан групповой чат. Параметр только для группового чата
ACCESS_HISTORY `integer`	Признак доступа бота к истории: `1` — доступ есть, `0` — без доступа. Параметр только для группового чата
SILENT_JOIN `string`	Признак добавления бота без системного сообщения: `Y` или `N`. Параметр только для группового чата Copilot
DIALOG_ID `string`	Идентификатор диалога
LANGUAGE `string`	Язык Битрикс24 по умолчанию

Параметр USER

Параметр `тип`	Описание
ID `integer`	Идентификатор пользователя
NAME `string`	Имя и фамилия пользователя
FIRST_NAME `string`	Имя пользователя
LAST_NAME `string`	Фамилия пользователя
WORK_POSITION `string`	Должность пользователя
GENDER `string`	Пол пользователя: `M` или `F`

Параметр 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 в коде.

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

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

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

Обзор методов

Событие при добавлении бота в чат ONIMBOTJOINCHAT

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

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

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

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

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

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

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

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