Включить или выключить публичную ссылку на документ crm.documentgenerator.document.enablepublicurl

Scope: crm

Кто может выполнять метод: пользователь с правом "изменения" документов генератора документов

Метод crm.documentgenerator.document.enablepublicurl включает или выключает публичную ссылку на документ.

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

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

Название
тип

Описание

id*
integer

Идентификатор документа

status
integer

Режим публичной ссылки:

  • 1 — включить
  • 0 — выключить

По умолчанию: 1

Примеры кода

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

Пример включает публичную ссылку для документа 61.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":61,"status":1}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.enablepublicurl
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":61,"status":1,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.enablepublicurl
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.document.enablepublicurl',
        		{
        			id: 61,
        			status: 1,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.document.enablepublicurl',
                    [
                        'id' => 61,
                        'status' => 1,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error enabling public URL: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.documentgenerator.document.enablepublicurl',
            {
                id: 61,
                status: 1,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.enablepublicurl',
            [
                'id' => 61,
                'status' => 1,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "publicUrl": "https://bitrix.bitrix24.ru/~71q5j"
            },
            "time": {
                "start": 1774011939,
                "finish": 1774011939.899233,
                "duration": 0.8992331027984619,
                "processing": 0,
                "date_start": "2026-03-20T16:05:39+03:00",
                "date_finish": "2026-03-20T16:05:39+03:00",
                "operating_reset_at": 1774012539,
                "operating": 0.3236720561981201
            }
        }

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

Название
тип

Описание

result
object

Корневой объект ответа. Содержит структуру result

time
time

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

Тип result

Название
тип

Описание

publicUrl
string | null

Публичная ссылка на документ. При status = 0 возвращается null

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

HTTP-статус: 400

{
            "error": "0",
            "error_description": "Документ не найден"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

100

Bitrix\DocumentGenerator\Document constructor must be is public

Не передан обязательный параметр id

DOCGEN_ACCESS_ERROR

Access denied

Нет доступа к документу

0

Документ не найден

Документ с указанным id не найден

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

Document not found

Документ не относится к модулю crm

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

You do not have permissions to modify this document

Недостаточно прав для изменения документа

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

You do not have permissions to view documents

Недостаточно прав для просмотра документов генератора

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

Module documentgenerator is not installed

Модуль documentgenerator недоступен

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

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

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

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

Предыдущая
Удалить документ
Следующая
Загрузить сформированный документ и прикрепить его к указанному CRM-объекту