Добавить событие calendar.event.add
Scope:
calendarКто может выполнять метод: любой пользователь
Метод добавляет новое событие в календарь.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
type* |
Тип календаря:
|
|
ownerId* |
Идентификатор владельца календаря. Для календаря компании параметр |
|
from* |
Дата и время начала события. Можно указать дату без времени. Для этого передайте значение |
|
to* |
Дата окончания события. Можно указать дату без времени. Для этого передайте значение |
|
from_ts |
Дата и время в формате timestamp. Можно использовать вместо параметра |
|
to_ts |
Дата и время в формате timestamp. Можно использовать вместо параметра |
|
section* |
Идентификатор календаря. Параметр обязателен, если |
|
auto_detect_section |
Режим автоопределения секции. Возможные значения:
Если параметр не передан, метод пытается автоопределить секцию |
|
name* |
Название события |
|
skip_time |
Передать значение даты без времени в параметрах
Формат даты по стандарту ISO-8601 |
|
timezone_from |
Часовой пояс даты и времени начала события. По умолчанию — таймзона текущего пользователя. Значение нужно передавать в виде строки, например, |
|
timezone_to |
Часовой пояс даты и времени окончания события. Значение по умолчанию — таймзона текущего пользователя. Значение нужно передавать в виде строки, например, |
|
description |
Описание события |
|
color |
Цвет фона события. Cимвол |
|
text_color |
Цвет текста события. Cимвол |
|
accessibility |
Доступность на время события:
|
|
importance |
Важность события:
|
|
private_event |
Отметка, что событие частное. Возможные значения:
|
|
rrule |
Повторяемость события в виде объекта в терминах стандарта iCalendar. Структура описана ниже |
|
is_meeting |
Признак встречи с участниками события. Возможные значения:
Для встречи с участниками обязательно укажите список участников |
|
location |
Место проведения |
|
remind |
Массив объектов с описанием напоминаний о событии. Структура описана ниже |
|
attendees* |
Список идентификаторов участников события. Поле обязательное, если |
|
host* |
Идентификатор организатора события. Поле обязательное, если |
|
meeting |
Объект с параметрами встречи. Структура описана ниже |
|
crm_fields |
Массив идентификаторов объектов CRM для привязки к событию. Чтобы привязать объекты, перечислите их идентификаторы с префиксами:
|
Особенности работы с часовыми поясами
При работе с датами и временем событий можно использовать два подхода:
-
Полный формат даты с часовым поясом.
Используйте формат ISO-8601 с указанием часового пояса в параметрах
fromиto:2025-03-20T15:00:00+02:00— с указанием смещения2025-08-05T10:00:00+11:00— с указанием смещения2025-08-04T23:00:00Z— с указанием UTC
Параметры
timezone_fromиtimezone_toигнорируются, так как часовой пояс уже указан в дате. -
Простой формат даты с отдельными параметрами часового пояса.
Используйте простой формат в параметрах
fromиto:2025-03-20 15:00:002025-08-05 10:00:002025-08-05T10:00:00
Укажите часовой пояс в параметрах
timezone_fromиtimezone_to:Europe/MoscowAmerica/New_YorkAsia/Tokyo
Если указан только
timezone_from, его значение будет использовано и дляtimezone_to.
Приоритет обработки параметров часового пояса:
- Высший приоритет. Если в параметрах
fromиtoуказан полный формат с часовым поясом, параметрыtimezone_fromиtimezone_toигнорируются - Средний приоритет. Если используется простой формат даты и указаны параметры
timezone_fromиtimezone_to, используются они - Низший приоритет. Если формат даты простой и параметры часового пояса не заданы, используется часовой пояс текущего пользователя
Параметр rrule
|
Название |
Описание |
|
FREQ |
Частота повторения
|
|
COUNT |
Количество повторений |
|
INTERVAL |
Интервал между повторениями |
|
BYDAY |
Дни недели
|
|
UNTIL |
Дата окончания повторений |
Параметр remind
|
Название |
Описание |
|
type |
Временной тип напоминания
|
|
count |
Числовое значение временного промежутка |
Параметр meeting
|
Название |
Описание |
|
notify |
Флаг оповещения о подтверждении или отказе участников |
|
reinvite |
Флаг запроса повторного подтверждения участия при редактировании события |
|
allow_invite |
Флаг разрешения участникам приглашать других в событие |
|
hide_guests |
Флаг скрытия списка участников |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"user","ownerId":2,"name":"New Event Name","description":"Description for event","from":"2024-06-14","to":"2024-06-14","skip_time":"Y","section":5,"color":"#9cbe1c","text_color":"#283033","accessibility":"absent","importance":"normal","is_meeting":"Y","private_event":"N","remind":[{"type":"min","count":20}],"location":"London","attendees":[1,2,3],"host":2,"meeting":{"notify":true,"reinvite":false,"allow_invite":false,"hide_guests":false},"rrule":{"FREQ":"WEEKLY","BYDAY":["MO","WE"],"COUNT":10,"INTERVAL":1},"crm_fields":["C_5","L_11"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.event.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"user","ownerId":2,"name":"New Event Name","description":"Description for event","from":"2024-06-14","to":"2024-06-14","skip_time":"Y","section":5,"color":"#9cbe1c","text_color":"#283033","accessibility":"absent","importance":"normal","is_meeting":"Y","private_event":"N","remind":[{"type":"min","count":20}],"location":"London","attendees":[1,2,3],"host":2,"meeting":{"notify":true,"reinvite":false,"allow_invite":false,"hide_guests":false},"rrule":{"FREQ":"WEEKLY","BYDAY":["MO","WE"],"COUNT":10,"INTERVAL":1},"crm_fields":["C_5","L_11"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.event.add
try
{
const response = await $b24.callMethod(
'calendar.event.add',
{
type: 'user',
ownerId: 2,
name: 'New Event Name',
description: 'Description for event',
from: '2024-06-14',
to: '2024-06-14',
skip_time: 'Y',
section: 5,
color: '#9cbe1c',
text_color: '#283033',
accessibility: 'absent',
importance: 'normal',
is_meeting: 'Y',
private_event: 'N',
remind: [
{
type: 'min',
count: 20
}
],
location: 'London',
attendees: [1, 2, 3],
host: 2,
meeting: {
notify: true,
reinvite: false,
allow_invite: false,
hide_guests: false,
},
rrule: {
FREQ: 'WEEKLY',
BYDAY: ['MO', 'WE'],
COUNT: 10,
INTERVAL: 1,
},
crm_fields: ['C_5', 'L_11']
}
);
const result = response.getData().result;
console.log('Created event with ID:', result);
// Нужная вам логика обработки данных
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'calendar.event.add',
[
'type' => 'user',
'ownerId' => 2,
'name' => 'New Event Name',
'description' => 'Description for event',
'from' => '2024-06-14',
'to' => '2024-06-14',
'skip_time' => 'Y',
'section' => 5,
'color' => '#9cbe1c',
'text_color' => '#283033',
'accessibility' => 'absent',
'importance' => 'normal',
'is_meeting' => 'Y',
'private_event' => 'N',
'remind' => [
[
'type' => 'min',
'count' => 20
]
],
'location' => 'London',
'attendees' => [1, 2, 3],
'host' => 2,
'meeting' => [
'notify' => true,
'reinvite' => false,
'allow_invite' => false,
'hide_guests' => false,
],
'rrule' => [
'FREQ' => 'WEEKLY',
'BYDAY' => ['MO', 'WE'],
'COUNT' => 10,
'INTERVAL' => 1,
],
'crm_fields' => ['C_5', 'L_11']
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding calendar event: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.event.add',
{
type: 'user',
ownerId: 2,
name: 'New Event Name',
description: 'Description for event',
from: '2024-06-14',
to: '2024-06-14',
skip_time: 'Y',
section: 5,
color: '#9cbe1c',
text_color: '#283033',
accessibility: 'absent',
importance: 'normal',
is_meeting: 'Y',
private_event: 'N',
remind: [
{
type: 'min',
count: 20
}
],
location: 'London',
attendees: [1, 2, 3],
host: 2,
meeting: {
notify: true,
reinvite: false,
allow_invite: false,
hide_guests: false,
},
rrule: {
FREQ: 'WEEKLY',
BYDAY: ['MO', 'WE'],
COUNT: 10,
INTERVAL: 1,
},
crm_fields: ['C_5', 'L_11']
}
);
require_once('crest.php');
$result = CRest::call(
'calendar.event.add',
[
'type' => 'user',
'ownerId' => 2,
'name' => 'New Event Name',
'description' => 'Description for event',
'from' => '2024-06-14',
'to' => '2024-06-14',
'skip_time' => 'Y',
'section' => 5,
'color' => '#9cbe1c',
'text_color' => '#283033',
'accessibility' => 'absent',
'importance' => 'normal',
'is_meeting' => 'Y',
'private_event' => 'N',
'remind' => [
[
'type' => 'min',
'count' => 20
]
],
'location' => 'London',
'attendees' => [1, 2, 3],
'host' => 2,
'meeting' => [
'notify' => true,
'reinvite' => false,
'allow_invite' => false,
'hide_guests' => false,
],
'rrule' => [
'FREQ' => 'WEEKLY',
'BYDAY' => ['MO', 'WE'],
'COUNT' => 10,
'INTERVAL' => 1,
],
'crm_fields' => ['C_5', 'L_11']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Как добавить повторяемое событие в календарь компании
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"company_calendar","ownerId":"","from":"2025-01-31T18:00:00","to":"2025-01-31T20:00:00","section":1,"name":"Важная встреча","skip_time":"N","timezone_from":"Europe/Moscow","timezone_to":"Europe/Moscow","description":"Описание события","color":"#FF0000","text_color":"#000000","accessibility":"busy","importance":"high","private_event":"N","rrule":{"FREQ":"WEEKLY","COUNT":10,"INTERVAL":1,"BYDAY":["MO","WE","FR"]},"is_meeting":"Y","location":"Конференц-зал","remind":[{"type":"min","count":30}],"attendees":[29,93],"host":1,"meeting":{"notify":true,"reinvite":false,"allow_invite":true,"hide_guests":false}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.event.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"company_calendar","ownerId":"","from":"2025-01-31T18:00:00","to":"2025-01-31T20:00:00","section":1,"name":"Важная встреча","skip_time":"N","timezone_from":"Europe/Moscow","timezone_to":"Europe/Moscow","description":"Описание события","color":"#FF0000","text_color":"#000000","accessibility":"busy","importance":"high","private_event":"N","rrule":{"FREQ":"WEEKLY","COUNT":10,"INTERVAL":1,"BYDAY":["MO","WE","FR"]},"is_meeting":"Y","location":"Конференц-зал","remind":[{"type":"min","count":30}],"attendees":[29,93],"host":1,"meeting":{"notify":true,"reinvite":false,"allow_invite":true,"hide_guests":false},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.event.add
try
{
const response = await $b24.callMethod(
'calendar.event.add',
{
type: 'company_calendar',
ownerId: '',
from: '2025-01-31T18:00:00',
to: '2025-01-31T20:00:00',
section: 1,
name: 'Важная встреча',
skip_time: 'N',
timezone_from: 'Europe/Moscow',
timezone_to: 'Europe/Moscow',
description: 'Описание события',
color: '%23FF0000',
text_color: '%23000000',
accessibility: 'busy',
importance: 'high',
private_event: 'N',
rrule: {
FREQ: 'WEEKLY',
COUNT: 10,
INTERVAL: 1,
BYDAY: ['MO', 'WE', 'FR']
},
is_meeting: 'Y',
location: 'Конференц-зал',
remind: [
{ type: 'min', count: 30 }
],
attendees: [29, 93],
host: 1,
meeting: {
notify: true,
reinvite: false,
allow_invite: true,
hide_guests: false
}
}
);
const result = response.getData().result;
console.log('Event added successfully', result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'calendar.event.add',
[
'type' => 'company_calendar',
'ownerId' => '',
'from' => '2025-01-31T18:00:00',
'to' => '2025-01-31T20:00:00',
'section' => 1,
'name' => 'Важная встреча',
'skip_time' => 'N',
'timezone_from' => 'Europe/Moscow',
'timezone_to' => 'Europe/Moscow',
'description' => 'Описание события',
'color' => '%23FF0000',
'text_color' => '%23000000',
'accessibility' => 'busy',
'importance' => 'high',
'private_event' => 'N',
'rrule' => [
'FREQ' => 'WEEKLY',
'COUNT' => 10,
'INTERVAL' => 1,
'BYDAY' => ['MO', 'WE', 'FR']
],
'is_meeting' => 'Y',
'location' => 'Конференц-зал',
'remind' => [
['type' => 'min', 'count' => 30]
],
'attendees' => [29, 93],
'host' => 1,
'meeting' => [
'notify' => true,
'reinvite' => false,
'allow_invite' => true,
'hide_guests' => false
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Event added successfully: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding event: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.event.add',
{
type: 'company_calendar', // Тип календаря: календарь компании
ownerId: '', // Для календаря компании ownerId имеет пустое значение
from: '2025-01-31T18:00:00', // Дата и время начала события
to: '2025-01-31T20:00:00', // Дата и время окончания события
section: 1, // Идентификатор календаря
name: 'Важная встреча', // Название события
skip_time: 'N', // Использовать дату и время (N)
timezone_from: 'Europe/Moscow', // Часовой пояс начала события
timezone_to: 'Europe/Moscow', // Часовой пояс окончания события
description: 'Описание события', // Описание события
color: '%23FF0000', // Цвет фона события (красный)
text_color: '%23000000', // Цвет текста события (черный)
accessibility: 'busy', // Доступность на время события: занят
importance: 'high', // Важность события: высокая
private_event: 'N', // Событие не является частным
rrule: { // Параметры повторяемости события
FREQ: 'WEEKLY', // Частота повторения: еженедельно
COUNT: 10, // Количество повторений
INTERVAL: 1, // Интервал между повторениями
BYDAY: ['MO', 'WE', 'FR'] // Дни недели: понедельник, среда, пятница
},
is_meeting: 'Y', // Признак встречи с участниками
location: 'Конференц-зал', // Место проведения
remind: [ // Напоминания о событии
{ type: 'min', count: 30 } // Напоминание за 30 минут до события
],
attendees: [29, 93], // Список идентификаторов участников события
host: 1, // Идентификатор организатора события
meeting: { // Параметры встречи
notify: true, // Оповещение о подтверждении или отказе участников
reinvite: false, // Не запрашивать повторное подтверждение участия
allow_invite: true, // Разрешить участникам приглашать других
hide_guests: false // Не скрывать список участников
}
},
function(result) {
if(result.error()) {
console.error(result.error()); // Обработка ошибки
} else {
console.log('Event added successfully', result.data()); // Успешное добавление события
}
}
);
require_once('crest.php');
$result = CRest::call(
'calendar.event.add',
[
'type' => 'company_calendar', // Тип календаря: календарь компании
'ownerId' => '', // Для календаря компании ownerId имеет пустое значение
'from' => '2025-01-31T18:00:00', // Дата и время начала события
'to' => '2025-01-31T20:00:00', // Дата и время окончания события
'section' => 1, // Идентификатор календаря (замените на реальный)
'name' => 'Важная встреча', // Название события
'skip_time' => 'N', // Использовать дату и время (N)
'timezone_from' => 'Europe/Moscow', // Часовой пояс начала события
'timezone_to' => 'Europe/Moscow', // Часовой пояс окончания события
'description' => 'Описание события', // Описание события
'color' => '#FF0000', // Цвет фона события (красный)
'text_color' => '#000000', // Цвет текста события (черный)
'accessibility' => 'busy', // Доступность на время события: занят
'importance' => 'high', // Важность события: высокая
'private_event' => 'N', // Событие не является частным
'rrule' => [ // Параметры повторяемости события
'FREQ' => 'WEEKLY', // Частота повторения: еженедельно
'COUNT' => 10, // Количество повторений
'INTERVAL' => 1, // Интервал между повторениями
'BYDAY' => ['MO', 'WE', 'FR'] // Дни недели: понедельник, среда, пятница
],
'is_meeting' => 'Y', // Признак встречи с участниками
'location' => 'Конференц-зал', // Место проведения
'remind' => [ // Напоминания о событии
['type' => 'min', 'count' => 30] // Напоминание за 30 минут до события
],
'attendees' => [29, 93], // Список идентификаторов участников события
'host' => 1, // Идентификатор организатора события
'meeting' => [ // Параметры встречи
'notify' => true, // Оповещение о подтверждении или отказе участников
'reinvite' => false, // Не запрашивать повторное подтверждение участия
'allow_invite' => true, // Разрешить участникам приглашать других
'hide_guests' => false // Не скрывать список участников
]
]
);
if (isset($result['error'])) {
echo 'Ошибка: ' . $result['error_description']; // Обработка ошибки
} else {
echo 'Событие успешно добавлено: ';
print_r($result['result']); // Успешное добавление события
}
Обработка ответа
HTTP-статус: 200
{
"result": 1246,
"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 |
Идентификатор созданного события |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Не задан обязательный параметр "name" для метода "calendar.event.add""
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Cообщение об ошибке |
Описание |
|
Пустая строка |
Не задан обязательный параметр "type" для метода "calendar.event.add" |
Не передан обязательный параметр |
|
Пустая строка |
Не задан обязательный параметр "ownerId" для метода "calendar.event.add" |
Не передан обязательный параметр |
|
Пустая строка |
Не задан обязательный параметр "name" для метода "calendar.event.add" |
Не передан обязательный параметр |
|
Пустая строка |
Не задан обязательный параметр "from" для метода "calendar.event.add" |
Не передан обязательный параметр |
|
Пустая строка |
Не задан обязательный параметр "to" для метода "calendar.event.add" |
Не передан обязательный параметр |
|
Пустая строка |
Недопустимое значение параметра "name" |
Передан неверный формат данных в поле |
|
Пустая строка |
Недопустимое значение параметра "description" |
Передан неверный формат данных в поле |
|
Пустая строка |
Доступ запрещен |
Запрещено создание событий в указанном календаре |
|
Пустая строка |
Вы задали неверный ID секции календаря или у данного пользователя нет к ней доступа |
Передан идентификатор недоступного или несуществующего календаря |
|
Пустая строка |
Список связей события с CRM должен быть массивом |
Передан неверный формат данных в поле |
|
Пустая строка |
При создании события произошла ошибка |
Другая ошибка |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |