Получить занятость пользователей из списка calendar.accessibility.get

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

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

Scope: calendar

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

Метод получает занятость пользователей из списка.

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

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

Название
тип

Описание

users*
array

Массив идентификаторов пользователей

from*
date

Дата начала периода для определения занятости в формате ГГГГ-ММ-ДД.

Например, 2024-06-20

to*
date

Дата окончания периода для определения занятости в формате ГГГГ-ММ-ДД.

Например, 2024-12-20

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"from":"2024-06-20","to":"2024-12-20","users":[1,2,34]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.accessibility.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"from":"2024-06-20","to":"2024-12-20","users":[1,2,34],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.accessibility.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

type CalendarEventItem = {
  ID: string
  NAME: string
  DATE_FROM: string
  DATE_TO: string
  DATE_FROM_TS_UTC: string
  DATE_TO_TS_UTC: string
  '~USER_OFFSET_FROM': number
  '~USER_OFFSET_TO': number
  DT_SKIP_TIME: 'Y' | 'N'
  TZ_FROM: string
  TZ_TO: string
  ACCESSIBILITY: 'busy' | 'absent' | 'quest' | 'free'
  IMPORTANCE: 'high' | 'normal' | 'low'
  EVENT_TYPE: string
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type AccessibilityGetResult = Record<string, CalendarEventItem[]>

try {
  const response = await $b24.actions.v2.call.make<AccessibilityGetResult>({
    method: 'calendar.accessibility.get',
    params: {
      from: '2024-06-20',
      to: '2024-12-20',
      users: [1, 2, 34],
    },
    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
    for (const [userId, events] of Object.entries(result)) {
      console.info(`User ${userId}:`, events.map(e => `${e.NAME} (${e.ACCESSIBILITY})`))
    }
  }
} 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 getAccessibility() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'calendar.accessibility.get',
        params: {
          from: '2024-06-20',
          to: '2024-12-20',
          users: [1, 2, 34],
        },
        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
      for (const [userId, events] of Object.entries(result)) {
        console.info(`User ${userId}:`, events.map(e => `${e.NAME} (${e.ACCESSIBILITY})`))
      }
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getAccessibility)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.calendar.accessibility.get(
        users=[
            1,
            2,
            34,
        ],
        from_date="2024-06-20",
        to="2024-12-20",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'calendar.accessibility.get',
            [
                'from'  => '2024-06-20',
                'to'    => '2024-12-20',
                'users' => [1, 2, 34]
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting calendar accessibility: ' . $e->getMessage();
}
BX24.callMethod(
    'calendar.accessibility.get',
    {
        from: '2024-06-20',
        to: '2024-12-20',
        users: [1, 2, 34]
    }
);
require_once('crest.php');

$result = CRest::call(
    'calendar.accessibility.get',
    [
        'from' => '2024-06-20',
        'to' => '2024-12-20',
        'users' => [1, 2, 34]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "calendar.accessibility.get", b24.Params{
	"from":  "2024-06-20",
	"to":    "2024-12-20",
	"users": []int{1, 2, 34},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("calendar.accessibility.get: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

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

HTTP-статус: 200

{
    "result": {
        "1": [
            {
                "ID": "1213",
                "NAME": "Event name",
                "DATE_FROM": "02.12.2024 11:00:00",
                "DATE_TO": "02.12.2024 12:00:00",
                "DATE_FROM_TS_UTC": "1733158800",
                "DATE_TO_TS_UTC": "1733162400",
                "~USER_OFFSET_FROM": -21600,
                "~USER_OFFSET_TO": -21600,
                "DT_SKIP_TIME": "N",
                "TZ_FROM": "America/Managua",
                "TZ_TO": "America/Managua",
                "ACCESSIBILITY": "busy",
                "IMPORTANCE": "normal",
                "EVENT_TYPE": "#collab#"
            },
            {
                "ID": "1216",
                ...
            }
        ],
        "2": [
            {
                "ID": 1,
                ...
            },
            {
                "ID": 2,
                ...
            }
        ],
        "34": []
    }
}

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

Название
тип

Описание

result
object

Результат содержит объект.

Ключ объекта — это идентификатор пользователя из запроса.

Значение — массив объектов, каждый из которых описывает событие, в котором занят пользователь в указанный период

Объект события

Название
тип

Описание

ID
string

Идентификатор события

NAME
string

Название события

DATE_FROM
datetime

Дата и время начала события

DATE_TO
datetime

Дата и время окончания события

DATE_FROM_TS_UTC
string

Дата и время начала события в UTC в формате timestamp

DATE_TO_TS_UTC
string

Дата и время окончания события в UTC в формате timestamp

~USER_OFFSET_FROM
integer

Смещение времени начала события относительно UTC в секундах

~USER_OFFSET_TO
integer

Смещение времени окончания события относительно UTC в секундах

DT_SKIP_TIME
integer

Флаг отображающий что событие длится целый день. Возможные значения:

  • Y — целый день
  • N — не целый день

TZ_FROM
integer

Таймзона даты начала события

TZ_TO
integer

Таймзона даты окончания события

ACCESSIBILITY
integer

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

  • busy — занят
  • absent — отсутствую
  • quest — под вопросом
  • free — свободен

IMPORTANCE
string

Важность события. Возможные значения:

  • high — высокая
  • normal — средняя
  • low— низкая

EVENT_TYPE
string

Некоторые события содержат информацию о способе создания.

Событие может быть создано через:

  • #shared# — слоты календаря
  • #shared_crm# — слоты CRM
  • #collab# — коллабу
  • #shared_collab# — слоты коллабы

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Не задан обязательный параметр \"from\" для метода \"calendar.accessibility.get\""
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Сообщение об ошибке

Описание

Пустое значение

Не задан обязательный параметр "from" для метода "calendar.accessibility.get"

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

Пустое значение

Не задан обязательный параметр "to" для метода "calendar.accessibility.get"

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

Пустое значение

Не задан обязательный параметр "users" для метода "calendar.accessibility.get"

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

Пустое значение

Доступ запрещен

Запрещен доступ к методу для внешних пользователей

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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