Получить текст соглашения userconsent.agreement.text
Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.
Scope:
userconsentКто может выполнять метод: любой пользователь
Метод userconsent.agreement.text возвращает текст соглашения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор соглашения. Идентификатор можно получить с помощью метода userconsent.agreement.list |
|
replace |
Массив замен для подстановки текста. Доступные ключи:
Список доступных полей описан ниже Подстановка выполняется только для стандартных соглашений, созданных на основе шаблонов. Для пользовательских соглашений с произвольным HTML-текстом параметр игнорируется |
Параметр fields
|
Название |
Описание |
|
COMPANY_NAME |
Название компании |
|
COMPANY_ADDRESS |
Адрес компании |
|
PURPOSES |
Цель обработки данных |
|
THIRD_PARTIES |
Третьи лица, которым передаются данные |
|
EMAIL |
Адрес электронной почты |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":19,"replace":{"button_caption":"Я согласен","fields":{"COMPANY_NAME":"ООО Пример","COMPANY_ADDRESS":"г. Москва, ул. Примерная, д. 1","PURPOSES":"Обработка персональных данных для улучшения сервиса","THIRD_PARTIES":"Партнеры компании для аналитики","EMAIL":"info@example.com"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userconsent.agreement.text
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":19,"replace":{"button_caption":"Я согласен","fields":{"COMPANY_NAME":"ООО Пример","COMPANY_ADDRESS":"г. Москва, ул. Примерная, д. 1","PURPOSES":"Обработка персональных данных для улучшения сервиса","THIRD_PARTIES":"Партнеры компании для аналитики","EMAIL":"info@example.com"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/userconsent.agreement.text
try {
const response = await $b24.callMethod(
'userconsent.agreement.text',
{
id: 19,
replace: {
button_caption: 'Я согласен',
fields: {
COMPANY_NAME: 'ООО Пример',
COMPANY_ADDRESS: 'г. Москва, ул. Примерная, д. 1',
PURPOSES: 'Обработка персональных данных для улучшения сервиса',
THIRD_PARTIES: 'Партнеры компании для аналитики',
EMAIL: 'info@example.com'
}
}
}
);
const result = response.getData().result;
console.log('Result:', result);
processResult(result);
} catch (error) {
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'userconsent.agreement.text',
[
'id' => 19,
'replace' => [
'button_caption' => 'Я согласен',
'fields' => [
'COMPANY_NAME' => 'ООО Пример',
'COMPANY_ADDRESS' => 'г. Москва, ул. Примерная, д. 1',
'PURPOSES' => 'Обработка персональных данных для улучшения сервиса',
'THIRD_PARTIES' => 'Партнеры компании для аналитики',
'EMAIL' => 'info@example.com'
]
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'userconsent.agreement.text',
{
id: 19,
replace: {
button_caption: "Я согласен",
fields: {
COMPANY_NAME: "ООО Пример",
COMPANY_ADDRESS: "г. Москва, ул. Примерная, д. 1",
PURPOSES: "Обработка персональных данных для улучшения сервиса",
THIRD_PARTIES: "Партнеры компании для аналитики",
EMAIL: "info@example.com"
}
}
},
function(result) {
if(result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'userconsent.agreement.text',
[
'id' => 19,
'replace' => [
'button_caption' => 'Я согласен',
'fields' => [
'COMPANY_NAME' => 'ООО Пример',
'COMPANY_ADDRESS' => 'г. Москва, ул. Примерная, д. 1',
'PURPOSES' => 'Обработка персональных данных для улучшения сервиса',
'THIRD_PARTIES' => 'Партнеры компании для аналитики',
'EMAIL' => 'info@example.com'
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"LABEL": "Нажимая кнопку «Я согласен», я даю свое согласие на обработку моих персональных данных, в соответствии с Федеральным законом от 27.07.2006 года №152-ФЗ «О персональных данных», на условиях и для целей, определенных в Согласии на обработку персональных данных",
"TEXT": "Согласие на обработку персональных данных\n\nНастоящим в соответствии с Федеральным законом № 152-ФЗ «О персональных данных» от 27.07.2006 года свободно, своей волей и в своем интересе выражаю свое безусловное согласие на обработку моих персональных данных , зарегистрированным в соответствии с законодательством РФ по адресу: \n (далее по тексту - Оператор).\n1. Согласие дается на обработку одной, нескольких или всех категорий персональных данных, не являющихся специальными или биометрическими, предоставляемых мною, которые могут включать:\n\n- ООО Пример;\n- г. Москва, ул. Примерная, д. 1;\n- Обработка персональных данных для улучшения сервиса;\n- Партнеры компании для аналитики;\n- info@example.com.\n\n2. Оператор может совершать следующие действия: сбор; запись; систематизация; накопление; хранение; уточнение (обновление, изменение); извлечение; использование; блокирование; удаление; уничтожение. \n\n3. Способы обработки: как с использованием средств автоматизации, так и без их использования.\n\n4. Цель обработки: предоставление мне услуг/работ, включая, направление в мой адрес уведомлений, касающихся предоставляемых услуг/работ, подготовка и направление ответов на мои запросы, направление в мой адрес информации о мероприятиях/товарах/услугах/работах Оператора.\n\n5. В связи с тем, что Оператор может осуществлять обработку моих персональных данных посредством программы для ЭВМ «1С-Битрикс24», я даю свое согласие Оператору на осуществление соответствующего поручения ООО «1С-Битрикс», (ОГРН 5077746476209), зарегистрированному по адресу: 109544, г. Москва, б-р Энтузиастов, д. 2, эт.13, пом. 8-19.\n\n6. Настоящее согласие действует до момента его отзыва путем направления соответствующего уведомления на электронный адрес kalashnikova@bitrix.ru или направления по адресу .\n\n7. В случае отзыва мною согласия на обработку персональных данных Оператор вправе продолжить обработку персональных данных без моего согласия при наличии оснований, предусмотренных Федеральным законом №152-ФЗ «О персональных данных» от 27.07.2006 г."
},
"time": {
"start": 1760611223,
"finish": 1760611223.240694,
"duration": 0.2406940460205078,
"processing": 0,
"date_start": "2025-10-16T13:40:23+03:00",
"date_finish": "2025-10-16T13:40:23+03:00",
"operating_reset_at": 1760611823,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
LABEL |
Заголовок соглашения |
|
TEXT |
Текст соглашения |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":"400",
"error_description":"Parameter `Agreement ID` required."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Parameter |
Параметр |
|
|
|
Agreement with id |
Соглашение с указанным |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список соглашений userconsent.agreement.list
- Сохранить полученное согласие пользователя userconsent.consent.add