метод REST scope: booking

booking.v1.resource.add

Добавить новый ресурс

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

Описание

Метод booking.v1.resource.add добавляет новый ресурс.

Параметры

fields object обязательный

Объект, содержащий значения полей для создания ресурса (подробное описание)

Параметр fields

name string обязательный

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

description string необязательный

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

По умолчанию пустая строка

typeId integer обязательный

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

Список доступных типов можно узнать с помощью метода booking.v1.resourceType.list

isMain string необязательный

Как показывать ресурс. Возможные значения:
- Y — в колонках расписания
- N — при пересечении ресурсов

По умолчанию Y

isInfoNotificationOn string необязательный

Сообщение клиенту о записи. Возможные значения:
- Y — включено
- N — выключено

По умолчанию Y

templateTypeInfo string необязательный

Тип шаблона сообщения о записи. Возможные значения:
- inanimate — шаблон для бронирования оборудования и помещений
- animate — шаблон для записи к специалистам

По умолчанию inanimate

isConfirmationNotificationOn string необязательный

Автоматическое подтверждение записи. Возможные значения:
- Y — включено
- N — выключено

По умолчанию Y

templateTypeConfirmation string необязательный

Тип шаблона сообщения о подтверждении записи. Возможные значения:
- inanimate — шаблон для бронирования оборудования и помещений
- animate — шаблон для записи к специалистам

По умолчанию inanimate

isReminderNotificationOn string необязательный

Напоминание о записи. Возможные значения:
- Y — включено
- N — выключено

По умолчанию Y

templateTypeReminder string необязательный

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

isFeedbackNotificationOn string необязательный

Запрос обратной связи. Возможные значения:
- Y — включено
- N — выключено

По умолчанию Y

templateTypeFeedback string необязательный

Тип шаблона сообщения для запроса обратной связи. Возможные значения:
- inanimate — шаблон для бронирования оборудования и помещений
- animate — шаблон для записи к специалистам

По умолчанию inanimate

isDelayedNotificationOn string необязательный

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

По умолчанию Y

templateTypeDelayed string необязательный

Тип шаблона сообщения об опоздании. Возможные значения:
- inanimate — шаблон для бронирования оборудования и помещений
- animate — шаблон для записи к специалистам

По умолчанию inanimate

infoDelay integer необязательный

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

По умолчанию 300

reminderDelay integer необязательный

Время до записи, за которое клиенту приходит напоминание о записи. Указывается в секундах.

По умолчанию -1, утром в день записи

delayedDelay integer необязательный

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

По умолчанию 300

delayedCounterDelay integer необязательный

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

По умолчанию 7200

confirmationDelay integer необязательный

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

По умолчанию 86400

confirmationRepetitions integer необязательный

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

По умолчанию 0

confirmationRepetitionsInterval integer необязательный

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

По умолчанию 0

confirmationCounterDelay integer необязательный

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

По умолчанию 7200

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Название","description":"Описание","typeId":1,"isMain":"N","isInfoNotificationOn":"Y","templateTypeInfo":"inanimate","isConfirmationNotificationOn":"Y","templateTypeConfirmation":"animate","isReminderNotificationOn":"N","templateTypeReminder":"base","isFeedbackNotificationOn":"Y","templateTypeFeedback":"inanimate","isDelayedNotificationOn":"Y","templateTypeDelayed":"inanimate","infoDelay":60,"reminderDelay":-1,"delayedDelay":300,"delayedCounterDelay":7200,"confirmationDelay":86400,"confirmationRepetitions":1,"confirmationRepetitionsInterval":3600,"confirmationCounterDelay":7200}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.resource.add

Ответ

HTTP-статус: 200

{
    "result": {
        "id": 1823
    },
    "time": {
        "start": 1724068028.331234,
        "finish": 1724068028.726591,
        "duration": 0.3953571319580078,
        "processing": 0.13033390045166016,
        "date_start": "2025-01-21T13:47:08+02:00",
        "date_finish": "2025-01-21T13:47:08+02:00",
        "operating": 0
    }
}

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

result object

Корневой элемент ответа, содержит идентификатор созданного ресурса

time time

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

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

HTTP-статус: 400

{
    "error": 1013,
    "error_description": "Resource type with id 17 does not exist"
}
Код Описание Значение
0 Required fields: name Не передан обязательный параметр внутри fields
100 Could not find value for parameter {fields} Не передан обязательный параметр fields
1006 ResourceType not found Не указан typeId
1013 Resource type with id does not exist Указан несуществующий typeId
422 Invalid value of the field Неверное значение поля

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.