Отправить документ на подписание sign.b2e.document.send
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Кто может выполнять метод: пользователь с правом создавать документы КЭДО
Метод sign.b2e.document.send отправляет документ на подписание со стороны компании.
Метод работает только в контексте авторизации приложения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Параметры отправки документа на подписание (подробное описание) |
|
language |
Язык локализации статусов в ответе. По умолчанию |
Параметр fields
|
Название |
Описание |
|
company* |
Компания, от имени которой отправляется документ (подробное описание) |
|
members* |
Список участников подписания. Должен содержать минимум одного участника с ролью |
|
responsible* |
Ответственный за документ (подробное описание) |
|
companyProviderUid* |
Идентификатор провайдера подписи. Получить список доступных провайдеров подписи можно методом sign.b2e.company.provider.list |
|
files* |
Файл подписываемого документа (подробное описание) |
|
regionDocumentType* |
Тип документа для региона (подробное описание) |
|
externalSettings* |
Внешние параметры документа (подробное описание) |
|
language |
Язык документа |
|
message |
Текст сообщения для сотрудника. Сотрудник увидит сообщение в чате вместе с приглашением подписать документ. Максимальная длина — 2000 символов |
Параметр company
|
Название |
Описание |
|
uuid* |
UUID компании в HCM Link. Требует дополнительный scope |
|
crmId* |
Идентификатор компании в CRM, подключенный в интеграции как «моя компания» |
Передайте один из параметров uuid или crmId.
Элемент массива members
|
Название |
Описание |
|
employeeCode* |
Код сотрудника в HCM Link. Требует дополнительный scope |
|
employeeId* |
Идентификатор сотрудника в HCM Link. Требует дополнительный scope |
|
userId* |
Идентификатор пользователя в Битрикс24 |
|
role* |
Роль участника. Возможные значения:
|
Передайте один из параметров employeeId, employeeCode или userId.
Поля employeeCode и employeeId доступны только для компании, связанной с HCM Link. Для компании, переданной через company.crmId без связи с HCM Link, используйте userId.
Параметр responsible
|
Название |
Описание |
|
employeeCode* |
Код сотрудника в HCM Link. Требует дополнительный scope |
|
employeeId* |
Идентификатор сотрудника в HCM Link. Требует дополнительный scope |
|
userId* |
Идентификатор пользователя в Битрикс24 |
|
role |
Роль участника. Возможные значения:
|
Передайте один из параметров employeeId, employeeCode или userId.
Поля employeeCode и employeeId доступны только для компании, связанной с HCM Link. Для компании, переданной через company.crmId без связи с HCM Link, используйте userId.
Элемент массива files
|
Название |
Описание |
|
fileName* |
Имя файла. Обязательно с расширением |
|
fileType* |
MIME-тип файла. Поддерживается |
|
fileContent* |
Содержимое файла, закодированное в Base64 |
Параметр regionDocumentType
Код типа документа зависит от региона лицензии. Список доступных кодов формируется на стороне Битрикс24, валидация выполняется по региону лицензии.
Если вы не знаете код, используйте значение 12.999 как безопасное значение по умолчанию. Это значение проходит проверку по умолчанию, когда список кодов для региона пустой или неизвестен.
Параметр externalSettings
|
Название |
Описание |
|
externalId* |
Внешний идентификатор. Максимальная длина — 255 символов |
|
externalDateCreate* |
Дата создания внешнего документа в формате ISO 8601 |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"company":{"crmId":12},"members":[{"userId":25,"role":"signer"},{"userId":42,"role":"assignee"}],"responsible":{"userId":7},"companyProviderUid":"d4f6b8a1-4c6d-4d8c-9c7c-2d1b1f6d0f2b","files":[{"fileName":"contract.pdf","fileType":"application/pdf","fileContent":"JVBERi0xLjQKJ..."}],"regionDocumentType":"12.999","externalSettings":{"externalId":"EXT-123","externalDateCreate":"2025-02-18T09:19:34+03:00"},"message":"Пожалуйста, подпишите документ"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sign.b2e.document.send
// 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 SendDocumentResult = {
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<SendDocumentResult>({
method: 'sign.b2e.document.send',
params: {
fields: {
company: { crmId: 12 },
members: [
{ userId: 25, role: 'signer' },
{ userId: 42, role: 'assignee' },
],
responsible: { userId: 7 },
companyProviderUid: 'd4f6b8a1-4c6d-4d8c-9c7c-2d1b1f6d0f2b',
files: [
{
fileName: 'contract.pdf',
fileType: 'application/pdf',
fileContent: 'JVBERi0xLjQKJ...',
},
],
regionDocumentType: '12.999',
externalSettings: {
externalId: 'EXT-123',
externalDateCreate: '2025-02-18T09:19:34+03:00',
},
message: 'Пожалуйста, подпишите документ',
},
},
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('Document uid:', result.uid, 'state:', result.state.code, 'members:', 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 sendDocument() {
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.send',
params: {
fields: {
company: { crmId: 12 },
members: [
{ userId: 25, role: 'signer' },
{ userId: 42, role: 'assignee' },
],
responsible: { userId: 7 },
companyProviderUid: 'd4f6b8a1-4c6d-4d8c-9c7c-2d1b1f6d0f2b',
files: [
{
fileName: 'contract.pdf',
fileType: 'application/pdf',
fileContent: 'JVBERi0xLjQKJ...',
},
],
regionDocumentType: '12.999',
externalSettings: {
externalId: 'EXT-123',
externalDateCreate: '2025-02-18T09:19:34+03:00',
},
message: 'Пожалуйста, подпишите документ',
},
},
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('Document uid:', result.uid, 'state:', result.state.code, 'members:', result.members.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', sendDocument)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"company": {
"crmId": 12,
},
"members": [
{
"userId": 25,
"role": "signer",
},
{
"userId": 42,
"role": "assignee",
},
],
"responsible": {
"userId": 7,
},
"companyProviderUid": "d4f6b8a1-4c6d-4d8c-9c7c-2d1b1f6d0f2b",
"files": [
{
"fileName": "contract.pdf",
"fileType": "application/pdf",
"fileContent": "JVBERi0xLjQKJ...",
},
],
"regionDocumentType": "12.999",
"externalSettings": {
"externalId": "EXT-123",
"externalDateCreate": "2025-02-18T09:19:34+03:00",
},
"message": "Пожалуйста, подпишите документ",
}
try:
bitrix_response = client.sign.b2e.document.send(
fields=fields,
).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(
'sign.b2e.document.send',
[
'fields' => [
'company' => [
'crmId' => 12
],
'members' => [
[ 'userId' => 25, 'role' => 'signer' ],
[ 'userId' => 42, 'role' => 'assignee' ]
],
'responsible' => [ 'userId' => 7 ],
'companyProviderUid' => 'd4f6b8a1-4c6d-4d8c-9c7c-2d1b1f6d0f2b',
'files' => [
[
'fileName' => 'contract.pdf',
'fileType' => 'application/pdf',
'fileContent' => 'JVBERi0xLjQKJ...'
]
],
'regionDocumentType' => '12.999',
'externalSettings' => [
'externalId' => 'EXT-123',
'externalDateCreate' => '2025-02-18T09:19:34+03:00'
],
'message' => 'Пожалуйста, подпишите документ'
]
]
);
$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.send',
{
fields: {
company: { crmId: 12 },
members: [
{ userId: 25, role: 'signer' },
{ userId: 42, role: 'assignee' }
],
responsible: { userId: 7 },
companyProviderUid: 'd4f6b8a1-4c6d-4d8c-9c7c-2d1b1f6d0f2b',
files: [
{
fileName: 'contract.pdf',
fileType: 'application/pdf',
fileContent: 'JVBERi0xLjQKJ...'
}
],
regionDocumentType: '12.999',
externalSettings: {
externalId: 'EXT-123',
externalDateCreate: '2025-02-18T09:19:34+03:00'
},
message: 'Пожалуйста, подпишите документ'
}
},
result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sign.b2e.document.send',
[
'fields' => [
'company' => [ 'crmId' => 12 ],
'members' => [
[ 'userId' => 25, 'role' => 'signer' ],
[ 'userId' => 42, 'role' => 'assignee' ]
],
'responsible' => [ 'userId' => 7 ],
'companyProviderUid' => 'd4f6b8a1-4c6d-4d8c-9c7c-2d1b1f6d0f2b',
'files' => [
[
'fileName' => 'contract.pdf',
'fileType' => 'application/pdf',
'fileContent' => 'JVBERi0xLjQKJ...'
]
],
'regionDocumentType' => '12.999',
'externalSettings' => [
'externalId' => 'EXT-123',
'externalDateCreate' => '2025-02-18T09:19:34+03:00'
],
'message' => 'Пожалуйста, подпишите документ'
]
]
);
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.document.send", b24.Params{
"fields": b24.Params{
"company": b24.Params{
"crmId": 12,
},
"members": []b24.Params{
{
"userId": 25,
"role": "signer",
},
{
"userId": 42,
"role": "assignee",
},
},
"responsible": b24.Params{
"userId": 7,
},
"companyProviderUid": "d4f6b8a1-4c6d-4d8c-9c7c-2d1b1f6d0f2b",
"files": []b24.Params{
{
"fileName": "contract.pdf",
"fileType": "application/pdf",
"fileContent": "JVBERi0xLjQKJ...",
},
},
"regionDocumentType": "12.999",
"externalSettings": b24.Params{
"externalId": "EXT-123",
"externalDateCreate": "2025-02-18T09:19:34+03:00",
},
"message": "Пожалуйста, подпишите документ",
},
})
if err != nil {
return fmt.Errorf("sign.b2e.document.send: %w", err)
}
var item struct {
Uid string `json:"uid"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Uid)
Обработка ответа
HTTP-статус: 200
{
"result": {
"uid": "b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c",
"state": {
"code": "sent",
"name": "Отправлен"
},
"members": [
{
"uid": "f1c2d3e4",
"role": "signer",
"party": 0,
"user": {
"employeeCode": "EMP-001",
"employeeId": 123,
"userId": 25
},
"state": {
"code": "waiting",
"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": "BAD_REQUEST",
"error_description": "[companyProviderUid] field is required"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Когда возникает |
|
|
Access denied! |
Недостаточно прав |
|
|
Current authorization type is denied for this method |
Вызов не из контекста приложения |
|
|
Empty request fields |
Не передан объект |
|
|
companyProviderUid field is required |
Не передан |
|
|
The responsible field is required |
Не передан |
|
|
At least one signing party with role signer is required |
В |
|
|
At least one signing party with role assignee is required |
В |
|
|
Invalid role ... |
Передана роль вне допустимых значений |
|
|
Employee ID is required |
Не передан |
|
|
Employee with code ... was not found |
Сотрудник с указанным |
|
|
Employee with ID ... was not found |
Сотрудник с указанным |
|
|
Could not find employee for specified User ID |
Пользователь по |
|
|
Could not find user for specified employee |
Для сотрудника не найден пользователь |
|
|
At least one file is required to sign the document |
Не передан массив |
|
|
Signing multiple files is currently not supported |
В |
|
|
The specified file type is not supported |
Указан |
|
|
Invalid file name |
Некорректное имя файла |
|
|
Invalid file name. File extension is not specified |
Не указано расширение файла |
|
|
The specified file extension is not supported |
Расширение файла не поддерживается |
|
|
Region document type is required. Use value '12.999' as a default value |
Не передан |
|
|
Region document type is not valid. Use value '12.999' as a default value |
Передан неподдерживаемый |
|
|
Signing provider is not available |
Провайдер недоступен для компании |
|
|
Signing provider has expired |
Истек срок действия провайдера |
|
|
External date create field is required |
Не передан |
|
|
External ID field is required |
Не передан |
|
|
External date create invalid field value |
Неверный формат даты в |
|
|
External ID maximum length of 255 is exceeded |
Превышена длина |
|
|
Internal error |
Ошибка при отправке документа или формировании ответа |
|
|
humanresources module is not installed |
Модуль |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |