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

Карточка: Ресурсы бронирования

GET /v1/booking-resources/:id

Возвращает ресурс бронирования по идентификатору: название, тип и настройки сообщений клиентам о записи.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор ресурса. Список: GET /v1/booking-resources

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/booking-resources/51" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/booking-resources/51" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/booking-resources/51', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log(data.name, data.typeId)

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

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

const { data } = await res.json()
console.log(data.name, data.typeId)

Поля ответа

Переключатели isMain и is*NotificationOn в карточке всегда true или false, даже если при записи передавались строки "Y" / "N". Задержки — в секундах.

Поле Тип Описание
success boolean true при успехе
data.id number Идентификатор ресурса. Его передают в resourceIds при создании бронирования
data.name string Название ресурса
data.description string | null Описание ресурса. null — не задано
data.typeId number Идентификатор типа ресурса. Карточка типа: GET /v1/booking-resource-types/:id
data.isMain boolean Основной ресурс
data.senderCode string | null Служба отправки сообщений клиенту, например bitrix24
data.isInfoNotificationOn boolean Сообщение клиенту о записи
data.isConfirmationNotificationOn boolean Запрос подтверждения записи
data.isReminderNotificationOn boolean Напоминание о записи
data.isFeedbackNotificationOn boolean Запрос отзыва
data.isDelayedNotificationOn boolean Сообщение клиенту, который опаздывает
data.isCancellationNotificationOn boolean Сообщение клиенту об отмене записи
data.infoNotificationDelay number | null Через сколько секунд после записи отправить сообщение о ней
data.confirmationNotificationDelay number | null За сколько секунд до записи отправить первый запрос подтверждения
data.confirmationNotificationRepetitions number | null Сколько раз повторить запрос подтверждения, не считая первого
data.confirmationNotificationRepetitionsInterval number | null Интервал между повторами запроса подтверждения
data.confirmationCounterDelay number | null За сколько секунд до записи неподтверждённая запись попадает в счётчик
data.reminderNotificationDelay number | null За сколько секунд до записи отправить напоминание. -1 — утром в день записи
data.delayedNotificationDelay number | null Через сколько секунд опоздания отправить сообщение клиенту
data.delayedCounterDelay number | null Через сколько секунд опоздания запись попадает в счётчик календаря
data.cancellationNotificationDelay number | null Задержка сообщения об отмене записи
data.templateTypeInfo string Шаблон сообщения о записи: inanimate, animate, inanimate_long
data.templateTypeConfirmation string Шаблон запроса подтверждения: inanimate, animate, inanimate_long
data.templateTypeReminder string Шаблон напоминания, base
data.templateTypeFeedback string Шаблон запроса отзыва: inanimate, animate
data.templateTypeDelayed string Шаблон сообщения опоздавшему: inanimate, animate

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

JSON 
{
  "success": true,
  "data": {
    "id": 51,
    "description": "Приём по записи",
    "typeId": 1,
    "isMain": true,
    "name": "Кабинет 3",
    "senderCode": "bitrix24",
    "isInfoNotificationOn": false,
    "isConfirmationNotificationOn": false,
    "isReminderNotificationOn": false,
    "isFeedbackNotificationOn": false,
    "isDelayedNotificationOn": false,
    "isCancellationNotificationOn": false,
    "infoNotificationDelay": null,
    "confirmationNotificationDelay": 86400,
    "confirmationNotificationRepetitions": null,
    "confirmationNotificationRepetitionsInterval": 10800,
    "confirmationCounterDelay": 10800,
    "reminderNotificationDelay": -1,
    "delayedNotificationDelay": 300,
    "delayedCounterDelay": 300,
    "cancellationNotificationDelay": 600,
    "templateTypeInfo": "inanimate",
    "templateTypeConfirmation": "inanimate",
    "templateTypeReminder": "base",
    "templateTypeFeedback": "inanimate",
    "templateTypeDelayed": "inanimate"
  }
}

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

404 — ресурса с таким id нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Booking record not found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Ресурса с таким id нет
400 INVALID_PARAMS id — не целое положительное число. Сообщение id must be a positive safe integer
401 MISSING_API_KEY Не передан X-Api-Key
401 TOKEN_MISSING У ключа нет токенов Битрикс24
403 SCOPE_DENIED У ключа нет скоупа booking
429 RATE_LIMITED Превышена частота запросов. Действующий потолок — в заголовке x-ratelimit-limit
502 BITRIX_RESPONSE_INVALID Битрикс24 вернул карточку неожиданной формы

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

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

isMain в карточке и в списке приходит в разной форме. Карточка отдаёт true / false, а список ресурсов — строки "Y" / "N". Сравнивайте значение с учётом источника.

Рабочие часы — отдельным запросом. Карточка не содержит расписания ресурса. Его отдаёт GET /v1/booking-resources/:id/slots.

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