Skip to content

Latest commit

 

History

History
353 lines (306 loc) · 15.1 KB

calendar-event-add.md

File metadata and controls

353 lines (306 loc) · 15.1 KB
Raw

Добавить событие calendar.event.add

Scope: calendar

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

Метод добавляет новое событие в календарь.

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

{% include Сноска об обязательных параметрах %}

#| || Название тип | Описание || || type* string | Тип календаря:

  • user — календарь пользователя
  • group — календарь группы
  • company_calendar — календарь компании || || ownerId* integer | Идентификатор владельца календаря.

Для календаря компании параметр ownerId имеет пустое значение ""|| || from* datetime|date | Дата и время начала события.

Можно указать дату без времени. Для этого передайте значение Y в параметре skip_time || || to* datetime|date | Дата окончания события.

Можно указать дату без времени. Для этого передайте значение Y в параметре skip_time || || from_ts integer | Дата и время в формате timestamp. Можно использовать вместо параметра from || || to_ts integer | Дата и время в формате timestamp. Можно использовать вместо параметра to || || section* integer | Идентификатор календаря || || name* string | Название события || || skip_time string | Передать значение даты без времени в параметрах from и to. Возможные значения:

  • Y — использовать только дату
  • N — использовать дату и время

Формат даты по стандарту ISO-8601 || || timezone_from string | Часовой пояс даты и времени начала события. По умолчанию — таймзона текущего пользователя.

Значение нужно передавать в виде строки, например, Europe/Riga || || timezone_to string | Часовой пояс даты и времени окончания события. Значение по умолчанию — таймзона текущего пользователя.

Значение нужно передавать в виде строки, например, Europe/Riga || || description text | Описание события || || color string | Цвет фона события.

Cимвол # в цвете необходимо передавать в формате unicode — %23 || || text_color string | Цвет текста события.

Cимвол # в цвете необходимо передавать в формате unicode — %23 || || accessibility string | Доступность на время события:

  • busy — занят

  • absent — отсутствую

  • quest — под вопросом

  • free — свободен || || importance string | Важность события:

  • high — высокая

  • normal — средняя

  • low — низкая || || private_event string | Отметка, что событие частное. Возможные значения:

  • Y — частное

  • N — не частное || || rrule object | Повторяемость события в виде объекта в терминах стандарта iCalendar. Структура описана ниже || || is_meeting string | Признак встречи с участниками события. Возможные значения:

  • Y — встреча с участниками

  • N — встреча без участников

Для встречи с участниками укажите список участников attendees и организатора события host || || location string | Место проведения || || remind array | Массив объектов с описанием напоминаний о событии. Структура описана ниже || || attendees array | Список идентификаторов участников события. Если is_meeting = Y || || host integer | Идентиификатор организатора события. Если is_meeting = Y || || meeting object | Объект с параметрами встречи. Структура описана ниже || || crm_fields array | Массив идентификаторов сущностей CRM для привязки к событию. Префиксы:

  • CO_ — компания
  • C_ — контакт
  • L_ — лид
  • D_ — сделка || |#

Параметр rrule {#rrule}

#| || Название тип | Описание || || FREQ string | Частота повторения

  • DAILY — ежедневно
  • WEEKLY — еженедельно
  • MONTHLY — ежемесячно
  • YEARLY — ежегодно || || COUNT integer | Количество повторений || || INTERVAL integer | Интервал между повторениями || ||BYDAY array | Дни недели
  • SU — воскресенье
  • MO — понедельник
  • TU — вторник
  • WE — среда
  • TH — четверг
  • FR — пятница
  • SA — суббота || || UNTIL date | Дата окончания повторений || |#

Параметр remind {#remind}

#| || Название тип | Описание || || type string | Временной тип напоминания

  • min — минуты
  • hour – часы
  • day — дни || || count integer | Числовое значение временного промежутка || |#

Параметр meeting {#meeting}

#| || Название тип | Описание || || notify boolean | Флаг оповещения о подтверждении или отказе участников || || reinvite boolean | Флаг запроса повторного подтверждения участия при редактировании события || || allow_invite boolean | Флаг разрешения участникам приглашать других в событие || || hide_guests boolean | Флаг скрытия списка участников || |#

Примеры кода

{% include Сноска о примерах %}

{% list tabs %}

  • cURL (Webhook)

    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_webbhook_here**/calendar.event.add

  • cURL (OAuth)

    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

  • JS

    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']
    }
);

  • PHP

    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>';

{% endlist %}

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

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 integer | Идентификатор созданного события || |#

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Не задан обязательный параметр "name" для метода "calendar.event.add""
}

{% include notitle обработка ошибок %}

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

#| || Код | Cообщение об ошибке | Описание || || Пустая строка | Не задан обязательный параметр "type" для метода "calendar.event.add" | Не передан обязательный параметр type || || Пустая строка | Не задан обязательный параметр "ownerId" для метода "calendar.event.add" | Не передан обязательный параметр ownerId || || Пустая строка | Не задан обязательный параметр "name" для метода "calendar.event.add" | Не передан обязательный параметр name || || Пустая строка | Не задан обязательный параметр "from" для метода "calendar.event.add" | Не передан обязательный параметр from или from_ts || || Пустая строка | Не задан обязательный параметр "to" для метода "calendar.event.add" | Не передан обязательный параметр to или to_ts || || Пустая строка | Недопустимое значение параметра "name" | Передан неверный формат данных в поле name|| || Пустая строка | Недопустимое значение параметра "description" | Передан неверный формат данных в поле description || || Пустая строка | Доступ запрещен | Запрещено создание событий в указанном календаре || || Пустая строка | Вы задали неверный ID секции календаря или у данного пользователя нет к ней доступа | Передан идентификатор недоступного или несуществующего календаря || || Пустая строка | Список связей события с CRM должен быть массивом | Передан неверный формат данных в поле crm_fields || || Пустая строка | При создании события произошла ошибка | Другая ошибка || |#

{% include системные ошибки %}