Сохранить полученное согласие пользователя userconsent.consent.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: userconsent

Кто может выполнять метод: любой пользователь

Метод userconsent.consent.add сохраняет полученное согласие пользователя.

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

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

Название
тип

Описание

AGREEMENT_ID*
integer

Идентификатор соглашения.

Идентификатор можно получить с помощью метода userconsent.agreement.list

IP*
string

IP-адрес пользователя

USER_ID
integer

Идентификатор пользователя.

Идентификатор можно получить с помощью методов user.get и user.search

URL
string

URL страницы, где было получено согласие

ORIGIN_ID
string

Идентификатор источника, например, my_contact_form

ORIGINATOR_ID
string

Идентификатор элемента в источнике, например, 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
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'userconsent.consent.add',
            params: {
              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',
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Created consent with ID:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addConsent() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'userconsent.consent.add',
                params: {
                  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',
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Created consent with ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addConsent)
        </script>
        
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
integer

Идентификатор добавленного согласия

time
time

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

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

HTTP-статус: 400

{
            "error":"400",
            "error_description":"Parameter `Agreement ID` required."
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

400

ERROR_ARGUMENT

Parameter Agreement ID required

Параметр AGREEMENT_ID не передан

400

ERROR_ARGUMENT

Agreement with id 999 not found

Соглашение с указанным ID не найдено

400

ERROR_ARGUMENT

Невалидный формат IP-адреса

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

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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