Получить подписанный документ HCM Link sign.b2e.hcmlink.document.get

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

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

Scope: sign.b2e

Кто может выполнять метод: администратор

Метод sign.b2e.hcmlink.document.get возвращает данные подписанного документа КЭДО, который связан с HCM Link.

Метод работает только в контексте авторизации приложения. Метод доступен, если на Битрикс24 доступна интеграция HCM Link.

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

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

Название
тип

Описание

id*
integer

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

Получить идентификатор можно из поля data.id события OnSignHcmLinkB2eDocumentSigned

Примеры кода

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

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":3942,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sign.b2e.hcmlink.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, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type HcmLinkDocument = {
  company: string
  employee: string
  document: {
    date: ISODate
    name: string
    fileUrl: string
    fileName: string
    uid: string | null
    documentUid: string | null
  }
}

try {
  const response = await $b24.actions.v2.call.make<HcmLinkDocument>({
    method: 'sign.b2e.hcmlink.document.get',
    params: {
      id: 3942,
    },
    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.company, result.employee, result.document.fileName)
  }
} 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 getHcmLinkDocument() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sign.b2e.hcmlink.document.get',
        params: {
          id: 3942,
        },
        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.company, result.employee, result.document.fileName)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getHcmLinkDocument)
</script>

try {
    $response = $b24Service
        ->core
        ->call(
            'sign.b2e.hcmlink.document.get',
            [
                'id' => 3942
            ]
        );

    $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.hcmlink.document.get',
    {
        id: 3942
    },
    result => {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.dir(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'sign.b2e.hcmlink.document.get',
    [
        'id' => 3942
    ]
);

if (isset($result['error'])) {
    echo 'Ошибка: ' . $result['error_description'];
} else {
    echo '<PRE>';
    print_r($result['result']);
    echo '</PRE>';
}

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sign.b2e.hcmlink.document.get", b24.Params{
	"id": 3942,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sign.b2e.hcmlink.document.get: %w", err)
}

var item struct {
	Company string `json:"company"`
	Employee string `json:"employee"`
	Document struct {
		FileName string `json:"fileName"`
	} `json:"document"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Company, item.Employee, item.Document.FileName)

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

HTTP-статус: 200

{
    "result": {
        "company": "acme-hr",
        "employee": "EMP-001",
        "document": {
            "date": "2026-08-07T10:15:30+03:00",
            "name": "Трудовой договор",
            "fileUrl": "https://test.bitrix24.ru/rest/download.json?auth=***&token=sign.b2e...",
            "fileName": "Трудовой договор.pdf",
            "uid": "TD-2026-001",
            "documentUid": "R-LK-50JI-3AAK-WS1A"
        }
    },
    "time": {
        "start": 1786086930.123,
        "finish": 1786086930.456,
        "duration": 0.333,
        "processing": 0.111,
        "date_start": "2026-08-07T10:15:30+03:00",
        "date_finish": "2026-08-07T10:15:30+03:00",
        "operating_reset_at": 1786087530,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Информация о подписанном документе (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
company `string`	Код компании HCM Link
employee `string`	Код сотрудника HCM Link
document `object`	Данные подписанного документа (подробное описание)

Объект document

Название `тип`	Описание
date `string`	Дата создания документа в формате ISO 8601
name `string`	Название документа
fileUrl `string`	Ссылка для скачивания подписанного файла
fileName `string`	Название подписанного файла
uid `string`	Идентификатор документа из HCM Link. Может вернуть `null`, если поле документа не связано с подписанным документом
documentUid `string`	Уникальный идентификатор документа КЭДО. Может вернуть `null`

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

HTTP-статус: 200, 403

{
    "error": "SIGN_HCMLINK_DOCUMENT_NOT_FOUND",
    "error_description": "Document not found"
}

Название `тип`	Описание
error `string`	Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только `error_description`
error_description `string`	Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

Статус	Код	Описание	Когда возникает
`403`	`ACCESS_DENIED`	Access denied	Недостаточно прав
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method	Вызов не из контекста приложения
`200`	Пустое значение	Module humanresources is not available	Модуль `humanresources` недоступен
`200`	`SIGN_HCMLINK_DOCUMENT_NOT_FOUND`	Document not found	Документ не найден или не связан с HCM Link
`200`	`SIGN_HCMLINK_DOCUMENT_NOT_LINKED`	No employee or company linked to the document	С документом не связаны сотрудник или компания HCM Link
`200`	`SIGN_HCMLINK_NO_SIGNED_FILE_EXIST`	Signed file for this document does not exist	Подписанный файл документа не найден

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`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	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Была ли статья полезна?

Получить документ

Получить список провайдеров компании

Получить подписанный документ HCM Link sign.b2e.hcmlink.document.get

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

Примеры кодаПримеры кода

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

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

Объект resultОбъект result

Объект documentОбъект document

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

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

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

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