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

Промо-подсказки

GET /v1/chats/promotions

Активные для пользователя промо-подсказки мессенджера — подсказки о новых возможностях, которые интерфейс Битрикс24 показывает один раз. Список — для всех видов устройств сразу.

Параметры

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

Примеры

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

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

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

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

const { data: promotions } = await res.json()
console.log('Активных подсказок:', promotions.length)

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

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

const { data: promotions } = await res.json()
console.log(promotions.map((p) => p.id))

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data[] object[] Активные подсказки
data[].id string ID подсказки, например im:collab-helpdesk-sidebar:30102024:all. Последняя часть — вид устройства
data[].params.chatId number | null Чат, к которому относится подсказка. null — ко всему мессенджеру

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

JSON 
{
  "success": true,
  "data": [
    { "id": "im:collab-helpdesk-sidebar:30102024:all", "params": { "chatId": null } },
    { "id": "im:download-several-files:22112024:all", "params": { "chatId": null } }
  ]
}

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

400 — передан type:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Query parameter `type` is not accepted by GET /v1/chats/promotions: Bitrix24 reads it only from a form body, so the endpoint answers the promotions of every device type."
  }
}

Ошибки

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 — Ошибки.

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