calendar.user.settings.get
Получить пользовательские настройки календаря
Описание
Метод получает пользовательские настройки календаря.
Без параметров.
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.user.settings.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.user.settings.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
// Shape of the payload returned in result (match the "response handling" section of the page)
type CalendarUserSettingsResult = {
view: string
meetSection: string
crmSection: string
showDeclined: boolean
denyBusyInvitation: boolean
collapseOffHours: string
showWeekNumbers: string
showTasks: string
syncTasks: string
showCompletedTasks: string
lastUsedSection: string
sendFromEmail: string
defaultSections: Record<string, string>
syncPeriodPast: string
syncPeriodFuture: string
defaultReminders: {
fullDay: Array<{ type: string; count: number }>
withTime: Array<{ type: string; count: number }>
}
timezoneName: string
timezoneOffsetUTC: number
timezoneDefaultName: string
work_time_start: string
work_time_end: string
}
try {
const response = await $b24.actions.v2.call.make<CalendarUserSettingsResult>({
method: 'calendar.user.settings.get',
params: {},
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(result.view, result.timezoneName, result.defaultReminders)
}
} 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 getCalendarUserSettings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'calendar.user.settings.get',
params: {},
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(result.view, result.timezoneName, result.defaultReminders)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getCalendarUserSettings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.calendar.user.settings.get().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.user.settings.get',
[]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting user calendar settings: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.user.settings.get',
{}
);
require_once('crest.php');
$result = CRest::call(
'calendar.user.settings.get',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "calendar.user.settings.get", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("calendar.user.settings.get: %w", err)
}
var item struct {
View string `json:"view"`
MeetSection string `json:"meetSection"`
CrmSection string `json:"crmSection"`
ShowDeclined bool `json:"showDeclined"`
DenyBusyInvitation bool `json:"denyBusyInvitation"`
CollapseOffHours string `json:"collapseOffHours"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.View, item.MeetSection)
Ответ
HTTP-статус: 200
{
"result": {
"view": "month",
"meetSection": "4",
"crmSection": "4",
"showDeclined": true,
"denyBusyInvitation": false,
"collapseOffHours": "N",
"showWeekNumbers": "N",
"showTasks": "Y",
"syncTasks": "N",
"showCompletedTasks": "N",
"lastUsedSection": "false",
"sendFromEmail": "",
"defaultSections": {
"user1": "4",
"group6": "49"
},
"syncPeriodPast": "3",
"syncPeriodFuture": "12",
"defaultReminders": {
"fullDay": [
{
"type": "min",
"count": 15
}
],
"withTime": [
{
"type": "min",
"count": 50
}
]
},
"timezoneName": "Europe/Riga",
"timezoneOffsetUTC": 7200,
"timezoneDefaultName": "",
"work_time_start": "9.00",
"work_time_end": "19.00"
},
"time": {
"start": 1734434829.455204,
"finish": 1734434829.797482,
"duration": 0.34227800369262695,
"processing": 0.0038161277770996094,
"date_start": "2024-12-17T11:27:09+00:00",
"date_finish": "2024-12-17T11:27:09+00:00"
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
view
string
Стандартное представление для календаря. Возможные значения:
- day — день
- week — неделя
- month — месяц
- list — список
meetSection
string
Календарь для приглашений
crmSection
string
Календарь для CRM
showDeclined
boolean
Показывать события, в которых пользователь отказался принять участие
denyBusyInvitation
boolean
Запрещать приглашать в событие, если время занято
collapseOffHours
string
Скрывать нерабочее время в календаре в недельном и дневном представлении. Возможные значения:
- Y — скрывать
- N — не скрывать
showWeekNumbers
string
Показывать номер недель. Возможные значения:
- Y — показывать
- N — не показывать
showTasks
string
Отображать задачи в календаре. Возможные значения:
- Y — отображать
- N — не отображать
syncTasks
string
Синхронизировать календарь задач. Возможные значения:
- Y — да
- N — нет
showCompletedTasks
string
Отображать завершенные задачи. Возможные значения:
- Y — отображать
- N — не отображать
lastUsedSection
string
Идентификатор календаря, который используется при создании событий, если в параметрах не передан идентификатор календаря.
Значение по умолчанию — false
sendFromEmail
string
E-mail для отправки почтовых приглашений
defaultSections
object
Настройки предустановленных календарей.
Ключем объекта настроек может быть:
- user[id] — тип Календарь пользователя c идентификатором пользователя. Например, user12 соответствует календарю пользователя с идентификатором 12
- group[id] — тип Календарь группы с идентификатором группы. Например, group36 соответствует календарю группы с идентификатором 36
Значением объекта является идентификатор календаря
syncPeriodPast
string
Количество месяцев для синхронизации в прошлом периоде
syncPeriodFuture
string
Количество месяцев для синхронизации в будущем периоде
defaultReminders
object
Объект со стандартными настройками напоминаний о событии
timezoneName
string
Таймзона календаря
timezoneOffsetUTC
integer
Смешение таймзоны относительно UTC в секундах
timezoneDefaultName
string
Если параметр timezoneName не установлен, здесь будет указан часовой пояс из параметра timezoneOffsetUTC
work_time_start
string
Время начала рабочего дня
work_time_end
string
Время окончания рабочего дня

