Информация о диалоге

GET /v1/chats/:dialogId

Возвращает данные о диалоге — личном или групповом чате.

Параметры

Режим v2. format=v2 читает чат. В data приходит объект { chat, recentConfig, parentChat, copilot, messagesAutoDeleteConfigs, callInfo }, ключи в camelCase: chat — карточка чата с permissions, но без прежних counter, restrictions и readedList, остальное — контекст чата. Режим принимает только format. Другой параметр или повтор отклоняется с 400 INVALID_PARAMS. Режим v2 может сделать вас участником: если чат разрешает автовступление — например, чат комментариев, коллаб или чат задачи, — вызов добавляет текущего пользователя в участники, как загрузка чата. В режиме v2 эта точечная операция чтения доступна ключу READONLY, только если это личный ключ сотрудника со скоупом im. Она сама не отмечает сообщения прочитанными.

Ключ только чтения. В режиме READONLY этот запрос читает существующий чат: передайте его chatN либо числовой ID собеседника, подтверждённый в последних диалогах того же сотрудника. Для me проверяется уже существующий личный диалог. Проверка просматривает не больше 4000 исходных строк последних диалогов. Если привязка не подтверждена, ответ — 403 WRITE_BLOCKED_READONLY_KEY, без обращения к методу, который мог бы создать чат. Границы проверки и разрешённых эффектов чтения — в правах доступа.

Примеры

curl — личный ключ

curl https://vibecode.bitrix24.tech/v1/chats/1 \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

curl https://vibecode.bitrix24.tech/v1/chats/1 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/1', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Диалог:', data.name, 'тип:', data.type)

JavaScript — OAuth-приложение

const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/1', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

curl — режим v2

curl "https://vibecode.bitrix24.tech/v1/chats/chat42?format=v2" \
  -H "X-Api-Key: YOUR_API_KEY"

Поля ответа

Показаны основные поля. Ответ содержит полный объект диалога.

Пример ответа

Диалог «Избранное», запрошенный с dialogId = me:

{
  "success": true,
  "data": {
    "id": 253,
    "name": "Избранное",
    "description": "",
    "owner": 1,
    "type": "private",
    "color": "#4ba984",
    "avatar": "",
    "counter": 0,
    "userCounter": 1,
    "messageCount": 1,
    "lastId": 9357,
    "dialogId": "1",
    "dateCreate": "2024-03-15T10:30:00+03:00",
    "role": "owner",
    "entityType": "FAVORITE",
    "entityId": "",
    "restrictions": {
      "avatar": true,
      "rename": true,
      "extend": true,
      "call": true,
      "mute": true,
      "leave": true,
      "leaveOwner": true,
      "send": true,
      "userList": true
    },
    "permissions": {
      "manageUsersAdd": "member",
      "manageUsersDelete": "manager",
      "manageUi": "member",
      "manageSettings": "owner",
      "manageMessages": "member",
      "canPost": "member"
    }
  }
}

Пример ответа при ошибке

422 — диалог недоступен или не существует:

{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "You do not have access to the specified dialog"
  }
}

Ошибки

Полный список общих ошибок API — Ошибки.

Известные особенности

• Числовой dialogId, равный ID текущего пользователя, открывает диалог «Избранное».

Смотрите также

• Поиск чатов
• Найти чат CRM-сущности
• Последние диалоги
• Чтение сообщений