Сбросить параметры карточки crm.contact.details.configuration.reset

Scope: crm

Кто может выполнять метод:

  • Любой пользователь имеет право получать свои и общие настройки
  • Только администратор имеет право получать чужие настройки

DEPRECATED

Развитие метода остановлено. Используйте crm.item.details.configuration.reset.

Метод сбрасывает настройки карточки контактов: удаляет личные настройки карточки указанного пользователя или общие настройки, заданные для всех пользователей.

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

Обязательные параметры отмечены *

Название
тип

Описание

scope
string

Область применения настроек.

Возможные значения:

  • P — личные настройки
  • C — общие настройки

По умолчанию — P

userId
user

Идентификатор пользователя. Нужен только при сбросе личных настроек.

Если не задан, то берется id текущего пользователя

Примеры кода

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

  1. Сбросить общую конфигурацию

    curl -X POST \
            -H "Content-Type: application/json" \
            -H "Accept: application/json" \
            -d '{"scope":"C"}' \
            https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.details.configuration.reset
            
    curl -X POST \
            -H "Content-Type: application/json" \
            -H "Accept: application/json" \
            -d '{"scope":"C","auth":"**put_access_token_here**"}' \
            https://**put_your_bitrix24_address**/rest/crm.contact.details.configuration.reset
            
    BX24.callMethod(
                'crm.contact.details.configuration.reset',
                {
                    scope: "C",
                },
                (result) => {
                    result.error()
                        ? console.error(result.error())
                        : console.info(result.data())
                    ;
                },
            );
            
    require_once('crest.php');
            
            $result = CRest::call(
                'crm.contact.details.configuration.reset',
                [
                    'scope' => 'C'
                ]
            );
            
            echo '<PRE>';
            print_r($result);
            echo '</PRE>';
            
  2. Сбросить личную конфигурацию

    curl -X POST \
            -H "Content-Type: application/json" \
            -H "Accept: application/json" \
            -d '{"scope":"P","userId":6}' \
            https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.details.configuration.reset
            
    curl -X POST \
            -H "Content-Type: application/json" \
            -H "Accept: application/json" \
            -d '{"scope":"P","userId":6,"auth":"**put_access_token_here**"}' \
            https://**put_your_bitrix24_address**/rest/crm.contact.details.configuration.reset
            
    BX24.callMethod(
                'crm.contact.details.configuration.reset',
                {
                    scope: "P",
                    userId: 6,
                },
                (result) => {
                    result.error()
                        ? console.error(result.error())
                        : console.info(result.data())
                    ;
                },
            );
            
    require_once('crest.php');
            
            $result = CRest::call(
                'crm.contact.details.configuration.reset',
                [
                    'scope' => 'P',
                    'userId' => 6
                ]
            );
            
            echo '<PRE>';
            print_r($result);
            echo '</PRE>';
            

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1724682584.069094,
                "finish": 1724682584.38436,
                "duration": 0.31526613235473633,
                "processing": 0.025727033615112305,
                "date_start": "2024-08-26T16:29:44+02:00",
                "date_finish": "2024-08-26T16:29:44+02:00",
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
boolean

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

Возвращает true в случае успешного сброса настроек

time
time

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

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Access denied."
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

Пустое значение

Access denied.

У пользователя нет административных прав

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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

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