Получить ресурс booking.v1.resource.get

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

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

Scope: booking

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

Метод booking.v1.resource.get возвращает информацию о ресурсе по идентификатору.

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

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

Название
тип

Описание

id*
integer

Идентификатор ресурса.
Можно получить в методах booking.v1.resource.add и booking.v1.resource.list

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":15}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.resource.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":15,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/booking.v1.resource.get

// 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 the payload returned in result (match the "response handling" section of the page)
type ResourceResult = {
  resource: {
    confirmationCounterDelay: number,
    confirmationNotificationDelay: number,
    confirmationNotificationRepetitions: number | null,
    confirmationNotificationRepetitionsInterval: number,
    delayedCounterDelay: number,
    delayedNotificationDelay: number,
    description: string | null,
    id: number,
    infoNotificationDelay: number | null,
    isConfirmationNotificationOn: string,
    isDelayedNotificationOn: string,
    isFeedbackNotificationOn: string,
    isInfoNotificationOn: string,
    isMain: string,
    isReminderNotificationOn: string,
    name: string,
    reminderNotificationDelay: number,
    templateTypeConfirmation: string,
    templateTypeDelayed: string,
    templateTypeFeedback: string,
    templateTypeInfo: string,
    templateTypeReminder: string,
    typeId: number,
  },
}

try {
  const response = await $b24.actions.v2.call.make<ResourceResult>({
    method: 'booking.v1.resource.get',
    params: {
      id: 15,
    },
    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(result.resource.id, result.resource.name, result.resource.typeId)
  }
} 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 getResource() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'booking.v1.resource.get',
        params: {
          id: 15,
        },
        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(result.resource.id, result.resource.name, result.resource.typeId)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getResource)
</script>

try {
    $response = $b24Service
        ->core
        ->call(
            'booking.v1.resource.get',
            [
                'id' => 15,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting resource: ' . $e->getMessage();
}

BX24.callMethod(
    "booking.v1.resource.get",
    {
        id: 15
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

require_once('crest.php');

$result = CRest::call(
    'booking.v1.resource.get',
    [
        'id' => 15
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "booking.v1.resource.get", b24.Params{
	"id": 15,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("booking.v1.resource.get: %w", err)
}

// Метод заворачивает ответ в объект с ключом "resource".
raw, ok := b24.Unwrap(res.Result, "resource")
if !ok {
	return fmt.Errorf("в ответе нет ключа resource")
}

var item struct {
	ConfirmationCounterDelay                    int    `json:"confirmationCounterDelay"`
	ConfirmationNotificationDelay               int    `json:"confirmationNotificationDelay"`
	ConfirmationNotificationRepetitionsInterval int    `json:"confirmationNotificationRepetitionsInterval"`
	DelayedCounterDelay                         int    `json:"delayedCounterDelay"`
	DelayedNotificationDelay                    int    `json:"delayedNotificationDelay"`
	ID                                          b24.ID `json:"id"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ConfirmationCounterDelay, item.ConfirmationNotificationDelay)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "resource": {
            "confirmationCounterDelay": 10800,
            "confirmationNotificationDelay": 86400,
            "confirmationNotificationRepetitions": null,
            "confirmationNotificationRepetitionsInterval": 10800,
            "delayedCounterDelay": 300,
            "delayedNotificationDelay": 300,
            "description": null,
            "id": 15,
            "infoNotificationDelay": null,
            "isConfirmationNotificationOn": "Y",
            "isDelayedNotificationOn": "N",
            "isFeedbackNotificationOn": "N",
            "isInfoNotificationOn": "Y",
            "isMain": "Y",
            "isReminderNotificationOn": "Y",
            "name": "Название",
            "reminderNotificationDelay": -1,
            "templateTypeConfirmation": "animate",
            "templateTypeDelayed": "animate",
            "templateTypeFeedback": "animate",
            "templateTypeInfo": "inanimate",
            "templateTypeReminder": "base",
            "typeId": 1
        }
    },
    "time": {
        "start": 1746539524.292041,
        "finish": 1746539524.356627,
        "duration": 0.06458592414855957,
        "processing": 0.018703937530517578,
        "date_start": "2025-05-06T16:52:04+03:00",
        "date_finish": "2025-05-06T16:52:04+03:00",
        "operating_reset_at": 1746540124,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа. Содержит информацию о полях ресурса. Структура описана ниже

time
time

Информация о времени выполнения запроса

Ресурс

confirmationCounterDelay
integer

Время до записи в секундах, после которого загорается счетчик не подтвержденной записи

confirmationDelay
integer

Время до записи в секундах, когда клиенту приходит первое сообщение для подтверждения записи

confirmationRepetitions
integer

Количество сообщений, которые приходят клиенту для подтверждения записи, не учитывая первого

confirmationRepetitionsInterval
integer

Интервал между сообщениями о подтверждении записи, в секундах

delayedCounterDelay
integer

Время в секундах, через сколько включить счетчик в календаре

delayedDelay
integer

Время в секундах, через сколько отправить клиенту сообщение об опоздании

description
string

Описание ресурса

id
integer

Идентификатор ресурса

infoDelay
integer

Задержка в секундах, после которой клиенту приходит сообщение о записи

isConfirmationNotificationOn
string

Автоматическое подтверждение записи. Возможные значения:

  • Y — включено
  • N — выключено

isDelayedNotificationOn
string

Напоминание, когда клиент опаздывает. Возможные значения:

  • Y — включено
  • N — выключено

isFeedbackNotificationOn
string

Запрос обратной связи. Возможные значения:

  • Y — включено
  • N — выключено

isInfoNotificationOn
string

Сообщение клиенту о записи. Возможные значения:

  • Y — включено
  • N — выключено

isMain
string

Как показывать ресурс. Возможные значения:

  • Y — в колонках расписания
  • N — при пересечении ресурсов

isReminderNotificationOn
string

Напоминание о записи. Возможные значения:

  • Y — включено
  • N — выключено

name
string

Название ресурса

reminderDelay
integer

Время до записи в секундах, за которое клиенту приходит напоминание о записи.
Значение -1 — утром в день записи

templateTypeConfirmation
string

Тип шаблона сообщения о подтверждении записи. Возможные значения:

  • inanimate — шаблон для бронирования оборудования и помещений
  • animate — шаблон для записи к специалистам

templateTypeDelayed
string

Тип шаблона сообщения об опоздании. Возможные значения:

  • inanimate — шаблон для бронирования оборудования и помещений
  • animate — шаблон для записи к специалистам

templateTypeFeedback
string

Тип шаблона сообщения для запроса обратной связи. Возможные значения:

  • inanimate — шаблон для бронирования оборудования и помещений
  • animate — шаблон для записи к специалистам

templateTypeInfo
string

Тип шаблона сообщения о записи. Возможные значения:

  • inanimate — шаблон для бронирования оборудования и помещений
  • animate — шаблон для записи к специалистам

templateTypeReminder
string

Тип шаблона сообщения для напоминания. Возможные значения: base

typeId
integer

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

Получить информацию о типе можно с помощью метода booking.v1.resourceType.get

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

HTTP-статус: 400

{
    "error": 1021,
    "error_description": "Resource not found"
}

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

1009

Resource not found

Ресурс с таким id не найден

100

Could not find value for parameter {id}

Не передан обязательный параметр

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Обновить ресурс
Следующая
Получить список ресурсов