Форматы событий im.v2

Описание всех событий, которые пользовательское приложение получает через im.v2.Event.get.

Поля объектов message, chat, user описаны в Объекты и поля чат-ботов 2.0.

Быстрый переход: ONIMV2MESSAGEADD | ONIMV2MESSAGEUPDATE | ONIMV2MESSAGEDELETE | ONIMV2REACTIONCHANGE | ONIMV2JOINCHAT

Отличия от ответов методов

В данных событий объекты chat и user возвращаются в сокращенном формате:

объект chat не содержит полей role и muteList — они зависят от конкретного пользователя и не могут быть одинаковыми для всех получателей
объект user не содержит полей network, botData, avatarHr
поля онлайн-статуса (idle, lastActivityDate, mobileLastDate, desktopLastDate) всегда равны false

В этой статье описан формат событий метода im.v2.Event.get (polling/FETCH), поэтому поле auth в данных события не возвращается.

Если использовать webhook-подписку на события, в webhook-обертке может присутствовать объект auth с токенами.

ONIMV2MESSAGEADD

Новое сообщение в чате, в котором состоит подписанный пользователь.

Поле	Тип	Описание
message	`Message`	Отправленное сообщение. Описание полей объекта — Message
chat	`Chat`	Чат, в котором отправлено сообщение. Описание полей объекта — Chat
user	`User`	Автор сообщения. Описание полей объекта — User
language	`string`	Язык портала (например, `en`, `ru`)

Пример данных

{
            "message": {
                "id": 5012,
                "chatId": 5,
                "authorId": 1,
                "date": "2025-01-15T10:30:00+03:00",
                "text": "Hello everyone!",
                "isSystem": false,
                "uuid": "",
                "forward": null,
                "params": {},
                "viewedByOthers": false
            },
            "chat": {
                "id": 5,
                "dialogId": "chat5",
                "name": "Project Chat",
                "type": "chat",
                "messageType": "C",
                "owner": 1,
                "color": "#ab7761",
                "avatar": "",
                "description": "",
                "extranet": false,
                "containsCollaber": false,
                "entityType": "",
                "entityId": "",
                "entityData1": "",
                "entityData2": "",
                "entityData3": "",
                "entityLink": {},
                "diskFolderId": 42,
                "permissions": {},
                "parentChatId": 0,
                "parentMessageId": 0,
                "isNew": false,
                "textFieldEnabled": "Y",
                "backgroundId": null
            },
            "user": {
                "id": 1,
                "active": true,
                "name": "John Smith",
                "firstName": "John",
                "lastName": "Smith",
                "workPosition": "Developer",
                "color": "#df532d",
                "avatar": "",
                "gender": "M",
                "birthday": "",
                "extranet": false,
                "bot": false,
                "connector": false,
                "externalAuthId": "default",
                "status": "online",
                "idle": false,
                "lastActivityDate": false,
                "mobileLastDate": false,
                "desktopLastDate": false,
                "absent": false,
                "departments": [1],
                "phones": false,
                "website": "",
                "email": "john@example.com",
                "type": "employee"
            },
            "language": "en"
        }

ONIMV2MESSAGEUPDATE

Сообщение в чате отредактировано.

Поле	Тип	Описание
message	`Message`	Обновленное сообщение. Описание полей объекта — Message
chat	`Chat`	Чат, в котором отредактировано сообщение. Описание полей объекта — Chat
user	`User`	Автор сообщения. Описание полей объекта — User
language	`string`	Язык портала

Формат данных идентичен ONIMV2MESSAGEADD. Поле message содержит обновленный текст.

ONIMV2MESSAGEDELETE

Сообщение в чате удалено.

Поле	Тип	Описание
messageId	`integer`	ID удаленного сообщения
chat	`Chat`	Чат, в котором удалено сообщение. Описание полей объекта — Chat
user	`User`	Автор сообщения. Описание полей объекта — User
language	`string`	Язык портала

ONIMV2REACTIONCHANGE

Реакция на сообщение в чате добавлена или удалена.

Поле	Тип	Описание
reaction	`string`	Код реакции (например, `like`)
action	`string`	Действие: `add` — реакция добавлена, `delete` — удалена
message	`Message`	Сообщение, на которое изменена реакция. Описание полей объекта — Message
chat	`Chat`	Чат. Описание полей объекта — Chat
user	`User`	Пользователь, изменивший реакцию. Описание полей объекта — User
language	`string`	Язык портала

ONIMV2JOINCHAT

Новый участник добавлен в чат.

Поле	Тип	Описание
dialogId	`string`	ID диалога (например, `chat5`)
chat	`Chat`	Чат, в который добавлен участник. Описание полей объекта — Chat
user	`User`	Добавленный пользователь. Описание полей объекта — User
language	`string`	Язык портала

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

Получить события пользователя

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

Форматы событий im.v2

Отличия от ответов методовОтличия от ответов методов

ONIMV2MESSAGEADDONIMV2MESSAGEADD

Пример данныхПример данных

ONIMV2MESSAGEUPDATEONIMV2MESSAGEUPDATE

ONIMV2MESSAGEDELETEONIMV2MESSAGEDELETE

ONIMV2REACTIONCHANGEONIMV2REACTIONCHANGE

ONIMV2JOINCHATONIMV2JOINCHAT

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