Приостановить текущий рабочий день timeman.pause

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

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

Scope: timeman

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

Метод timeman.pause приостанавливает текущий рабочий день.

Если рабочий день завершен, метод возобновит его и добавит в длительность время, которое прошло после завершения.

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

Название
тип

Описание

USER_ID
integer

Идентификатор пользователя.

По умолчанию — идентификатор текущего пользователя

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"USER_ID":503}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.pause
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"USER_ID":503,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/timeman.pause
// 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, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type TimemanPauseResult = {
  STATUS: string
  TIME_START: ISODate
  TIME_FINISH: ISODate | null
  DURATION: string
  TIME_LEAKS: string
  ACTIVE: boolean
  IP_OPEN: string
  IP_CLOSE: string
  LAT_OPEN: number
  LON_OPEN: number
  LAT_CLOSE: number
  LON_CLOSE: number
  TZ_OFFSET: number
  TIME_FINISH_DEFAULT?: ISODate
}

try {
  const response = await $b24.actions.v2.call.make<TimemanPauseResult>({
    method: 'timeman.pause',
    params: {
      USER_ID: 503,
    },
    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('Status:', result.STATUS, 'Start:', result.TIME_START)
  }
} 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 pauseWorkday() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'timeman.pause',
        params: {
          USER_ID: 503,
        },
        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('Status:', result.STATUS, 'Start:', result.TIME_START)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.timeman.pause(user_id=503).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.pause',
            [
                'USER_ID' => 503
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
    echo 'Info: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error calling timeman.pause: ' . $e->getMessage();
}
BX24.callMethod(
    'timeman.pause',
    {
        'USER_ID' : 503
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'timeman.pause',
    [
        'USER_ID' => 503
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "timeman.pause", b24.Params{
	"USER_ID": 503,
})
if err != nil {
	return fmt.Errorf("timeman.pause: %w", err)
}

var item struct {
	Status    string `json:"STATUS"`
	TimeStart string `json:"TIME_START"`
	Duration  string `json:"DURATION"`
	TimeLeaks string `json:"TIME_LEAKS"`
	Active    bool   `json:"ACTIVE"`
	IPOpen    string `json:"IP_OPEN"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Status, item.TimeStart)

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

HTTP-статус: 200

{
    "result": {
        "STATUS": "PAUSED",
        "TIME_START": "2025-03-27T08:00:01+02:00",
        "TIME_FINISH": null,
        "DURATION": "00:00:00",
        "TIME_LEAKS": "00:00:00",
        "ACTIVE": false,
        "IP_OPEN": "",
        "IP_CLOSE": "",
        "LAT_OPEN": 53.548841000000003,
        "LON_OPEN": 9.9872739999999993,
        "LAT_CLOSE": 0,
        "LON_CLOSE": 0,
        "TZ_OFFSET": 7200
    },
    "time": {
        "start": 1743057425.9403241,
        "finish": 1743057426.0597129,
        "duration": 0.11938881874084473,
        "processing": 0.08620214462280273,
        "date_start": "2025-03-27T09:37:05+03:00",
        "date_finish": "2025-03-27T09:37:06+03:00",
        "operating_reset_at": 1743058025,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Корневой элемент ответа.

Содержит объект с описанием рабочего дня

STATUS
string

Статус текущего рабочего дня.

Варианты значений:

  • OPENED — открыт
  • CLOSED — закрыт
  • PAUSED — приостановлен
  • EXPIRED — истек, то есть открыт до начала текущих календарных суток и не закрыт

TIME_START
datetime

Дата и время начала рабочего дня.

Часовой пояс соответствует часовому поясу начала рабочего дня

TIME_FINISH
datetime

Дата и время завершения рабочего дня.

Для незавершенного рабочего дня возвращается null

DURATION
string

Длительность рабочего дня в формате HH:MM:SS.

Для незавершенного рабочего дня возвращается 00:00:00

TIME_LEAKS
string

Суммарная длительность перерыва за день в формате HH:MM:SS

ACTIVE
boolean

Подтвержденность рабочего дня.

Значение false означает, что изменение рабочего дня ожидает подтверждения руководителем

IP_OPEN
string

IP-адрес, с которого начат рабочий день

IP_CLOSE
string

IP-адрес, с которого завершен рабочий день.

Для незавершенного рабочего дня возвращается null

LAT_OPEN
double

Географическая широта точки начала рабочего дня

LON_OPEN
double

Географическая долгота точки начала рабочего дня

LAT_CLOSE
double

Географическая широта точки завершения рабочего дня

LON_CLOSE
double

Географическая долгота точки завершения рабочего дня

TZ_OFFSET
integer

Смещение часового пояса сотрудника в котором начат рабочий день.

Время завершения рабочего дня приводится к часовому поясу начала дня

TIME_FINISH_DEFAULT
datetime

Рекомендуемое значение завершения дня, которое можно выводить пользователю в качестве значения по умолчанию.

Выводится только для рабочих дней в статусе истек EXPIRED

time
time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error":"",
    "error_description":"User not found"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

TIMEMAN_TOOL_DISABLED

Учет рабочего времени отключен.

Инструмент Учет рабочего времени отключен

пустая строка

User not found

Пользователь с указанным USER_ID не найден

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

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

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

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