Получить документ sign.b2e.document.get

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: sign.b2e, crm

Кто может выполнять метод: пользователь с правом просмотра документов КЭДО

Метод sign.b2e.document.get возвращает информацию о документе и участниках подписания.

Метод работает только в контексте авторизации приложения.

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

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

Название
тип

Описание

uid
string

Уникальный идентификатор документа

language
string

Язык локализации статусов в ответе.

По умолчанию en

Примеры кода

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

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
        
try
        {
        	const response = await $b24.callMethod(
        		'sign.b2e.document.get',
        		{
        			uid: 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
        			language: 'ru'
        		}
        	);
        
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
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
object

Информация о документе и участниках подписания

time
time

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

Поля объекта result

Название
тип

Описание

uid
string

Уникальный идентификатор документа

state
object

Текущий статус документа

members
array

Участники подписания

Поля объекта result.state

Название
тип

Описание

code
string

Код статуса

name
string

Название статуса

Элемент массива result.members

Название
тип

Описание

uid
string

Уникальный идентификатор участника

role
string

Роль участника

party
integer

Сторона подписания

user
object

Данные пользователя

state
object

Статус участника

Поля объекта result.members.user

Название
тип

Описание

employeeCode
string

Код сотрудника в HCM Link.

Возвращается только для компании, связанной с HCM Link

employeeId
integer

Идентификатор сотрудника в HCM Link.

Возвращается только для компании, связанной с HCM Link

userId
integer

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

Поля объекта result.members.state

Название
тип

Описание

code
string

Код статуса участника

name
string

Название статуса участника

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

HTTP-статус: 200

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied!"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Когда возникает

ACCESS_DENIED

Access denied!

Недостаточно прав

WRONG_AUTH_TYPE

Current authorization type is denied for this method

Вызов не из контекста приложения

INTERNAL_ERROR

Internal error

Ошибка при формировании ответа

-

Document UID is required

Не передан параметр uid

-

Document not found

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

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

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

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

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

Предыдущая
Отправить документ на подписание
Следующая
Получить список провайдеров компании