Определить текущий режим работы CRM crm.settings.mode.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Название метода: crm.settings.mode.get
Scope:
crmКто может выполнять метод:
любой пользователь
Метод возвращает текущие настройки режима работы CRM: классический режим CRM (с лидами) или простой режим CRM (без лидов).
Этот режим влияет на целый ряд сценариев работы CRM и для лучшего понимания мы рекомендуем прочитать соответствующую статью пользовательской документации.
Параметры метода
Метод вызывается без параметров.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.settings.mode.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/crm.settings.mode.get
try
{
const response = await $b24.callMethod(
'crm.settings.mode.get',
{}
);
const result = response.getData().result;
console.dir(result);
}
catch( error )
{
console.error('Error:', error);
}
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.settings.mode.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(
'crm.settings.mode.get',
[]
);
$result = $response
->getResponseData()
->getResult();
echo 'CRM mode: ' . $result;
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting CRM settings mode: ' . $e->getMessage();
}
BX24.callMethod("crm.settings.mode.get", {}, result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
});
require_once('crest.php');
$result = CRest::call(
'crm.settings.mode.get',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.settings.mode.get", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.settings.mode.get: %w", err)
}
var value b24.ID
if err := json.Unmarshal(res.Result, &value); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("результат:", value)
Обработка ответа
HTTP-статус: 200
{
"result": 1,
"time": {
"start": 1715091541.642592,
"finish": 1715091541.730599,
"duration": 0.08800697326660156,
"date_start": "2024-05-03T17:19:01+03:00",
"date_finish": "2024-05-03T17:19:01+03:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор текущего режима работы CRM. Возможные значения описаны ниже |
|
time |
Информация о времени выполнения запроса |
Возможные значения result
|
Значение |
Режим |
Описание |
|
|
Классический |
CRM работает с лидами |
|
|
Простой |
CRM работает без лидов: новые обращения сразу становятся сделками и контактами или компаниями |
Актуальный список режимов и их названия возвращает метод crm.enum.settings.mode.
Обработка ошибок
HTTP-статус: 401
{
"error": "insufficient_scope",
"error_description": "The request requires higher privileges than provided by the webhook token"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Недостаточно скоупа у токена |
Токен не содержит скоуп |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |