Сохранить полученное согласие пользователя userconsent.consent.add
Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.
Scope:
userconsentКто может выполнять метод: любой пользователь
Метод userconsent.consent.add сохраняет полученное согласие пользователя.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
AGREEMENT_ID* |
Идентификатор соглашения. Идентификатор можно получить с помощью метода userconsent.agreement.list |
|
IP* |
IP-адрес пользователя |
|
USER_ID |
Идентификатор пользователя. Идентификатор можно получить с помощью методов user.get и user.search |
|
URL |
URL страницы, где было получено согласие |
|
ORIGIN_ID |
Идентификатор источника, например, |
|
ORIGINATOR_ID |
Идентификатор элемента в источнике, например, e-mail |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"AGREEMENT_ID":19,"USER_ID":123,"IP":"192.168.1.100","URL":"https://example.com/contact-form","ORIGIN_ID":"my_contact_form","ORIGINATOR_ID":"user@example.com"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userconsent.consent.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"AGREEMENT_ID":19,"USER_ID":123,"IP":"192.168.1.100","URL":"https://example.com/contact-form","ORIGIN_ID":"my_contact_form","ORIGINATOR_ID":"user@example.com","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/userconsent.consent.add
try
{
const response = await $b24.callMethod(
'userconsent.consent.add',
{
AGREEMENT_ID: 19,
USER_ID: 123,
IP: '192.168.1.100',
URL: 'https://example.com/contact-form',
ORIGIN_ID: 'my_contact_form',
ORIGINATOR_ID: 'user@example.com'
}
);
const result = response.getData().result;
console.log('Created element with ID:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'userconsent.consent.add',
[
'AGREEMENT_ID' => 19,
'USER_ID' => 123,
'IP' => '192.168.1.100',
'URL' => 'https://example.com/contact-form',
'ORIGIN_ID' => 'my_contact_form',
'ORIGINATOR_ID' => 'user@example.com'
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding consent: ' . $e->getMessage();
}
BX24.callMethod(
'userconsent.consent.add',
{
AGREEMENT_ID: 19,
USER_ID: 123,
IP: "192.168.1.100",
URL: "https://example.com/contact-form",
ORIGIN_ID: "my_contact_form",
ORIGINATOR_ID: "user@example.com"
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'userconsent.consent.add',
[
'AGREEMENT_ID' => 19,
'USER_ID' => 123,
'IP' => '192.168.1.100',
'URL' => 'https://example.com/contact-form',
'ORIGIN_ID' => 'my_contact_form',
'ORIGINATOR_ID' => 'user@example.com'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": 525,
"time": {
"start": 1760459630,
"finish": 1760459630.700988,
"duration": 0.7009880542755127,
"processing": 0,
"date_start": "2025-10-14T19:33:50+03:00",
"date_finish": "2025-10-14T19:33:50+03:00",
"operating_reset_at": 1760460230,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор добавленного согласия |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":"400",
"error_description":"Parameter `Agreement ID` required."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Parameter |
Параметр |
|
|
|
Agreement with id |
Соглашение с указанным |
|
|
|
— |
Невалидный формат IP-адреса |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список соглашений userconsent.agreement.list
- Получить текст соглашения userconsent.agreement.text