Для AI-агентов: markdown этой страницы — /docs-content/chats/service/tariff-restrictions.md индекс документации — /llms.txt

Ограничения тарифа

GET /v1/chats/tariff-restrictions

Ограничения мессенджера на тарифе Битрикс24: доступна ли вся история чатов, доступны ли коллабы и другие возможности. По ответу клиент решает, что показывать пользователю.

Параметры

Параметров нет. Любой параметр запроса отклоняется с 400 INVALID_PARAMS.

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/chats/tariff-restrictions" \
  -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/tariff-restrictions', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
const history = data.fullChatHistory
console.log(history.isAvailable ? 'Вся история доступна' : `История за ${history.limitDays} дн.`)

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

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

const { data } = await res.json()
console.log('Коллабы доступны:', data.collab?.isAvailable)

Поля ответа

data — объект ограничений. Ключ — код ограничения, значение — его данные. Набор кодов задаёт Битрикс24 и его модули.

Поле Тип Описание
success boolean Всегда true при успехе
data.fullChatHistory.isAvailable boolean true — доступна вся история чатов
data.fullChatHistory.limitDays number | null За сколько дней доступна история, если не вся. null — без ограничения
data.collab.isAvailable boolean true — коллабы доступны на тарифе или их можно включить пробным периодом
data.collab.isCopyAvailable boolean true — на тарифе доступно копирование проектов и групп

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

JSON 
{
  "success": true,
  "data": {
    "fullChatHistory": { "isAvailable": true, "limitDays": null },
    "collab": { "isAvailable": true, "isCopyAvailable": true }
  }
}

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

400 — передан параметр запроса:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Query parameter `code` is not accepted by GET /v1/chats/tariff-restrictions. It takes no query parameters."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передан параметр запроса — операция их не принимает
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа im
422 BITRIX_ERROR Битрикс24 вернул ошибку. Код портала — в error.b24Code
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

  • Коды ограничений (fullChatHistory, collab) приходят как есть, поля внутри приводятся к camelCase.
  • Модули Битрикс24 могут добавлять свои ограничения — не рассчитывайте на фиксированный набор кодов.

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