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

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

GET /v1/chats/:dialogId

Возвращает данные о диалоге: название, тип, счётчик непрочитанных, настройки доступа и связанную CRM-сущность (если есть). Принимает числовой dialogId для личного чата или chatN для группового.

#Параметры

Параметр	Тип	Обяз.	Описание
`dialogId` (path)	string	да	Идентификатор диалога. Числовой ID для личного чата (`1`), `chatN` для группового чата (`chat42`), или литерал `me` — текущий пользователь (см. Обзор раздела)

#Примеры

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

Terminal

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

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

Terminal

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

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

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-приложение

javascript

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()

#Поля ответа

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

Поле	Тип	Описание
`success`	boolean	Всегда `true` при успехе
`data`	object	Объект диалога
`data.id`	number	Идентификатор диалога
`data.name`	string	Название чата
`data.description`	string	Описание чата
`data.type`	string	Тип диалога: `private` — личный, `chat` — групповой, `open` — открытый канал
`data.owner`	number	ID владельца. Источник: `GET /v1/users`
`data.color`	string	Цвет чата в формате `#rrggbb`
`data.avatar`	string	URL аватара чата
`data.counter`	number	Количество непрочитанных сообщений для текущего пользователя
`data.userCounter`	number	Количество участников
`data.messageCount`	number	Общее количество сообщений в чате
`data.lastId`	number	ID последнего сообщения. Используется как курсор в `GET /v1/chats/:dialogId/messages`
`data.dialogId`	string	Идентификатор диалога в формате, принятом Битрикс24
`data.dateCreate`	string	Дата создания (ISO 8601)
`data.role`	string	Роль текущего пользователя: `owner`, `manager`, `member`
`data.entityType`	string	Тип привязанной CRM-сущности (`CRM`, `FAVORITE`, и др.) или пустая строка
`data.entityId`	string	Идентификатор привязанной CRM-сущности или пустая строка
`data.restrictions`	object	Ограничения действий в чате (см. ниже)
`data.permissions`	object	Права управления чатом (см. ниже)
`data.restrictions.avatar`	boolean	Текущий пользователь может сменить аватар
`data.restrictions.rename`	boolean	Текущий пользователь может переименовать чат
`data.restrictions.extend`	boolean	Текущий пользователь может приглашать участников
`data.restrictions.call`	boolean	Текущий пользователь может инициировать звонок
`data.restrictions.leave`	boolean	Текущий пользователь может покинуть чат
`data.restrictions.send`	boolean	Текущий пользователь может отправлять сообщения
`data.permissions.manageUsersAdd`	string	Кто может добавлять участников: `owner`, `manager`, `member`
`data.permissions.manageUsersDelete`	string	Кто может удалять участников
`data.permissions.manageSettings`	string	Кто может изменять настройки чата
`data.permissions.canPost`	string	Кто может отправлять сообщения

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

JSON

{
  "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": "",
    "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 — диалог недоступен или не существует: