Форматы событий im.v2
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
imКто может подписаться: авторизованный пользователь
Описание всех событий, которые приложение или пользователь получает через im.v2.Event.get.
Битрикс24 записывает события только после вызова im.v2.Event.subscribe от имени пользователя, а доставляет их только в режиме polling — вызовами im.v2.Event.get. Порядок подписки и опроса описан в обзоре Работа с чатом.
Каждое событие приходит элементом массива result.events с полями eventId, type, date и data. Таблицы и примеры ниже описывают содержимое data; оболочка элемента описана на странице im.v2.Event.get. Поля объектов message, chat, user описаны в Объекты и поля чат-ботов 2.0.
Быстрый переход: все события
Обзор событий
|
Событие |
Когда приходит |
|
Новое сообщение в чате, где состоит подписанный пользователь |
|
|
Сообщение отредактировано |
|
|
Сообщение удалено |
|
|
Реакция на сообщение добавлена или удалена |
|
|
В чат добавлен новый участник |
Отличия от ответов методов
В данных событий объекты chat и user возвращаются в сокращенном формате:
- объект
chatне содержит полейroleиmuteList— они зависят от конкретного пользователя и не могут быть одинаковыми для всех получателей - объект
userне содержит полейnetwork,botData,avatarHr - поля онлайн-статуса (
idle,lastActivityDate,mobileLastDate,desktopLastDate) всегда равныfalse
Поля auth в данных события нет: события im.v2 не вызывают обработчик приложения, а приходят в ответе im.v2.Event.get, поэтому авторизация передается в самом запросе.
ONIMV2MESSAGEADD
Новое сообщение в чате, в котором состоит подписанный пользователь.
|
Поле |
Тип |
Описание |
|
message |
Отправленное сообщение. Описание полей объекта — Message |
|
|
chat |
Чат, в котором отправлено сообщение. Описание полей объекта — Chat |
|
|
user |
Автор сообщения. Описание полей объекта — User |
|
|
language |
|
Язык Битрикс24 (например, |
Пример данных
{
"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 |
|
|
chat |
Чат, в котором отредактировано сообщение. Описание полей объекта — Chat |
|
|
user |
Автор сообщения. Описание полей объекта — User |
|
|
language |
|
Язык Битрикс24 |
Формат данных идентичен ONIMV2MESSAGEADD. Поле message содержит обновленный текст.
ONIMV2MESSAGEDELETE
Сообщение в чате удалено.
|
Поле |
Тип |
Описание |
|
messageId |
|
ID удаленного сообщения |
|
chat |
Чат, в котором удалено сообщение. Описание полей объекта — Chat |
|
|
user |
Автор сообщения. Описание полей объекта — User |
|
|
language |
|
Язык Битрикс24 |
Пример данных
Объекты chat и user здесь и в примерах ниже сокращены. Полный состав — в примере ONIMV2MESSAGEADD.
{
"messageId": 5012,
"chat": {
"id": 5,
"dialogId": "chat5",
"name": "Project Chat",
"type": "chat"
},
"user": {
"id": 1,
"name": "John Smith",
"type": "employee"
},
"language": "en"
}
ONIMV2REACTIONCHANGE
Реакция на сообщение в чате добавлена или удалена.
|
Поле |
Тип |
Описание |
|
reaction |
|
Код реакции (например, |
|
action |
|
Действие: |
|
message |
Сообщение, на которое изменена реакция. Описание полей объекта — Message |
|
|
chat |
Чат. Описание полей объекта — Chat |
|
|
user |
Пользователь, изменивший реакцию. Описание полей объекта — User |
|
|
language |
|
Язык Битрикс24 |
Пример данных
{
"reaction": "like",
"action": "add",
"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"
},
"user": {
"id": 2,
"name": "Jane Doe",
"type": "employee"
},
"language": "en"
}
ONIMV2JOINCHAT
Новый участник добавлен в чат.
|
Поле |
Тип |
Описание |
|
dialogId |
|
ID диалога (например, |
|
chat |
Чат, в который добавлен участник. Описание полей объекта — Chat |
|
|
user |
Добавленный пользователь. Описание полей объекта — User |
|
|
language |
|
Язык Битрикс24 |
Пример данных
{
"dialogId": "chat5",
"chat": {
"id": 5,
"dialogId": "chat5",
"name": "Project Chat",
"type": "chat"
},
"user": {
"id": 3,
"name": "Alex Brown",
"type": "employee"
},
"language": "en"
}