Получить документ sign.b2e.document.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Кто может выполнять метод: пользователь с правом просмотра документов КЭДО
Метод sign.b2e.document.get возвращает информацию о документе и участниках подписания.
Метод работает только в контексте авторизации приложения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
uid |
Уникальный идентификатор документа |
|
language |
Язык локализации статусов в ответе. По умолчанию |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"uid":"b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sign.b2e.document.get
// 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 DocumentGetResult = {
uid: string
state: {
code: string
name: string
}
members: {
uid: string
role: string
party: number
user: {
employeeCode: string
employeeId: number
userId: number
}
state: {
code: string
name: string
}
}[]
}
try {
const response = await $b24.actions.v2.call.make<DocumentGetResult>({
method: 'sign.b2e.document.get',
params: {
uid: 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
language: 'ru',
},
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.uid, result.state.code, result.members.length)
}
} 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 getDocument() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sign.b2e.document.get',
params: {
uid: 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
language: 'ru',
},
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.uid, result.state.code, result.members.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDocument)
</script>
try {
$response = $b24Service
->core
->call(
'sign.b2e.document.get',
[
'uid' => 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
'language' => 'ru'
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'sign.b2e.document.get',
{
uid: 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
language: 'ru'
},
result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sign.b2e.document.get',
[
'uid' => 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
'language' => 'ru'
]
);
if (isset($result['error'])) {
echo 'Ошибка: ' . $result['error_description'];
} else {
echo '<PRE>';
print_r($result['result']);
echo '</PRE>';
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"uid": "b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c",
"state": {
"code": "in_progress",
"name": "В процессе"
},
"members": [
{
"uid": "f1c2d3e4",
"role": "signer",
"party": 0,
"user": {
"employeeCode": "EMP-001",
"employeeId": 123,
"userId": 25
},
"state": {
"code": "signed",
"name": "Подписано"
}
}
]
},
"time": {
"start": 1739860000.123,
"finish": 1739860000.456,
"duration": 0.333,
"processing": 0.111,
"date_start": "2025-02-18T09:19:34+03:00",
"date_finish": "2025-02-18T09:19:34+03:00",
"operating_reset_at": 1739860600,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Информация о документе и участниках подписания |
|
time |
Информация о времени выполнения запроса |
Поля объекта result
|
Название |
Описание |
|
uid |
Уникальный идентификатор документа |
|
state |
Текущий статус документа |
|
members |
Участники подписания |
Поля объекта result.state
|
Название |
Описание |
|
code |
Код статуса |
|
name |
Название статуса |
Элемент массива result.members
|
Название |
Описание |
|
uid |
Уникальный идентификатор участника |
|
role |
Роль участника |
|
party |
Сторона подписания |
|
user |
Данные пользователя |
|
state |
Статус участника |
Поля объекта result.members.user
|
Название |
Описание |
|
employeeCode |
Код сотрудника в HCM Link. Возвращается только для компании, связанной с HCM Link |
|
employeeId |
Идентификатор сотрудника в HCM Link. Возвращается только для компании, связанной с HCM Link |
|
userId |
Идентификатор пользователя в Битрикс24 |
Поля объекта result.members.state
|
Название |
Описание |
|
code |
Код статуса участника |
|
name |
Название статуса участника |
Обработка ошибок
HTTP-статус: 200
{
"error": "ACCESS_DENIED",
"error_description": "Access denied!"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Когда возникает |
|
|
Access denied! |
Недостаточно прав |
|
|
Current authorization type is denied for this method |
Вызов не из контекста приложения |
|
|
Internal error |
Ошибка при формировании ответа |
|
|
Document UID is required |
Не передан параметр |
|
|
Document not found |
Документ с указанным |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |