Добавить календарь calendar.section.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
calendarКто может выполнять метод: любой пользователь
Метод добавляет новый календарь.
Система добавит новый календарь только для пользователя, который выполнит метод. Администратор может создавать календари для других пользователей.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
type* |
Тип календаря. Возможные значения:
|
|
ownerId* |
Идентификатор владельца календаря. Для |
|
name* |
Название календаря |
|
description |
Описание календаря |
|
color |
Цвет календаря |
|
text_color |
Цвет текста в календаре |
|
export |
Параметр export
|
Название |
Описание |
|
ALLOW |
Разрешить экспорт календаря. Возможные значения:
|
|
SET |
Период, за который производить экспорт. Возможные значения:
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"user","ownerId":2,"name":"New Section","description":"Description for section","color":"#9cbeee","text_color":"#283000","export":{"ALLOW":false,"SET":"3_9"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.section.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"user","ownerId":2,"name":"New Section","description":"Description for section","color":"#9cbeee","text_color":"#283000","export":{"ALLOW":false,"SET":"3_9"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.section.add
// 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 CalendarSectionAddResult = number
try {
const response = await $b24.actions.v2.call.make<CalendarSectionAddResult>({
method: 'calendar.section.add',
params: {
type: 'user',
ownerId: 2,
name: 'New Section',
description: 'Description for section',
color: '#9cbeee',
text_color: '#283000',
export: {
ALLOW: false,
SET: '3_9',
},
},
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('Created calendar with ID:', 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 addCalendarSection() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'calendar.section.add',
params: {
type: 'user',
ownerId: 2,
name: 'New Section',
description: 'Description for section',
color: '#9cbeee',
text_color: '#283000',
export: {
ALLOW: false,
SET: '3_9',
},
},
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('Created calendar with ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addCalendarSection)
</script>
try {
$response = $b24Service
->core
->call(
'calendar.section.add',
[
'type' => 'user',
'ownerId' => 2,
'name' => 'New Section',
'description' => 'Description for section',
'color' => '#9cbeee',
'text_color' => '#283000',
'export' => [
'ALLOW' => false,
'SET' => '3_9',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding calendar section: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.section.add',
{
type: 'user',
ownerId: 2,
name: 'New Section',
description: 'Description for section',
color: '#9cbeee',
text_color: '#283000',
export: {
ALLOW: false,
SET: '3_9'
}
}
);
require_once('crest.php');
$result = CRest::call(
'calendar.section.add',
[
'type' => 'user',
'ownerId' => 2,
'name' => 'New Section',
'description' => 'Description for section',
'color' => '#9cbeee',
'text_color' => '#283000',
'export' => [
'ALLOW' => false,
'SET' => '3_9'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": 190,
"time": {
"start": 1733812564.64201,
"finish": 1733812565.71673,
"duration": 1.0747201442718506,
"processing": 0.05963897705078125,
"date_start": "2024-12-08T06:36:04+00:00",
"date_finish": "2024-12-08T06:36:05+00:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор созданного календаря |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Не задан обязательный параметр "type" для метода "calendar.section.add""
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Сообщение об ошибке |
Описание |
|
Пустая строка |
Не задан обязательный параметр "type" для метода "calendar.section.add" |
Не передан обязательный параметр |
|
Пустая строка |
Не задан обязательный параметр "ownerId" для метода "calendar.section.add" |
Не передан обязательный параметр |
|
Пустая строка |
Недопустимое значение параметра "name" |
Передан неверный формат данных в поле |
|
Пустая строка |
Недопустимое значение параметра "description" |
Передан неверный формат данных в поле |
|
Пустая строка |
Доступ запрещен |
Нет прав для создания календаря с переданным |
|
Пустая строка |
При создании секции произошла ошибка |
Другая ошибка |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |