Получить историю сообщений диалога imopenlines.session.history.get

Scope: imopenlines

Кто может выполнять метод: любой пользователь

Метод imopenlines.session.history.get возвращает историю сообщений сессии открытой линии.

Параметры метода

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

Название
Тип

Описание

SESSION_ID
integer

Идентификатор сессии открытой линии.

Идентификатор можно получить методом imopenlines.dialog.get из поля entity_data_1. Идентификатор SESSION_ID находится в шестом параметре строки entity_data_1. Например, для "entity_data_1":"Y|LEAD|1205|N|N|321|1773223732|0|0|0" идентификатор сессии — 321

CHAT_ID
integer

Числовой идентификатор чата открытой линии без префикса chat. Например, 1763, не chat1763.

Идентификатор можно получить методами imopenlines.dialog.get или imopenlines.crm.chat.get

Метод принимает один из параметров: SESSION_ID или CHAT_ID.

Если передан SESSION_ID, метод работает по нему.
Если SESSION_ID не передан, метод пытается определить последнюю сессию по CHAT_ID с сортировкой ID DESC.

На практике для стабильного результата рекомендуется передавать SESSION_ID.

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"SESSION_ID":321}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.session.history.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"SESSION_ID":321,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imopenlines.session.history.get

try {
            const response = await $b24.callMethod(
                'imopenlines.session.history.get',
                {
                    SESSION_ID: 321,
                }
            );
        
            const { result } = response.getData();
            console.log(result);
        } catch (error) {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.session.history.get',
                    [
                        'SESSION_ID' => 321,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error getting session history: ' . $exception->getMessage();
        }

BX24.callMethod(
            'imopenlines.session.history.get',
            {
                SESSION_ID: 321,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.session.history.get',
            [
                'SESSION_ID' => 321,
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Success: ' . print_r($result['result'], true);
        }

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "chatId": 1763,
                "canJoin": "Y",
                "canVoteHead": "Y",
                "sessionId": 321,
                "sessionVoteHead": 0,
                "sessionCommentHead": null,
                "userId": "chat1763",
                "message": {
                    "85851": {
                        "id": "85851",
                        "chatid": "1763",
                        "senderid": "103",
                        "recipientid": "chat1763",
                        "date": "2026-03-11T13:12:46+03:00",
                        "text": "Откройте карточку задачи и нажмите Наблюдатели",
                        "textlegacy": "Откройте карточку задачи и нажмите Наблюдатели",
                        "params": {
                            "connectorMid": ["85853"],
                            "fileId": [5437]
                        }
                    },
                    "85833": {
                        "id": "85833",
                        "chatid": "1763",
                        "senderid": "0",
                        "recipientid": "chat1763",
                        "date": "2026-03-11T13:09:25+03:00",
                        "text": "[b]Создан новый лид[/b]",
                        "textlegacy": "<b>Создан новый лид</b>",
                        "params": {
                            "attach": [
                                {
                                    "id": 1773223765,
                                    "blocks": [
                                        {
                                            "link": [
                                                {
                                                    "name": "Заполнение CRM-формы \"Форма контактных данных для открытых линий\"",
                                                    "link": "/crm/lead/details/1205/"
                                                }
                                            ]
                                        },
                                        {
                                            "grid": [
                                                {
                                                    "display": "ROW",
                                                    "name": "Имя",
                                                    "value": "Иван",
                                                    "colorToken": "base"
                                                },
                                                {
                                                    "display": "LINE",
                                                    "name": "Телефон",
                                                    "value": "+71110000000",
                                                    "height": 20,
                                                    "colorToken": "base"
                                                }
                                            ]
                                        }
                                    ],
                                    "description": "",
                                    "color": "#df532d"
                                }
                            ]
                        }
                    },
                    ... // описание для каждого сообщения
                },
                "usersMessage": {
                    "chat1763": [
                        "85851",
                        "85833",
                    ]
                },
                "users": {
                    "103": {
                        "id": "103",
                        "name": "Светлана Иванова",
                        "active": true,
                        "firstName": "Светлана",
                        "lastName": "Иванова",
                        "workPosition": "Руководитель ИТ-отдела",
                        "color": "#4ba984",
                        "avatar": "https://example.bitrix24.ru/upload/main/avatar.png",
                        "avatarId": "8644",
                        "birthday": "08-03",
                        "gender": "F",
                        "phoneDevice": false,
                        "phones": false,
                        "extranet": false,
                        "network": false,
                        "bot": false,
                        "connector": false,
                        "profile": "/company/personal/user/103/",
                        "externalAuthId": "socservices",
                        "status": "online",
                        "idle": false,
                        "lastActivityDate": "2026-03-11T13:14:35+03:00",
                        "mobileLastDate": false,
                        "desktopLastDate": false,
                        "departments": [1, 7],
                        "absent": false,
                        "type": "user",
                        "services": null,
                        "botData": null
                    },
                    ... // описание для каждого пользователя
                },
                "openlines": {
                    "canvoteashead": {
                        "22": true
                    }
                },
                "userInGroup": {
                    "1": {
                        "id": 1,
                        "users": ["103"]
                    },
                    ... // описание для каждого подразделения
                },
                "woUserInGroup": [],
                "chat": {
                    "1763": {
                        "id": "1763",
                        "parentChatId": 0,
                        "parentMessageId": 0,
                        "name": "Иван - Документация Битрикс24",
                        "owner": "103",
                        "color": "#ba9c7b",
                        "extranet": false,
                        "avatar": "/bitrix/js/im/images/blank.gif",
                        "call": "0",
                        "callNumber": "",
                        "entityType": "LINES",
                        "entityId": "livechat|22|1761|587",
                        "entityData1": "Y|LEAD|1205|N|N|321|1773223732|0|0|0",
                        "entityData2": "LEAD|1205|COMPANY|0|CONTACT|0|DEAL|0",
                        "entityData3": "",
                        "messageCount": 14,
                        "public": "",
                        "muteList": {
                            "103": false,
                            "587": false
                        },
                        "managerList": [103],
                        "dateCreate": "2026-03-11T12:08:52+03:00",
                        "type": "lines",
                        "entityLink": {
                            "type": "LINES",
                            "url": "",
                            "id": "livechat|22|1761|587"
                        },
                        "permissions": {
                            "manageUsersAdd": "member",
                            "manageUsersDelete": "manager",
                            "manageUi": "member",
                            "manageSettings": "owner",
                            "manageMessages": "member",
                            "canPost": "member"
                        },
                        "textFieldEnabled": true,
                        "backgroundId": null,
                        "messageType": "L",
                        "isNew": false
                    }
                },
                "userBlockChat": {
                    "1763": {
                        "103": false,
                        "587": false
                    }
                },
                "userInChat": {
                    "1763": [103, 587]
                },
                "files": {
                    "5437": {
                        "id": 5437,
                        "chatid": 1763,
                        "date": "2026-03-11T13:12:46+03:00",
                        "type": "image",
                        "name": "2311.png",
                        "extension": "png",
                        "size": 70855,
                        "image": {
                            "height": 615,
                            "width": 646
                        },
                        "status": "done",
                        "progress": 100,
                        "authorid": 103,
                        "authorname": "Светлана Иванова",
                        "urlpreview": "https://some-domain.bitrix24.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=5437&exact=N&_esd=oYQLNdHU%3D&fileName=2311.png",
                        "urlshow": "https://some-domain.bitrix24.ru/bitrix/services/main/ajax.php?action=disk.api.file.showImage&SITE_ID=s1&humanRE=1&fileId=5437&width=1280&height=1280&signature=d1007a9ed47599e2160b993ca&exact=N&_esd=oYQLNdHU%3D&fileName=2311.png",
                        "urldownload": "https://some-domain.bitrix24.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=5437&exact=N&_esd=oYQLNdHU%3D&fileName=2311.png",
                        "viewerattrs": {
                            "viewer": "",
                            "viewertype": "image",
                            "src": "https://some-domain.bitrix24.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=5437&exact=N&_esd=oYQLNdHU%3D&fileName=2311.png",
                            "viewerresized": "",
                            "objectid": "5437",
                            "viewergroupby": "1763",
                            "imchatid": 1763,
                            "title": "2311.png",
                            "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Сохранить на Диск\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"5437\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]"
                        },
                        "mediaurl": {
                            "preview": {
                                "250": "https://some-domain.bitrix24.ru/bitrix/services/main/ajax.php?action=disk.api.file.showImage&SITE_ID=s1&humanRE=1&fileId=5437&width=250&height=250&signature=c28f11fbae0ee5a0c40970c4e8e554&exact=Y&_esd=oYQLNdHU%3D&fileName=2311.png"
                            }
                        },
                        "istranscribable": false,
                        "isvideonote": false,
                        "isvoicenote": false
                    }
                }
            },
            "time": {
                "start": 1773224138,
                "finish": 1773224138.143344,
                "duration": 0.14334392547607422,
                "processing": 0,
                "date_start": "2026-03-11T13:15:38+03:00",
                "date_finish": "2026-03-11T13:15:38+03:00",
                "operating_reset_at": 1773224738,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
object

Корневой объект ответа.

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

time
time

Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
chatId `integer`	Идентификатор чата
canJoin `string`	Флаг возможности подключения к диалогу: `Y` или `N`
canVoteHead `string`	Флаг возможности оценки операторов руководителем: `Y` или `N`
sessionId `integer`	Идентификатор сессии
sessionVoteHead `integer`	Оценка, которая выставлена руководителем
sessionCommentHead `string`	Комментарий руководителя к оценке или `null`
userId `string`	Идентификатор чата в формате `chat<ID>`
message `object`	Сообщения чата, индексированные по идентификатору сообщения. Структура объекта подробно описана ниже
usersMessage `object`	Связь чата и списка идентификаторов сообщений. Структура объекта подробно описана ниже
users `object`	Объект участников чата, где ключ — идентификатор пользователя. Структура объекта подробно описана ниже
openlines `object`	Данные открытой линии. Структура объекта подробно описана ниже
userInGroup `object`	Пользователи, которые группированы по подразделениям, или пустой массив Структура объекта подробно описана ниже
woUserInGroup `array`	Пользователи, которые не входят в подразделения из `userInGroup`
chat `object`	Данные чата по его идентификатору. Структура объекта подробно описана ниже
userBlockChat `object`	Флаги блокировки чата пользователями. Структура объекта подробно описана ниже
userInChat `object`	Состав участников чата или пустой массив. Структура объекта участников чата подробно описана ниже
files `object`	Файлы, которые связаны с сообщениями, или пустой массив. Структура объекта файлов подробно описана ниже

Объект message

Название
тип

Описание

object

Объект сообщения.

Структура объекта сообщения подробно описана ниже

Объект messageItem

Название `тип`	Описание
id `string`	Идентификатор сообщения
chatid `string`	Идентификатор чата
senderid `string`	Идентификатор отправителя
recipientid `string`	Получатель сообщения в формате `chat<ID>`
date `datetime`	Дата и время сообщения в формате ISO 8601 (RFC3339)
text `string`	Текст сообщения
textlegacy `string`	Текст сообщения в legacy-формате
params `object`	Служебные параметры сообщения

Объект usersMessage

Название `тип`	Описание
chat<chatId> `array`	Массив идентификаторов сообщений, которые относятся к чату

Объект users

Название
тип

Описание

<userId>
object

Данные пользователя.

Структура объекта пользователя подробно описана ниже

Объект userItem

Название `тип`	Описание
id `string`	Идентификатор пользователя
name `string`	Имя и фамилия пользователя
firstName `string`	Имя пользователя
lastName `string`	Фамилия пользователя
workPosition `string`	Должность или `null`
avatar `string`	Ссылка на аватар пользователя
avatarId `integer`	Идентификатор файла аватара или `null`
gender `string`	Пол пользователя
extranet `boolean`	Признак экстранет-пользователя
connector `boolean`	Признак пользователя коннектора
profile `string`	Ссылка на профиль
externalAuthId `string`	Внешний тип авторизации
status `string`	Онлайн-статус или `null`
lastActivityDate `datetime`	Дата и время последней активности в формате ISO 8601 (RFC3339)
departments `array`	Идентификаторы подразделений
type `string`	Тип пользователя

Объект openlines

Название `тип`	Описание
canvoteashead `object`	Объект вида `{"<CONFIG_ID>": <boolean>}`, где ключ — идентификатор настроек открытой линии `CONFIG_ID`, а значение `true/false` показывает, может ли руководитель оценивать работу оператора в сессии этой линии

Объект userInGroup

Название
тип

Описание

<departmentId>
object

Данные подразделения.

Структура объекта подразделения подробно описана ниже

Объект groupItem

Название `тип`	Описание
id `integer`	Идентификатор подразделения
users `array`	Список идентификаторов пользователей, которые входят в подразделение

Объект chat

Название
тип

Описание

<chatId>
object

Данные чата.

Структура объекта подразделения подробно описана ниже

Объект chatItem

Название `тип`	Описание
id `string`	Идентификатор чата
name `string`	Название чата
owner `string`	Идентификатор владельца чата
entityType `string`	Тип объекта чата
entityId `string`	Внешний идентификатор чата
entityData1 `string`	Строка с метаданными чата
entityData2 `string`	Дополнительные метаданные чата
entityData3 `string`	Дополнительные метаданные чата
messageCount `integer`	Количество сообщений в чате
public `string`	Публичный признак чата
muteList `object`	Объект, где ключ — идентификатор пользователя, а значение `true/false`, выключены ли уведомления для этого пользователя в чате
managerList `array`	Список идентификаторов операторов-менеджеров
dateCreate `datetime`	Дата и время создания чата в формате ISO 8601 (RFC3339)
type `string`	Тип чата
entityLink `object`	Данные связи чата с открытой линией
permissions `object`	Права доступа в чате
textFieldEnabled `boolean`	Признак доступности поля ввода сообщений
backgroundId `integer`	Идентификатор фона чата или `null`
messageType `string`	Тип сообщений чата
isNew `boolean`	Признак нового чата

Объект userBlockChat

Название `тип`	Описание
<chatId> `object`	Объект с флагами блокировки пользователей в чате: ключ — идентификатор пользователя, значение — `true` или `false`

Объект userInChat

Название `тип`	Описание
<chatId> `array`	Массив идентификаторов пользователей, которые входят в чат

Объект files

Название
тип

Описание

<fileId>
object

Данные файла.

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

Объект fileItem

Название `тип`	Описание
id `integer`	Идентификатор файла
chatid `integer`	Идентификатор чата
date `datetime`	Дата и время загрузки в формате ISO 8601 (RFC3339)
type `string`	Тип файла
name `string`	Имя файла
extension `string`	Расширение файла
size `integer`	Размер файла в байтах
image `object`	Параметры изображения (`width`, `height`)
status `string`	Статус обработки файла
progress `integer`	Прогресс обработки в процентах
authorid `integer`	Идентификатор автора файла
authorname `string`	Имя автора файла
urlpreview `string`	URL предпросмотра файла
urlshow `string`	URL просмотра файла
urldownload `string`	URL скачивания файла
viewerattrs `object`	Параметры просмотра файла в интерфейсе
mediaurl `string`	URL медиафайла
istranscribable `boolean`	Признак доступности расшифровки файла
isvideonote `boolean`	Признак видео-заметки
isvoicenote `boolean`	Признак голосовой заметки

Обработка ошибок

HTTP-статус: 400

{
            "error": "MISSING_REQUIRED_PARAM",
            "error_description": "Session ID or Chat ID must be provided"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`MISSING_REQUIRED_PARAM`	Session ID or Chat ID must be provided	Не переданы `SESSION_ID` и `CHAT_ID`
`INVALID_SESSION_ID`	Unable to determine session ID from provided parameters	По переданным параметрам не удалось определить сессию
`ACCESS_DENIED`	Вы не можете открыть этот разговор, т.к. у вас недостаточно прав	Недостаточно прав для просмотра истории, сессия не найдена или недоступна

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Присоединиться к диалогу

Забрать диалог у текущего оператора

Получить историю сообщений диалога imopenlines.session.history.get

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект resultОбъект result

Объект messageОбъект message

Объект messageItemОбъект messageItem

Объект usersMessageОбъект usersMessage

Объект usersОбъект users

Объект userItemОбъект userItem

Объект openlinesОбъект openlines

Объект userInGroupОбъект userInGroup

Объект groupItemОбъект groupItem

Объект chatОбъект chat

Объект chatItemОбъект chatItem

Объект userBlockChatОбъект userBlockChat

Объект userInChatОбъект userInChat

Объект filesОбъект files

Объект fileItemОбъект fileItem

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

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

Параметры метода

Примеры кода

Обработка ответа

Возвращаемые данные

Объект result

Объект message

Объект messageItem

Объект usersMessage

Объект users

Объект userItem

Объект openlines

Объект userInGroup

Объект groupItem

Объект chat

Объект chatItem

Объект userBlockChat

Объект userInChat

Объект files

Объект fileItem

Обработка ошибок

Возможные коды ошибок

Статусы и коды системных ошибок

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