Получить список последних сообщений im.dialog.messages.get
Scope:
imКто может выполнять метод: участник чата
Метод im.dialog.messages.get получает сообщения указанного диалога, в том числе системные. Не поддерживает стандартную постраничную навигацию из-за потенциально большого объема данных
Получить сообщения без участия в чате можно только для чатов открытой линии через метод imopenlines.session.history.get
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
DIALOG_ID* |
Идентификатор чата в формате:
Идентификатор чата можно получить с помощью метода im.chat.get. Идентификатор пользователя — с помощью методов user.get и user.search |
|
LAST_ID |
Идентификатор сообщения, старше которого нужно загрузить сообщения. Метод вернет сообщения с идентификатором меньше указанного |
|
FIRST_ID |
Идентификатор сообщения, новее которого нужно загрузить сообщения. Метод вернет сообщения с идентификатором больше указанного. Чтобы загрузить самые первые сообщения диалога — передайте |
|
LIMIT |
Ограничение на количество сообщений в ответе. Если не переданы По умолчанию — |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DIALOG_ID":"chat1489","FIRST_ID":84869,"LIMIT":10}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.dialog.messages.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DIALOG_ID":"chat1489","FIRST_ID":84869,"LIMIT":10,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.dialog.messages.get
try
{
const response = await $b24.callMethod(
'im.dialog.messages.get',
{
DIALOG_ID: 'chat1489',
FIRST_ID: 84869,
LIMIT: 10
}
);
console.log(response.getData().result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service->core->call(
'im.dialog.messages.get',
[
'DIALOG_ID' => 'chat1489',
'FIRST_ID' => 84869,
'LIMIT' => 10,
]
);
$result = $response->getResponseData()->getResult();
print_r($result);
} catch (Throwable $e) {
error_log($e->getMessage());
}
BX24.callMethod(
'im.dialog.messages.get',
{
DIALOG_ID: 'chat1489',
FIRST_ID: 84869,
LIMIT: 10
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.dialog.messages.get',
[
'DIALOG_ID' => 'chat1489',
'FIRST_ID' => 84869,
'LIMIT' => 10,
]
);
print_r($result);
Обработка ответа
HTTP-статус: 200
{
"result": {
"chat_id": 1489,
"messages": [
{
"id": 84877,
"chat_id": 1489,
"author_id": 503,
"date": "2026-03-04T09:43:26+03:00",
"text": "Рады тебе очень!",
"unread": false,
"uuid": "0c42a08f-4235-49fc-994f-c9bccd499ac1",
"replaces": [],
"params": {
"LIKE": [547]
},
"disappearing_date": null
},
{
"id": 84875,
"chat_id": 1489,
"author_id": 503,
"date": "2026-03-04T09:43:21+03:00",
"text": "Привет, Анна! Здесь будем обсуждать проект.",
"unread": false,
"uuid": "db2e826a-dd18-4ab5-b76c-4084e106ee28",
"replaces": [],
"params": [],
"disappearing_date": null
},
...,
{
"id": 84869,
"chat_id": 1489,
"author_id": 0,
"date": "2026-03-04T09:42:31+03:00",
"text": "[USER=503 REPLACE]Иван Иванов[/USER] пригласил в чат [USER=547 REPLACE]Анна Петрова[/USER]",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"CODE": ["CHAT_JOIN"],
"NOTIFY": "N"
},
"disappearing_date": null
},
...
],
"users": [
{
"id": 503,
"active": true,
"name": "Иван Иванов",
"first_name": "Иван",
"last_name": "Иванов",
"work_position": "админ",
"color": "#4ba984",
"avatar": "https://mysite.ru/upload/resize_cache/main/avatar.jpg",
"avatar_hr": "https://mysite.ru/upload/resize_cache/main/avatar.jpg",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2026-03-04T10:13:14+03:00",
"mobile_last_date": false,
"desktop_last_date": false,
"absent": false,
"departments": [667],
"phones": false,
"bot_data": null,
"type": "user",
"website": "",
"email": "ivanov@mysite.ru"
},
{
"id": 547,
"active": true,
"name": "Анна Петрова",
"first_name": "Анна",
"last_name": "Петрова",
...
}
],
"files": [
{
"id": 5255,
"chatId": 1489,
"date": "2026-03-02T16:10:00+03:00",
"type": "image",
"name": "image.png",
"extension": "png",
"size": 2144,
"image": {
"height": 61,
"width": 72
},
"status": "done",
"progress": 100,
"authorId": 503,
"authorName": "Иван Иванов",
"urlPreview": "https://mysite.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=5255&exact=N&_esd=s6P3x5qDBEKU0NiS7sczr69Y%2FHHR8Za8EXa7STOAXIVOylYhMsnMj5nGU0VXeQ1PIsqm%2F0GNxOju5wR1jNj76d%2FZnVgpyqeIcJ4UiWXm8CJsrmARXWpxWe%2BgJ%2BpGqx0M5CxgjNzIopQp2cwM&fileName=image.png",
"urlShow": "https://mysite.ru/bitrix/services/main/ajax.php?action=disk.api.file.showImage&SITE_ID=s1&humanRE=1&fileId=5255&width=1280&height=1280&signature=4b6b2bbba680d3bccd8b70e398d94c1c3cfcb018f813089c32db3bb25df594f5&exact=N&_esd=s6P3x5qDBEKU0NiS7sczr69Y%2FHHR8Za8EXa7STOAXIVOylYhMsnMj5nGU0VXeQ1PIsqm%2F0GNxOju5wR1jNj76d%2FZnVgpyqeIcJ4UiWXm8CJsrmARXWpxWe%2BgJ%2BpGqx0M5CxgjNzIopQp2cwM&fileName=image.png",
"urlDownload": "https://mysite.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=5255&exact=N&_esd=s6P3x5qDBEKU0NiS7sczr69Y%2FHHR8Za8EXa7STOAXIVOylYhMsnMj5nGU0VXeQ1PIsqm%2F0GNxOju5wR1jNj76d%2FZnVgpyqeIcJ4UiWXm8CJsrmARXWpxWe%2BgJ%2BpGqx0M5CxgjNzIopQp2cwM&fileName=image.png",
"viewerAttrs": {
"viewer": "",
"viewerType": "image",
"src": "https://mysite.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=5255&exact=N&_esd=s6P3x5qDBEKU0NiS7sczr69Y%2FHHR8Za8EXa7STOAXIVOylYhMsnMj5nGU0VXeQ1PIsqm%2F0GNxOju5wR1jNj76d%2FZnVgpyqeIcJ4UiWXm8CJsrmARXWpxWe%2BgJ%2BpGqx0M5CxgjNzIopQp2cwM&fileName=image.png",
"viewerResized": "",
"objectId": "5255",
"viewerGroupBy": "1489",
"imChatId": 1489,
"title": "image.png",
"actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Сохранить на Диск\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"5255\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]"
},
"mediaUrl": {
"preview": {
"250": "https://mysite.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=5255&exact=N&_esd=s6P3x5qDBEKU0NiS7sczr69Y%2FHHR8Za8EXa7STOAXIVOylYhMsnMj5nGU0VXeQ1PIsqm%2F0GNxOju5wR1jNj76d%2FZnVgpyqeIcJ4UiWXm8CJsrmARXWpxWe%2BgJ%2BpGqx0M5CxgjNzIopQp2cwM&fileName=image.png"
}
},
"isTranscribable": false,
"isVideoNote": false,
"isVoiceNote": false
}
]
},
"time": {
"start": 1772608704,
"finish": 1772608704.545697,
"duration": 0.5456969738006592,
"processing": 0,
"date_start": "2026-03-04T10:18:24+03:00",
"date_finish": "2026-03-04T10:18:24+03:00",
"operating_reset_at": 1772609304,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
chat_id |
Идентификатор чата |
|
messages |
Массив сообщений (подробное описание). Метод вернет пустой массив, если в |
|
users |
Пользователи из выборки (подробное описание). Метод вернет пустой массив, если в |
|
files |
Файлы из выборки (подробное описание). Метод вернет пустой массив, если в |
Объект message
|
Название |
Описание |
|
id |
Идентификатор сообщения |
|
chat_id |
Идентификатор чата |
|
author_id |
Идентификатор автора, |
|
date |
Дата сообщения в формате ISO 8601 |
|
text |
Текст сообщения |
|
unread |
Признак непрочитанного сообщения |
|
uuid |
Уникальный идентификатор сообщения, |
|
replaces |
Массив замен текста сообщения |
|
params |
Дополнительные параметры сообщения (подробное описание). Набор полей объекта зависит от типа сообщени: обычное или системное |
|
disappearing_date |
Дата исчезновения сообщения, |
Объект params
|
Название |
Описание |
|
LIKE |
Идентификаторы пользователей, которые поставили реакцию сообщению |
|
CODE |
Коды системных событий:
|
|
NOTIFY |
Признак отправки уведомления. Значение |
Объект user
|
Название |
Описание |
|
id |
Идентификатор пользователя |
|
active |
Признак активного пользователя |
|
name |
Имя и фамилия |
|
first_name |
Имя |
|
last_name |
Фамилия |
|
work_position |
Должность |
|
color |
Цвет аватара в формате hex |
|
avatar |
Ссылка на аватар |
|
avatar_hr |
Ссылка на аватар в высоком разрешении |
|
gender |
Пол.
|
|
birthday |
Дата рождения |
|
extranet |
Признак экстранет-пользователя |
|
network |
Признак пользователя сети Bitrix24 |
|
bot |
Признак бота |
|
connector |
Признак пользователя открытых линий |
|
external_auth_id |
Тип авторизации |
|
status |
Статус пользователя |
|
idle |
Признак неактивности пользователя |
|
last_activity_date |
Дата последней активности |
|
mobile_last_date |
Дата последней активности в мобильном приложении, |
|
desktop_last_date |
Дата последней активности в десктопном приложении, |
|
absent |
Признак отсутствия пользователя |
|
departments |
Идентификаторы отделов пользователя |
|
phones |
Телефоны пользователя, |
|
bot_data |
Данные бота, |
|
type |
Тип пользователя |
|
website |
Сайт пользователя |
|
email |
E-mail пользователя |
Объект file
|
Название |
Описание |
|
id |
Идентификатор файла |
|
chatId |
Идентификатор чата |
|
date |
Дата загрузки файла |
|
type |
Тип файла: |
|
name |
Имя файла |
|
extension |
Расширение файла |
|
size |
Размер в байтах |
|
image |
Размеры изображения для файлов типа |
|
status |
Статус файла: |
|
progress |
Процент загрузки файла |
|
authorId |
Идентификатор автора файла |
|
authorName |
Имя автора файла |
|
urlPreview |
Ссылка для предпросмотра файла |
|
urlShow |
Ссылка для отображения файла |
|
urlDownload |
Ссылка для скачивания файла |
|
viewerAttrs |
Атрибуты для просмотрщика файлов (подробное описание) |
|
mediaUrl |
URL медиафайла для предпросмотра (подробное описание) |
|
isTranscribable |
Признак возможности транскрибации |
|
isVideoNote |
Признак видеозаметки |
|
isVoiceNote |
Признак голосовой заметки |
Объект image
|
Название |
Описание |
|
height |
Высота изображения в пикселях |
|
width |
Ширина изображения в пикселях |
Объект viewerAttrs
|
Название |
Описание |
|
viewer |
Тип просмотрщика |
|
viewerType |
Тип отображения файла |
|
src |
Ссылка на файл |
|
viewerResized |
Ссылка на уменьшенную версию файла |
|
objectId |
Идентификатор объекта файла |
|
viewerGroupBy |
Идентификатор группы для просмотра файлов в чате |
|
imChatId |
Идентификатор чата |
|
title |
Имя файла |
|
actions |
Доступные действия с файлом в формате JSON |
Объект mediaUrl
|
Название |
Описание |
|
preview |
Ссылки для предпросмотра файла. Ключи объекта — размеры изображения в пикселях |
Обработка ошибок
HTTP-статус: 400
{
"error": "DIALOG_ID_EMPTY",
"error_description": "Dialog ID can't be empty"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Dialog ID can't be empty |
Параметр |
|
|
|
First ID can't be string |
Параметр |
|
|
|
Last ID can't be string |
Параметр |
|
|
|
You do not have access to the specified dialog |
У пользователя нет доступа к диалогу |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Найти сообщение в чате im.dialog.messages.search
- Установить признак «прочитано» у сообщений im.dialog.read
- Установить признак «не прочитано» у сообщений im.dialog.unread
- Отправить признак «Пользователь пишет» im.dialog.writing