Для AI-агентов: markdown этой страницы — /docs-content/openlines/dialog.md индекс документации — /llms.txt
Метаданные диалога
POST /v1/openlines/dialogs/lookup
Возвращает метаданные одного диалога Открытой линии по его идентификатору: название, тип, линию, число сообщений и даты. Переписку метод не отдаёт — только карточку диалога. Требует скоуп imopenlines и применяет модель прав Битрикс24.
Метод удобен как связующее звено аналитики: по sessionId (например из поля id в ответе POST /v1/openlines/sessions/search) он находит диалог и его линию, а поле lineId даёт вход в GET /v1/openline-configs/:id.
Поля запроса (body)
Ровно один идентификатор:
| Поле | Тип | Описание |
|---|---|---|
chatId |
number | string | Идентификатор чата. Принимается число (2043) и форма chat2043 |
dialogId |
string | Тот же чат в форме chat2043 — альтернатива chatId |
sessionId |
number | Идентификатор сессии Открытой линии |
Передавайте одно из трёх полей. Если переданы и идентификатор чата, и sessionId, вызов вернёт 400 INVALID_PARAMS.
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
id |
number | Идентификатор чата диалога |
dialogId |
string | Идентификатор диалога в форме chat<N> |
name |
string | Название диалога |
description |
string | null | Описание |
type |
string | Тип чата (lines для Открытых линий) |
entityType |
string | Тип сущности (LINES) |
messageCount |
number | Число сообщений в диалоге |
lastMessageId |
number | Идентификатор последнего сообщения |
dateCreate |
string | Дата создания, ISO 8601 |
textFieldEnabled |
boolean | Доступно ли поле ввода |
isNew |
boolean | Признак нового диалога |
lineId |
number | null | Идентификатор линии (конфигурации). null, если определить не удалось |
Примеры
curl — по идентификатору чата
curl -X POST "https://vibecode.bitrix24.tech/v1/openlines/dialogs/lookup" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "chatId": 2043 }'
curl — по идентификатору сессии
curl -X POST "https://vibecode.bitrix24.tech/v1/openlines/dialogs/lookup" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "sessionId": 607 }'
Ответ
{
"success": true,
"data": {
"id": 2043,
"dialogId": "chat2043",
"name": "Telegram: Иван",
"description": null,
"type": "lines",
"entityType": "LINES",
"messageCount": 36,
"lastMessageId": 2109,
"dateCreate": "2026-08-14T10:12:30+03:00",
"textFieldEnabled": true,
"isNew": false,
"lineId": 1
}
}
Ошибки
| Код | HTTP | Причина |
|---|---|---|
SCOPE_DENIED |
403 | У ключа нет скоупа imopenlines |
MISSING_PARAMS |
400 | Не передан ни один идентификатор |
INVALID_PARAMS |
400 | Значение идентификатора некорректно, либо переданы сразу чат и сессия |
ENTITY_NOT_FOUND |
404 | Диалог не найден |
BITRIX_ACCESS_DENIED |
403 | У пользователя ключа нет доступа к этому диалогу |