#Подписаться на события

POST /v1/chats/events/subscribe

Включает накопление пользовательских событий мессенджера для текущего пользователя. Без активной подписки события не накапливаются и недоступны через GET /v1/chats/events.

Подписку необходимо вызывать перед началом опроса событий. Повторный вызов при действующей подписке не приводит к ошибке.

#Параметры

Эндпоинт не принимает параметров. Тело запроса — пустой объект {}.

#Примеры

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

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

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

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

const { success, data } = await res.json()
console.log('Подписка:', data) // true

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

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

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data boolean true — подписка активирована

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

JSON 
{
  "success": true,
  "data": true
}

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

403 — нет скоупа im:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'im' scope"
  }
}

#Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа im
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
422 BITRIX_ERROR Битрикс24 вернул ошибку (текст ошибки в message)
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

Тело запроса. Запрос может быть без тела или с пустым {}. Неизвестные поля игнорируются.

OAuth-ключ. Для ключа vibe_app_… добавьте заголовок Authorization: Bearer <session_token> — без него запрос вернёт 401 TOKEN_MISSING. Подробнее — Ключи и авторизация.

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