Отправить документ на подписание sign.b2e.document.send

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

Scope: sign.b2e, crm

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

Метод sign.b2e.document.send отправляет документ на подписание со стороны компании.

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

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

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

Название
тип

Описание

fields*
object

Параметры отправки документа на подписание (подробное описание)

language
string

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

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

Параметр fields

Название `тип`	Описание
company* `object`	Компания, от имени которой отправляется документ (подробное описание)
members* `array`	Список участников подписания. Должен содержать минимум одного участника с ролью `signer` и одного с ролью `assignee` (подробное описание)
responsible* `object`	Ответственный за документ (подробное описание)
companyProviderUid* `string`	Идентификатор провайдера подписи. Получить список доступных провайдеров подписи можно методом sign.b2e.company.provider.list
files* `array`	Файл подписываемого документа (подробное описание)
regionDocumentType* `string`	Тип документа для региона (подробное описание)
externalSettings* `object`	Внешние параметры документа (подробное описание)
language `string`	Язык документа

Параметр company

Название
тип

Описание

uuid*
string

UUID компании в HCM Link.

Требует дополнительный scope humanresources.hcmlink

crmId*
integer

Идентификатор компании в CRM, подключенный в интеграции как «моя компания»

Передайте один из параметров uuid или crmId.

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

Название `тип`	Описание
employeeCode* `string`	Код сотрудника в HCM Link. Требует дополнительный scope `humanresources.hcmlink`
employeeId* `integer`	Идентификатор сотрудника в HCM Link. Требует дополнительный scope `humanresources.hcmlink`
userId* `integer`	Идентификатор пользователя в Битрикс24
role* `string`	Роль участника. Возможные значения: `signer` — подписант, `assignee` — представитель компании, `reviewer` — согласующий, `editor` — редактор

Передайте один из параметров employeeId, employeeCode или userId.

Поля employeeCode и employeeId доступны только для компании, связанной с HCM Link. Для компании, переданной через company.crmId без связи с HCM Link, используйте userId.

Параметр responsible

Название `тип`	Описание
employeeCode* `string`	Код сотрудника в HCM Link. Требует дополнительный scope `humanresources.hcmlink`
employeeId* `integer`	Идентификатор сотрудника в HCM Link. Требует дополнительный scope `humanresources.hcmlink`
userId* `integer`	Идентификатор пользователя в Битрикс24
role `string`	Роль участника. Возможные значения: `signer` — подписант, `assignee` — представитель компании, значение по умолчанию `reviewer` — согласующий, `editor` — редактор

Передайте один из параметров employeeId, employeeCode или userId.

Элемент массива files

Название `тип`	Описание
fileName* `string`	Имя файла. Обязательно с расширением `.pdf`
fileType* `string`	MIME-тип файла. Поддерживается `application/pdf`
fileContent* `string`	Содержимое файла, закодированное в Base64

Параметр regionDocumentType

Код типа документа зависит от региона лицензии. Список доступных кодов формируется на стороне Битрикс24 и валидация выполняется по региону портала.

Если вы не знаете код, используйте значение 12.999 как безопасное значение по умолчанию. Это значение проходит проверку по умолчанию, когда список кодов для региона пустой или неизвестен.

Параметр externalSettings

Название `тип`	Описание
externalId* `string`	Внешний идентификатор. Максимальная длина — 255 символов
externalDateCreate* `string`	Дата создания внешнего документа в формате ISO 8601

Примеры кода

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

cURL (OAuth)

PHP

BX24.js

PHP CRest

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"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sign.b2e.document.send

try
        {
        	const response = await $b24.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'
        				}
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(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'
                            ]
                        ]
                    ]
                );
        
            $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'
                    }
                }
            },
            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'
                    ]
                ]
            ]
        );
        
        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": "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 `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": "BAD_REQUEST",
            "error_description": "[companyProviderUid] field is required"
        }

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

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

Код	Описание	Когда возникает
`ACCESS_DENIED`	Access denied!	Недостаточно прав
`WRONG_AUTH_TYPE`	Current authorization type is denied for this method	Вызов не из контекста приложения
`BAD_REQUEST`	Empty request fields	Не передан объект `fields`
`BAD_REQUEST`	companyProviderUid field is required	Не передан `companyProviderUid`
`BAD_REQUEST`	The responsible field is required	Не передан `responsible`
`BAD_REQUEST`	At least one signing party with role signer is required	В `members` нет участника с ролью `signer`
`BAD_REQUEST`	At least one signing party with role assignee is required	В `members` нет участника с ролью `assignee`
`BAD_REQUEST`	Invalid role ...	Передана роль вне допустимых значений
`BAD_REQUEST`	Employee ID is required	Не передан `employeeId`/`employeeCode` и не передан `userId`
`BAD_REQUEST`	Employee with code ... was not found	Сотрудник с указанным `employeeCode` не найден
`BAD_REQUEST`	Employee with ID ... was not found	Сотрудник с указанным `employeeId` не найден
`BAD_REQUEST`	Could not find employee for specified User ID	Пользователь по `userId` не найден
`BAD_REQUEST`	Could not find user for specified employee	Для сотрудника не найден пользователь
`BAD_REQUEST`	At least one file is required to sign the document	Не передан массив `files`
`BAD_REQUEST`	Signing multiple files is currently not supported	В `files` передано более одного файла
`BAD_REQUEST`	The specified file type is not supported	Указан `fileType`, отличный от `application/pdf`
`BAD_REQUEST`	Invalid file name	Некорректное имя файла
`BAD_REQUEST`	Invalid file name. File extension is not specified	Не указано расширение файла
`BAD_REQUEST`	The specified file extension is not supported	Расширение файла не поддерживается
`BAD_REQUEST`	Region document type is required. Use value '12.999' as a default value	Не передан `regionDocumentType` при наличии списка кодов
`BAD_REQUEST`	Region document type is not valid. Use value '12.999' as a default value	Передан неподдерживаемый `regionDocumentType`
`BAD_REQUEST`	Signing provider is not available	Провайдер недоступен для компании
`BAD_REQUEST`	Signing provider has expired	Истек срок действия провайдера
`BAD_REQUEST`	External date create field is required	Не передан `externalSettings.externalDateCreate`
`BAD_REQUEST`	External ID field is required	Не передан `externalSettings.externalId`
`BAD_REQUEST`	External date create invalid field value	Неверный формат даты в `externalSettings.externalDateCreate`
`BAD_REQUEST`	External ID maximum length of 255 is exceeded	Превышена длина `externalSettings.externalId`
`INTERNAL_ERROR`	Internal error	Ошибка при отправке документа или формировании ответа
`-`	humanresources module is not installed	Модуль `humanresources` не установлен при использовании полей HCM Link

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

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

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

Обзор методов

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

Отправить документ на подписание sign.b2e.document.send

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

Параметр fieldsПараметр fields

Параметр companyПараметр company

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

Параметр responsibleПараметр responsible

Элемент массива filesЭлемент массива files

Параметр regionDocumentTypeПараметр regionDocumentType

Параметр externalSettingsПараметр externalSettings

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

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

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

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

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

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

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

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

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

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

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

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