метод REST
scope: crm
crm.documentgenerator.document.enablepublicurl
Включить или выключить публичную ссылку на документ
Описание
Метод crm.documentgenerator.document.enablepublicurl включает или выключает публичную ссылку на документ.
Параметры
id
integer
необязательный
Идентификатор документа
status
integer
необязательный
Режим публичной ссылки:
1— включить0— выключить
По умолчанию: 1
Примеры запроса
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
// 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
// Shape of the payload returned in result (match the "response handling" section of the page)
type EnablePublicUrlResult = {
publicUrl: string | null
}
try {
const response = await $b24.actions.v2.call.make<EnablePublicUrlResult>({
method: 'crm.documentgenerator.document.enablepublicurl',
params: {
id: 61,
status: 1,
},
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(result.publicUrl)
}
} 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 enablePublicUrl() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.documentgenerator.document.enablepublicurl',
params: {
id: 61,
status: 1,
},
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(result.publicUrl)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', enablePublicUrl)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.documentgenerator.document.enablepublicurl(
bitrix_id=61,
status=1,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.documentgenerator.document.enablepublicurl", b24.Params{
"id": 61,
"status": 1,
})
if err != nil {
return fmt.Errorf("crm.documentgenerator.document.enablepublicurl: %w", err)
}
var item struct {
PublicUrl string `json:"publicUrl"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.PublicUrl)
Ответ
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
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"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 недоступен |

