#Получить чат

GET /v1/bots/:botId/chats/:dialogId

Возвращает информацию о чате. Бот должен быть участником чата.

#Параметры

Параметр Тип Обяз. Описание
botId (path) number да ID бота
dialogId (path) string да ID диалога: chatXXX для групповых, числовой ID пользователя для личных

#Примеры

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

Terminal
curl https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456 \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Чат:', data.name)

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

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

const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
id number ID чата
dialogId string ID диалога (chatXXX)
type string Тип чата
name string Название чата
description string Описание
owner number ID владельца
avatar string URL аватара
color string Цвет чата
entityType string Тип связанной сущности
entityId string ID связанной сущности
dateCreate string Дата создания (ISO 8601)

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

JSON
{
  "success": true,
  "data": {
    "id": 456,
    "dialogId": "chat456",
    "type": "chat",
    "name": "Чат поддержки",
    "description": "Канал технической поддержки",
    "owner": 42,
    "avatar": "",
    "color": "AZURE",
    "entityType": "",
    "entityId": "",
    "dateCreate": "2026-03-31T10:30:00+03:00"
  }
}

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

502 — бот не является участником чата:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Access denied"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
502 BITRIX_ERROR Ошибка Bitrix24 (бот не участник чата)
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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