Получить бронирования ресурсов по фильтру calendar.resource.booking.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: calendar

Кто может выполнять метод: любой пользователь

Метод получает бронирования ресурсов по фильтру.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

filter*
object

Поля фильтра

Параметр filter

Обязательные параметры отмечены *

Название
тип

Описание

resourceTypeIdList*
array

Cписок идентификаторов ресурсов.

Получить идентификаторы можно методом calendar.resource.list

from
date

Дата начала периода

to
date

Дата окончания периода

resourceIdList*
array

Список идентификаторов бронирований ресурсов из пользовательского поля типа resourcebooking у лидов или сделок в CRM.

Получить идентификаторы можно:

Узнать какие пользовательские поля имеют тип resourcebooking можно методом crm.lead.userfield.list для лидов и методом crm.deal.userfield.list для сделок

В методе calendar.resource.booking.list необходимо использовать только один из двух обязательных параметров: resourceTypeIdList или 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
}

try {
  // calendar.resource.booking.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  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',
      },
      start: 0,
    },
    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 on this page:', 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 returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      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',
          },
          start: 0,
        },
        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 on this page:', 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: string
}

try {
  // calendar.resource.booking.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<ResourceBooking[]>({
    method: 'calendar.resource.booking.list',
    params: {
      filter: {
        resourceIdList: [10, 18, 17],
      },
      start: 0,
    },
    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 on this page:', 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 returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'calendar.resource.booking.list',
        params: {
          filter: {
            resourceIdList: [10, 18, 17],
          },
          start: 0,
        },
        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 on this page:', 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

{
    "result": [
        {
            "ID": "1408",
            "PARENT_ID": "1408",
            "DELETED": "N",
            "CAL_TYPE": "resource",
            "OWNER_ID": "0",
            "NAME": "Бронирование",
            "DATE_FROM": "20.12.2024 00:00:00",
            "DATE_TO": "21.12.2024 00:00:00",
            "TZ_FROM": "Europe/Riga",
            "TZ_TO": "Europe/Riga",
            "TZ_OFFSET_FROM": "7200",
            "TZ_OFFSET_TO": "7200",
            "DATE_FROM_TS_UTC": "1734652800",
            "DATE_TO_TS_UTC": "1734739200",
            "DT_SKIP_TIME": "Y",
            "DT_LENGTH": 172800,
            "EVENT_TYPE": "#resourcebooking#",
            "CREATED_BY": "1",
            "DATE_CREATE": "18.12.2024 13:55:35",
            "TIMESTAMP_X": "18.12.2024 13:55:35",
            "DESCRIPTION": "Услуга: some",
            "IS_MEETING": false,
            "MEETING_STATUS": "Y",
            "MEETING_HOST": "0",
            "VERSION": "1",
            "SECTION_ID": "198",
            "DATE_FROM_FORMATTED": "Fri Dec 20 2024",
            "DATE_TO_FORMATTED": "Sat Dec 21 2024",
            "SECT_ID": "198",
            "RESOURCE_BOOKING_ID": "10"
        },
        {
            "ID": "1409",
            ...
        }
    ],
    "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
array

Массив объектов. Каждый объект описывает бронирование

Объект бронирования

Технически бронирование — это событие календаря. Метод получает набор полей, аналогичный полям события календаря. Некоторые поля остаются пустыми, так как они неактуальны для бронирования. Ниже перечислены только актуальные или заполненные поля.

Название
тип

Описание

ID
string

Идентификатор бронирования

PARENT_ID
string

Для объекта бронирования всегда равен полю ID

DELETED
string

Флаг показывает удалено ли бронирование. Возможные значения:

  • Y — бронирование удалено
  • N — бронирование не удалено

CAL_TYPE
string

Тип календаря, в котором находится бронирование

OWNER_ID
string

Для объекта бронирования всегда равно '0'

NAME
string

Название бронирования

DATE_FROM
datetime

Дата начала бронирования

DATE_TO
datetime

Дата окончания бронирования

TZ_FROM
string

Таймзона даты начала бронирования

TZ_TO
string

Таймзона даты окончания бронирования

TZ_OFFSET_FROM
string

Смещение времени начала бронирования относительно UTC в секундах

TZ_OFFSET_TO
string

Смещение времени окончания бронирования относительно UTC в секундах

DATE_FROM_TS_UTC
string

Дата и время начала бронирования в UTC в формате timestamp

DATE_TO_TS_UTC
string

Дата и время окончания бронирования в UTC в формате timestamp

DT_SKIP_TIME
string

Флаг показывает, длится ли бронирование целый день. Возможные значения:

  • Y — целый день
  • N — не целый день

DT_LENGTH
integer

Длительность бронирования в секундах

EVENT_TYPE
string

Тип бронирования

CREATED_BY
string

Идентификатор пользователя, который создал бронирование

DATE_CREATE
datetime

Дата создания бронирования

TIMESTAMP_X
datetime

Дата изменения бронирования

DESCRIPTION
string

Описание бронирования

IS_MEETING
boolean

Для объекта бронирования всегда false

MEETING_STATUS
string

Для объекта бронирования всегда 'Y'

MEETING_HOST
string

Для объекта бронирования всегда '0'

VERSION
string

Версия изменений бронирования

SECTION_ID
string

Идентификатор ресурса, в котором расположено бронирование

DATE_FROM_FORMATTED
string

Форматированная дата начала бронирования

DATE_TO_FORMATTED
string

Форматированная дата окончания бронирования

SECT_ID
string

Идентификатор ресурса, в котором расположено бронирование

RESOURCE_BOOKING_ID
integer

Идентификатор бронирования

Обработка ошибок

HTTP-статус: 400

{
    "error": "",
    "error_description": "Не задан обязательный параметр \"filter['resourceTypeIdList']\" для метода \"calendar.resource.booking.list\""
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Сообщение об ошибке

Описание

Пустое значение

Доступ запрещен

Запрещен доступ к методу для внешних пользователей

Пустое значение

Не задан обязательный параметр "filter['resourceTypeIdList']" для метода "calendar.resource.booking.list"

Не передан ни один из обязательных параметров: resourceTypeIdList или resourceIdList

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

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

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

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

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение