Сбросить параметры карточки crm.contact.details.configuration.reset
Scope:
crmКто может выполнять метод:
- Любой пользователь имеет право получать свои и общие настройки
- Только администратор имеет право получать чужие настройки
DEPRECATED
Развитие метода остановлено. Используйте crm.item.details.configuration.reset.
Метод сбрасывает настройки карточки контактов: удаляет личные настройки карточки указанного пользователя или общие настройки, заданные для всех пользователей.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
scope |
Область применения настроек. Возможные значения:
По умолчанию — |
|
userId |
Идентификатор пользователя. Нужен только при сбросе личных настроек. Если не задан, то берется |
Примеры кода
Как использовать примеры в документации
-
Сбросить общую конфигурацию
cURL (Webhook)cURL (OAuth)JSPHPcurl -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.resetcurl -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.resetBX24.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>'; -
Сбросить личную конфигурацию
cURL (Webhook)cURL (OAuth)JSPHPcurl -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.resetcurl -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.resetBX24.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 |
Корневой элемент ответа. Возвращает |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
Пустое значение |
Access denied. |
У пользователя нет административных прав |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Управление карточками контактов: обзор методов
- Получить параметры карточки crm.contact.details.configuration.get
- Установить параметры индивидуальной карточки crm.contact.details.configuration.set
- Установить общую карточку для всех пользователей crm.contact.details.configuration.forceCommonScopeForAll