Получить бронирования ресурсов по фильтру calendar.resource.booking.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
calendarКто может выполнять метод: любой пользователь, кроме экстранет-пользователей
Метод calendar.resource.booking.list получает бронирования ресурсов. Как устроено бронирование ресурсов, описано в обзоре методов.
Бронирования можно выбрать двумя способами:
- по ресурсам за период — параметр
filter.resourceTypeIdListс идентификаторами ресурсов, а также необязательные параметрыfilter.fromиfilter.to - по идентификаторам бронирований из пользовательского поля CRM типа
resourcebooking— параметрfilter.resourceIdList
Постраничной навигации у метода нет: он возвращает все найденные бронирования одним ответом.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter* |
Условия выборки бронирований (подробное описание) |
Параметр filter
В filter обязательно передайте resourceTypeIdList или resourceIdList. Если передан непустой resourceIdList, метод использует только его, а resourceTypeIdList, from и to игнорирует.
Если не переданы ни from, ни to, метод берет период с даты за 30 дней до текущей по дату через 90 дней после нее. Если значение from или to не удается распознать как дату, метод считает параметр непереданным и не возвращает ошибку.
|
Название |
Описание |
|
resourceTypeIdList |
Список идентификаторов ресурсов. Несмотря на название, это идентификаторы самих ресурсов, а не их типов. Значение должно быть массивом. Получить идентификаторы можно методом calendar.resource.list |
|
from |
Дата начала периода, например |
|
to |
Дата окончания периода, например |
|
resourceIdList |
Список идентификаторов бронирований из пользовательского поля типа Получить идентификаторы можно:
Узнать, какие пользовательские поля имеют тип |
Примеры кода
Пример 1. Получить бронирования ресурсов за период, например чтобы показать занятость в своем приложении.
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"resourceTypeIdList":[10852,10888,10873,10871,10853],"from":"2024-06-20","to":"2024-08-20"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.resource.booking.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"resourceTypeIdList":[10852,10888,10873,10871,10853],"from":"2024-06-20","to":"2024-08-20"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.resource.booking.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each booking returned in result[]
type ResourceBooking = {
ID: string
PARENT_ID: string
DELETED: string
CAL_TYPE: string
OWNER_ID: string
NAME: string
DATE_FROM: string
DATE_TO: string
TZ_FROM: string
TZ_TO: string
TZ_OFFSET_FROM: string
TZ_OFFSET_TO: string
DATE_FROM_TS_UTC: string
DATE_TO_TS_UTC: string
DT_SKIP_TIME: string
DT_LENGTH: number
EVENT_TYPE: string
CREATED_BY: string
DATE_CREATE: string
TIMESTAMP_X: string
DESCRIPTION: string
IS_MEETING: boolean
MEETING_STATUS: string
MEETING_HOST: string
VERSION: string
SECTION_ID: string
DATE_FROM_FORMATTED: string
DATE_TO_FORMATTED: string
SECT_ID: string
RESOURCE_BOOKING_ID: string | null
}
try {
// calendar.resource.booking.list has no pagination: it returns all matching records in one response
const response = await $b24.actions.v2.call.make<ResourceBooking[]>({
method: 'calendar.resource.booking.list',
params: {
filter: {
resourceTypeIdList: [10852, 10888, 10873, 10871, 10853],
from: '2024-06-20',
to: '2024-08-20',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Bookings:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function fetchResourceBookings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// calendar.resource.booking.list has no pagination: it returns all matching records in one response
const response = await $b24.actions.v2.call.make({
method: 'calendar.resource.booking.list',
params: {
filter: {
resourceTypeIdList: [10852, 10888, 10873, 10871, 10853],
from: '2024-06-20',
to: '2024-08-20',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Bookings:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchResourceBookings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.calendar.resource.booking.list(
filter={
"resourceTypeIdList": [
10852,
10888,
10873,
10871,
10853,
],
"from": "2024-06-20",
"to": "2024-08-20",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'calendar.resource.booking.list',
[
'filter' => [
'resourceTypeIdList' => [10852, 10888, 10873, 10871, 10853],
'from' => '2024-06-20',
'to' => '2024-08-20',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching resource booking list: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.resource.booking.list',
{
filter: {
resourceTypeIdList: [10852, 10888, 10873, 10871, 10853],
from: '2024-06-20',
to: '2024-08-20',
}
}
);
require_once('crest.php');
$result = CRest::call(
'calendar.resource.booking.list',
[
'filter' => [
'resourceTypeIdList' => [10852, 10888, 10873, 10871, 10853],
'from' => '2024-06-20',
'to' => '2024-08-20'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "calendar.resource.booking.list", b24.Params{
"filter": b24.Params{
"resourceTypeIdList": []int{10852, 10888, 10873, 10871, 10853},
"from": "2024-06-20",
"to": "2024-08-20",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("calendar.resource.booking.list: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Пример 2. Получить бронирования по идентификаторам из пользовательских полей CRM.
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"resourceIdList":[10,18,17]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.resource.booking.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"resourceIdList":[10,18,17]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.resource.booking.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each booking returned in result[]
type ResourceBooking = {
ID: string
PARENT_ID: string
DELETED: string
CAL_TYPE: string
OWNER_ID: string
NAME: string
DATE_FROM: string
DATE_TO: string
TZ_FROM: string
TZ_TO: string
TZ_OFFSET_FROM: string
TZ_OFFSET_TO: string
DATE_FROM_TS_UTC: string
DATE_TO_TS_UTC: string
DT_SKIP_TIME: string
DT_LENGTH: number
EVENT_TYPE: string
CREATED_BY: string
DATE_CREATE: string
TIMESTAMP_X: string
DESCRIPTION: string
IS_MEETING: boolean
MEETING_STATUS: string
MEETING_HOST: string
VERSION: string
SECTION_ID: string
DATE_FROM_FORMATTED: string
DATE_TO_FORMATTED: string
SECT_ID: string
RESOURCE_BOOKING_ID: number
}
try {
// calendar.resource.booking.list has no pagination: it returns all matching records in one response
const response = await $b24.actions.v2.call.make<ResourceBooking[]>({
method: 'calendar.resource.booking.list',
params: {
filter: {
resourceIdList: [10, 18, 17],
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Bookings:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function fetchResourceBookings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// calendar.resource.booking.list has no pagination: it returns all matching records in one response
const response = await $b24.actions.v2.call.make({
method: 'calendar.resource.booking.list',
params: {
filter: {
resourceIdList: [10, 18, 17],
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Bookings:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchResourceBookings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.calendar.resource.booking.list(
filter={
"resourceIdList": [
10,
18,
17,
],
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'calendar.resource.booking.list',
[
'filter' => [
'resourceIdList' => [10, 18, 17]
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching resource booking list: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.resource.booking.list',
{
filter: {
resourceIdList: [10, 18, 17]
}
}
);
require_once('crest.php');
$result = CRest::call(
'calendar.resource.booking.list',
[
'filter' => [
'resourceIdList' => [10, 18, 17]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "calendar.resource.booking.list", b24.Params{
"filter": b24.Params{
"resourceIdList": []int{10, 18, 17},
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("calendar.resource.booking.list: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Обработка ответа
HTTP-статус: 200
Ответ на запрос из примера 1. В примере оставлены только поля, которые есть у каждого бронирования, остальные поля события опущены.
{
"result": [
{
"ID": "1408",
"PARENT_ID": "1408",
"DELETED": "N",
"CAL_TYPE": "resource",
"OWNER_ID": "0",
"NAME": "Бронирование",
"DATE_FROM": "15.07.2024 00:00:00",
"DATE_TO": "16.07.2024 00:00:00",
"TZ_FROM": "Europe/Riga",
"TZ_TO": "Europe/Riga",
"TZ_OFFSET_FROM": "10800",
"TZ_OFFSET_TO": "10800",
"DATE_FROM_TS_UTC": "1721001600",
"DATE_TO_TS_UTC": "1721088000",
"DT_SKIP_TIME": "Y",
"DT_LENGTH": 172800,
"EVENT_TYPE": "#resourcebooking#",
"CREATED_BY": "1",
"DATE_CREATE": "10.07.2024 13:55:35",
"TIMESTAMP_X": "10.07.2024 13:55:35",
"DESCRIPTION": "Услуга: some",
"IS_MEETING": false,
"MEETING_STATUS": "Y",
"MEETING_HOST": "0",
"VERSION": "1",
"SECTION_ID": "10852",
"DATE_FROM_FORMATTED": "Mon Jul 15 2024",
"DATE_TO_FORMATTED": "Tue Jul 16 2024",
"SECT_ID": "10852",
"RESOURCE_BOOKING_ID": "10"
},
{
"ID": "1409",
"PARENT_ID": "1409",
"DELETED": "N",
"CAL_TYPE": "resource",
"OWNER_ID": "0",
"NAME": "Бронирование",
"DATE_FROM": "18.07.2024 10:00:00",
"DATE_TO": "18.07.2024 11:00:00",
"TZ_FROM": "Europe/Riga",
"TZ_TO": "Europe/Riga",
"TZ_OFFSET_FROM": "10800",
"TZ_OFFSET_TO": "10800",
"DATE_FROM_TS_UTC": "1721286000",
"DATE_TO_TS_UTC": "1721289600",
"DT_SKIP_TIME": "N",
"DT_LENGTH": 3600,
"EVENT_TYPE": "#resourcebooking#",
"CREATED_BY": "1",
"DATE_CREATE": "10.07.2024 14:10:02",
"TIMESTAMP_X": "10.07.2024 14:10:02",
"DESCRIPTION": "Услуга: some",
"IS_MEETING": false,
"MEETING_STATUS": "",
"MEETING_HOST": "0",
"VERSION": "1",
"SECTION_ID": "10852",
"DATE_FROM_FORMATTED": "Thu Jul 18 2024 10:00:00",
"DATE_TO_FORMATTED": "Thu Jul 18 2024 11:00:00",
"SECT_ID": "10852",
"RESOURCE_BOOKING_ID": "11"
}
],
"time": {
"start": 1733318565.183275,
"finish": 1733318565.695058,
"duration": 0.5117831230163574,
"processing": 0.29406094551086426,
"date_start": "2024-12-04T13:22:45+00:00",
"date_finish": "2024-12-04T13:22:45+00:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив объектов. Каждый объект описывает бронирование. Если бронирований нет, возвращается пустой массив |
|
time |
Информация о времени выполнения запроса |
Объект бронирования
В ответе есть все поля события календаря, например ACCESSIBILITY, REMIND, ATTENDEE_LIST. Ниже перечислены поля, которые есть у каждого бронирования. Остальные поля описаны в объекте события метода calendar.event.getbyid.
|
Название |
Описание |
|
ID |
Идентификатор события календаря, в котором хранится бронирование. Не путайте его с |
|
PARENT_ID |
Идентификатор родительского события. Для бронирования всегда равен |
|
DELETED |
Флаг удаления. Метод не возвращает удаленные бронирования, поэтому значение всегда |
|
CAL_TYPE |
Тип календаря. Для бронирования всегда |
|
OWNER_ID |
Идентификатор владельца календаря. Для бронирования всегда |
|
NAME |
Название бронирования |
|
DATE_FROM |
Дата и время начала бронирования в часовом поясе |
|
DATE_TO |
Дата и время окончания бронирования в часовом поясе |
|
TZ_FROM |
Часовой пояс даты начала бронирования |
|
TZ_TO |
Часовой пояс даты окончания бронирования |
|
TZ_OFFSET_FROM |
Смещение времени начала бронирования относительно UTC в секундах |
|
TZ_OFFSET_TO |
Смещение времени окончания бронирования относительно UTC в секундах |
|
DATE_FROM_TS_UTC |
Время начала бронирования в формате timestamp. Значение сдвинуто на смещение часового пояса сервера. Точное время задают поля |
|
DATE_TO_TS_UTC |
Время окончания бронирования в формате timestamp. Значение сдвинуто на смещение часового пояса сервера. Точное время задают поля |
|
DT_SKIP_TIME |
Флаг показывает, длится ли бронирование целый день. Возможные значения:
|
|
DT_LENGTH |
Длительность бронирования в секундах |
|
EVENT_TYPE |
Тип события. Для бронирования всегда |
|
CREATED_BY |
Идентификатор пользователя, который создал бронирование |
|
DATE_CREATE |
Дата создания бронирования |
|
TIMESTAMP_X |
Дата изменения бронирования |
|
DESCRIPTION |
Описание бронирования |
|
IS_MEETING |
Признак встречи с участниками. Для бронирования всегда |
|
MEETING_STATUS |
Служебное поле события календаря. Для бронирования не используется, может быть пустой строкой, |
|
MEETING_HOST |
Идентификатор организатора встречи. Для бронирования всегда |
|
VERSION |
Версия изменений бронирования |
|
SECTION_ID |
Идентификатор ресурса, в котором расположено бронирование |
|
DATE_FROM_FORMATTED |
Форматированная дата начала бронирования |
|
DATE_TO_FORMATTED |
Форматированная дата окончания бронирования |
|
SECT_ID |
Дублирует |
|
RESOURCE_BOOKING_ID |
Идентификатор бронирования из пользовательского поля CRM типа Тип значения зависит от фильтра: при выборке по |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Не задан обязательный параметр \"filter['resourceTypeIdList']\" для метода \"calendar.resource.booking.list\""
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
Пустое значение |
Доступ запрещен |
Метод вызывает экстранет-пользователь |
|
|
Пустое значение |
Не задан обязательный параметр "filter['resourceTypeIdList']" для метода "calendar.resource.booking.list" |
Не передан ни |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |