Установить настройки контроля времени timeman.timecontrol.settings.set
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
timemanКто может выполнять метод: администратор
Метод timeman.timecontrol.settings.set устанавливает настройки для модуля контроля времени.
Сбор данных контроля времени начинается с момента активации соответствующих настроек регистрации. Получить данные за период до активации невозможно — система не сохраняет историческую информацию ретроспективно.
Параметры метода
|
Название |
Описание |
|
ACTIVE |
Активировать модуль контроля времени. Возможные значения:
|
|
MINIMUM_IDLE_FOR_REPORT |
Минимальное время отсутствия в минутах, после которого требуется отчет |
|
REGISTER_OFFLINE |
Регистрировать офлайн статус |
|
REGISTER_IDLE |
Регистрировать статус Отошел |
|
REGISTER_DESKTOP |
Регистрировать статус десктоп приложения |
|
REPORT_REQUEST_TYPE |
Тип запроса отчетов. Возможные значения:
|
|
REPORT_REQUEST_USERS |
Массив идентификаторов пользователей, для которых требуется запрос отчетов. Заполняется, если |
|
REPORT_SIMPLE_TYPE |
Тип простого отчета. Возможные значения:
|
|
REPORT_SIMPLE_USERS |
Массив идентификаторов пользователей с доступом к простому отчету. Заполняется, если |
|
REPORT_FULL_TYPE |
Тип полного отчета. Возможные значения:
|
|
REPORT_FULL_USERS |
Массив идентификаторов пользователей с доступом к полному отчету. Заполняется, если |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ACTIVE":true,"MINIMUM_IDLE_FOR_REPORT":15,"REGISTER_OFFLINE":true,"REGISTER_IDLE":true,"REGISTER_DESKTOP":true,"REPORT_REQUEST_TYPE":"all","REPORT_SIMPLE_TYPE":"all","REPORT_FULL_TYPE":"all"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.timecontrol.settings.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ACTIVE":true,"MINIMUM_IDLE_FOR_REPORT":15,"REGISTER_OFFLINE":true,"REGISTER_IDLE":true,"REGISTER_DESKTOP":true,"REPORT_REQUEST_TYPE":"all","REPORT_SIMPLE_TYPE":"all","REPORT_FULL_TYPE":"all","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/timeman.timecontrol.settings.set
// 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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'timeman.timecontrol.settings.set',
params: {
ACTIVE: true,
MINIMUM_IDLE_FOR_REPORT: 15,
REGISTER_OFFLINE: true,
REGISTER_IDLE: true,
REGISTER_DESKTOP: true,
REPORT_REQUEST_TYPE: 'all',
REPORT_SIMPLE_TYPE: 'all',
REPORT_FULL_TYPE: 'all',
},
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('Settings saved:', 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 setTimeControlSettings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'timeman.timecontrol.settings.set',
params: {
ACTIVE: true,
MINIMUM_IDLE_FOR_REPORT: 15,
REGISTER_OFFLINE: true,
REGISTER_IDLE: true,
REGISTER_DESKTOP: true,
REPORT_REQUEST_TYPE: 'all',
REPORT_SIMPLE_TYPE: 'all',
REPORT_FULL_TYPE: 'all',
},
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('Settings saved:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setTimeControlSettings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.timeman.timecontrol.settings.set(
active=True,
minimum_idle_for_report=15,
register_offline=True,
register_idle=True,
register_desktop=True,
report_request_type="all",
report_simple_type="all",
report_full_type="all",
).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(
'timeman.timecontrol.settings.set',
[
'ACTIVE' => true,
'MINIMUM_IDLE_FOR_REPORT' => 15,
'REGISTER_OFFLINE' => true,
'REGISTER_IDLE' => true,
'REGISTER_DESKTOP' => true,
'REPORT_REQUEST_TYPE' => 'all',
'REPORT_SIMPLE_TYPE' => 'all',
'REPORT_FULL_TYPE' => 'all',
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting time control settings: ' . $e->getMessage();
}
BX24.callMethod(
'timeman.timecontrol.settings.set',
{
'ACTIVE': true,
'MINIMUM_IDLE_FOR_REPORT': 15,
'REGISTER_OFFLINE': true,
'REGISTER_IDLE': true,
'REGISTER_DESKTOP': true,
'REPORT_REQUEST_TYPE': 'all',
'REPORT_SIMPLE_TYPE': 'all',
'REPORT_FULL_TYPE': 'all'
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'timeman.timecontrol.settings.set',
[
'ACTIVE' => true,
'MINIMUM_IDLE_FOR_REPORT' => 15,
'REGISTER_OFFLINE' => true,
'REGISTER_IDLE' => true,
'REGISTER_DESKTOP' => true,
'REPORT_REQUEST_TYPE' => 'all',
'REPORT_SIMPLE_TYPE' => 'all',
'REPORT_FULL_TYPE' => 'all'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "timeman.timecontrol.settings.set", b24.Params{
"ACTIVE": true,
"MINIMUM_IDLE_FOR_REPORT": 15,
"REGISTER_OFFLINE": true,
"REGISTER_IDLE": true,
"REGISTER_DESKTOP": true,
"REPORT_REQUEST_TYPE": "all",
"REPORT_SIMPLE_TYPE": "all",
"REPORT_FULL_TYPE": "all",
})
if err != nil {
return fmt.Errorf("timeman.timecontrol.settings.set: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1748526089.625516,
"finish": 1748526089.656787,
"duration": 0.03127098083496094,
"processing": 0.008746147155761719,
"date_start": "2025-05-29T16:41:29+03:00",
"date_finish": "2025-05-29T16:41:29+03:00",
"operating_reset_at": 1748526689,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Результат выполнения. Возвращает |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_ERROR",
"error_description": "You don't have access to use this method"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
You don't have access to use this method |
У вас нет доступа к этому методу |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |