Получить занятость пользователей из списка calendar.accessibility.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
calendarКто может выполнять метод: любой пользователь
Метод получает занятость пользователей из списка.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
users* |
Массив идентификаторов пользователей |
|
from* |
Дата начала периода для определения занятости в формате Например, |
|
to* |
Дата окончания периода для определения занятости в формате Например, |
Примеры кода
Как использовать примеры в документации
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>
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>';
Обработка ответа
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 |
Результат содержит объект. Ключ объекта — это идентификатор пользователя из запроса. Значение — массив объектов, каждый из которых описывает событие, в котором занят пользователь в указанный период |
Объект события
|
Название |
Описание |
|
ID |
Идентификатор события |
|
NAME |
Название события |
|
DATE_FROM |
Дата и время начала события |
|
DATE_TO |
Дата и время окончания события |
|
DATE_FROM_TS_UTC |
Дата и время начала события в UTC в формате timestamp |
|
DATE_TO_TS_UTC |
Дата и время окончания события в UTC в формате timestamp |
|
~USER_OFFSET_FROM |
Смещение времени начала события относительно UTC в секундах |
|
~USER_OFFSET_TO |
Смещение времени окончания события относительно UTC в секундах |
|
DT_SKIP_TIME |
Флаг отображающий что событие длится целый день. Возможные значения:
|
|
TZ_FROM |
Таймзона даты начала события |
|
TZ_TO |
Таймзона даты окончания события |
|
ACCESSIBILITY |
Доступность участников события. Возможные значения:
|
|
IMPORTANCE |
Важность события. Возможные значения:
|
|
EVENT_TYPE |
Некоторые события содержат информацию о способе создания. Событие может быть создано через:
|
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Не задан обязательный параметр "from" для метода "calendar.accessibility.get""
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Сообщение об ошибке |
Описание |
|
Пустая строка |
Не задан обязательный параметр "from" для метода "calendar.accessibility.get" |
Не передан обязательный параметр |
|
Пустая строка |
Не задан обязательный параметр "to" для метода "calendar.accessibility.get" |
Не передан обязательный параметр |
|
Пустая строка |
Не задан обязательный параметр "users" для метода "calendar.accessibility.get" |
Не передан обязательный параметр |
|
Пустая строка |
Доступ запрещен |
Запрещен доступ к методу для внешних пользователей |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |