Имя параметра | Тип | Обязательный | Описание |
subject | string | true | Тема конверта Пример: "Offer Letter" |
remark | string | false | Примечание к конверту, ограничение длины — 1000 символов |
signerSettings | object | false | Действия, разрешенные для подписантов |
| | allowTransfer | boolean | false | Разрешено ли подписанту передать этот конверт другому лицу для подписания, по умолчанию false true — разрешает подписанту в конверте право передачи конверта другому лицу; false — запрещает подписанту в конверте право передачи конверта другому лицу; |
| | allowModifyName | boolean | false | Разрешено ли стороне подписания изменять имя, действует только для шаблонных подписей, по умолчанию false true — разрешает подписанту изменять имя false — запрещает подписанту изменять имя |
expireAfterSeconds | long | false | Время истечения срока действия конверта, через сколько секунд конверт становится недействительным Диапазон: от 86 400 секунд (1 день) до 7 776 000 секунд (90 дней) |
redirectUrl | string | false | Должно быть действительным адресом https |
callBackUrl | string | false | Адрес обратного вызова (длина 500), должен соответствовать адресу протокола https. |
sendLaterAfterSeconds | long | false | Поддержка отложенной отправки пользователем, в секундах Поддерживаемый диапазон времени: от 3600 секунд (1 час) до 259 200 секунд (30 дней) |
autoFinish | boolean | false | Управление автоматическим завершением конверта, по умолчанию true true- Конверт автоматически завершается false- Конверт завершается вручную |
CCInfos | array | false | Коллекция информации о получателях копии |
| userEmail | string | false | Адрес электронной почты получателя копии |
| userName | string | false | Имя получателя копии, используется для отображения имени получателя копии на странице подписания и в конверте. [Внимание]: не должно содержать следующих 9 специальных символов: / \ : * " < > | ? а также все эмодзи |
| ccOrder | int | false | Порядковое положение получателя копии в процессе подписания, совместно использует порядок с signOrder подписанта. Если не передано, применяется логика уведомления по умолчанию. |
| | customizeSettings | object | false | Пользовательская настройка |
| | | notificationSettings | object | false | Настройка уведомлений |
| | | | notificationLanguage | string | false | Язык уведомлений, по умолчанию берется из конфигурации «язык уведомлений по умолчанию» en-US Английский zh-CN Упрощенный китайский zh-Hant Традиционный китайский ja-JP Японский es-MX Испанский pt-PT Португальский th-TH Тайский id-ID индонезийский vi-VN вьетнамский ms-MY малайский fil-PH филиппинский de-DE немецкий fr-FR французский ru-RU русский it-IT итальянский ko-KR корейский |
signFiles | array | true | Коллекция информации о документах для подписания, порядок отображения соответствует порядку добавления документов. |
| fileKey | string | true | fileKey документа для подписания, поддерживается только формат PDF |
| | documentFields | array | false | Список элементов управления размером документа. Используется для добавления элементов управления размером документа на указанный документ без привязки к подписанту. |
| | fieldType | string | false | Тип элемента управления. Передайте eMeterai для обозначения элемента управления гербовым сбором Индонезии. |
| | pageNo | string | false | Номер страницы, на которой находится элемент управления. Для элемента управления гербовым сбором Индонезии поддерживается только указание одной страницы; необходимо передать один номер страницы, форматы нескольких страниц, таких как 1-3 или 1,3, не поддерживаются. |
| | | posX | float | false | Смещение по оси X, начало координат находится в левом нижнем углу страницы. Диапазон координат совпадает с диапазоном координат других элементов управления. |
| | | posY | float | false | Смещение по оси Y, начало координат находится в левом нижнем углу страницы. Диапазон координат совпадает с диапазоном координат других элементов управления. |
attachments | array | false | Коллекция вложений в виде конверта; порядок отображения соответствует порядку добавления файлов. |
| fileKey | string | false | fileKey файла |
signerInfos | array | true | Коллекция информации о подписантах |
| businessId | string | false | Пользовательский бизнес-идентификатор разработчика, ограничение длины — 500 символов |
| | roleTypes | array | false | Способ действия подписанта, значение по умолчанию ["sign", "fill"] fill — заполнение sign — подписание |
| | deliveryMethods | string | false | Способ уведомления, значение по умолчанию — auto auto- при передаче userEmail отправляется уведомление по электронной почте, при передаче phoneNumber — уведомление по SMS none- уведомления не отправляются email- отправка уведомления по электронной почте sms- отправка уведомления по SMS WhatsApp- отправка уведомления через WhatsApp |
| userEmail | string | false | Адрес электронной почты подписанта |
| userName | string | true | Имя подписанта, отображаемое на странице подписания и в конверте. [Примечание] Нельзя использовать следующие 9 специальных символов: / \ : * " < > | ? а также все эмодзи |
| | minimumReadingDuration | int | false | Устанавливает время обратного отсчета для обязательного чтения на странице. Значение по умолчанию — 0 (единица измерения: секунды, максимальное значение — 999) Значение 0 или отсутствие параметра означает отключение функции; обратный отсчет не требуется |
| | readToEndRequired | boolean | false | Определяет, обязательно ли прочитать документ до конца. По умолчанию false; true означает включение; false или отсутствие параметра означает отключение. |
| phoneNumber | object | false | Номер телефона, по умолчанию пустой Обязательный параметр при необходимости отправки SMS-уведомлений; необходимо передать как countryCode, так и number |
| | countryCode | string | false | Международный код страны/региона; символ «+» указывать не нужно |
| | number | string | false | Проверка формата не выполняется, ограничение только по длине — максимум 13 символов |
| | customizeSettings | object | false | Пользовательская настройка |
| | | notificationSettings | object | false | Настройка уведомлений |
| | | | customizeMessage | string | false | Специальное сообщение уведомления, ограничение по количеству символов — 200 |
| | | | notificationLanguage | string | false | Язык уведомления, по умолчанию используется значение из настройки «Язык уведомления по умолчанию» en-US Английский zh-CN упрощённый китайский zh-Hant традиционный китайский ja-JP японский es-MX испанский (Мексика) pt-PT португальский (Португалия) th-TH тайский id-ID индонезийский vi-VN вьетнамский ms-MY малайский fil-PH филиппинский de-DE немецкий fr-FR французский ru-RU русский it-IT итальянский ko-KR корейский |
| signOrder | int | true | Порядок подписания уполномоченными лицами, минимальное значение — 1. При параллельном подписании можно указывать одинаковые значения порядка. |
| signTaskSuspend | boolean | false | Устанавливать ли узел блокировки потока перед данной позицией подписания; по умолчанию false. true — установить узел блокировки; false — не устанавливать узел блокировки. Конфигурация блокировки внутри группы ор-подписания с тем же signOrder должна быть единообразной. |
| suspensionKey | string | false | Идентификатор узла блокировки, максимальная длина — 500 символов, должен быть уникальным в рамках одного конверта. Обязательно при signTaskSuspend=true; недопустимо передавать при signTaskSuspend=false или если параметр не указан. |
| suspendReason | string | false | Причина блокировки; при передаче не может быть пустой, максимальная длина — 50 символов. Допускается передача только при signTaskSuspend=true; если параметр не передан, по умолчанию подразумевается ожидание обработки внешней системой. Недопустимо передавать при signTaskSuspend=false или если параметр не указан. |
| anySigner | boolean | false | Поддерживает ли подпись любым из участников; по умолчанию false true- Для одного signOrder достаточно подписания одним участником false- Для одного signOrder требуется подпись всех участников |
| authModes | string | false | Способ проверки, по умолчанию noAuth noAuth- Без проверки accessCode- Проверка с помощью пароля подписи sms- Проверка SMS OTP idVerification- Проверка по удостоверению личности emailAuth- Проверка email OTP digitalId- Электронная проверка личности whatsappAuth- Проверка WhatsApp OTP |
| authConfig | object | false | Настройка способа проверки |
| | accessCode | object | false | Настройка пароля подписи, обязательно при authModes=accessCode |
| | | accessCode | string | false | Содержимое пароля, регистр не учитывается, могут быть буквы и цифры, ограничение длины — 45 символов |
| | | | promptInfo | string | false | Подсказка для доступа к паролю, не может содержать сам пароль, ограничение длины — 30 символов, обязательно при authModes=accessCode. |
| | sms | object | false | Проверка SMS OTP, обязательно при authModes=sms |
| | | countryCode | string | false | Международный код страны/региона, символ «+» указывать не нужно |
| | | number | string | false | Форматная проверка не выполняется, ограничение максимальной длины — 13 символов |
| | idVerification | object | false | Настройка проверки удостоверения личности, обязательно при authModes=idVerification |
| | | name | string | false | Полное имя владельца удостоверения личности, максимальная длина — 100 символов |
| | | emailAuth | object | false | Проверка Email OTP, обязательно при authModes=emailAuth |
| | | | authEmail | string | false | Адрес электронной почты для проверки личности подписанта |
| | digitalId | array | false | Электронная проверка личности, обязательно при authModes=digitalId |
| | | authApp | string | false | Приложение, используемое для электронной проверки личности singpass- Проверка личности через Singpass iamsmart- Проверка личности через i AM Smart |
| | | idNumber | string | false | Номер удостоверения личности подписанта, подлежащий проверке Когда authApp=singpass, правило ввода: заглавная буква + 7 или 8 цифр + заглавная буква Когда authApp=iamsmart, правило ввода: 1. Одна заглавная буква (A-Z) или две заглавные буквы (AA-ZZ) в начале последовательности; 2. За ней следуют 6 цифр; 3. В конце контрольная сумма, которая может быть цифрой (0-9) или буквой (A-Z). Пример: A888888(A) |
| | whatsappAuth | object | false | Проверка OTP через WhatsApp, обязательно при authModes=whatsappAuth |
| | | countryCode | string | false | Международный код страны/региона, символ «+» передавать не нужно |
| | | number | string | false | Не выполнять проверку формата, ограничивать только максимальную длину — 13 символов |
| digitalSignature | boolean | false | Включить цифровую подпись, по умолчанию false true — включить, false — не включать |
| tsp | string | false | Выбрать TSP, используемый подписантом, по умолчанию false. Если не задано, подписант самостоятельно выбирает необходимый TSP. Возможные значения: vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha |
| freeFormSign | boolean | false | Разрешить подписанту свободно размещать печать/подпись, значение по умолчанию false Дополнительное пояснение: При установке freeFormSign=true остальные параметры в sealInfos передавать не нужно. Если они переданы одновременно, приоритет имеет freeFormSign, а параметры из sealInfos не будут действовать [Примечание]Свободное размещение означает отсутствие ограничений на количество и позицию печатей/подписей, которые может перемещать подписант |
| documentVisibility | object | false | Настройка видимости файлов, по умолчанию все файлы видны. |
| | documentViewType | string | false | Стратегия видимости, по умолчанию all; all означает возможность просмотра всех документов в конверте, limited — просмотр только собственных подписанных документов и дополнительных открытых документов. |
| | viewableFileKeys | array | false | Список fileKey, дополнительно разрешённых для просмотра另一方; передаётся и действует только при documentViewType=limited. |
| sealInfos | array | false | Информация о задаче подписания |
| | fileKey | string | true | fileKey подписываемого документа |
| | signConfigs | array | false | Информация о расположении элемента управления. Для выполнения электронной подписи необходимо указать информацию о расположении элемента управления. |
| | | fieldType | string | false | Тип элемента управления, по умолчанию signature signature- Элемент управления для подписи stamp- Элемент управления для печати approval- Элемент управления для согласования |
| | | | required | boolean | false | Обязательное поле, по умолчанию обязательно true- Обязательно false- Не обязательно |
| | | | signFieldStyle | string | false | Способ наложения печати для элемента управления, по умолчанию normalSeal. normalSeal- Обычная печать pagingSeal- Фасетная печать Фасетная печать поддерживается только для элементов управления подписью и печатью. |
| | | | pagingSealMode | string | false | Диапазон страниц для фасетной печати, по умолчанию all. all- Все страницы assignedPages- Указанные страницы even- Четные страницы odd- Нечетные страницы Поддерживается указание только при signFieldStyle=pagingSeal. |
| | | | sizeRule | string | false | Способ отображения размеров зоны подписи originalSize- Печать по фактическому размеру подписи/печати targetSize- Пользовательская ширина и высота зоны подписи/печати Когда sizeRule, height и width пусты, печать осуществляется по фактическому размеру подписи/печати; Когда sizeRule пусто, а height и width не пусты, печать осуществляется по заданным размерам; Когда sizeRule не пусто, печать осуществляется согласно указанному способу отображения; Для сквозной печати этот параметр указывать не нужно, печать осуществляется только по фактическому размеру. |
| | | height | int | false | Высота элемента подписи, применяется для fieldType=signature/stamp, единица измерения — пиксели (px), поддерживаются только положительные целые числа, по умолчанию auto (автоматический размер системы); При fieldType=signature допустимый диапазон составляет 20–250 px; При fieldType=stamp допустимый диапазон составляет 30–280 px; Для сквозной печати этот параметр указывать не нужно. |
| | | width | int | false | Ширина элемента подписи, применяется для fieldType=signature/stamp, единица измерения — пиксели (px), поддерживаются только положительные целые числа, по умолчанию auto (автоматический размер системы); При fieldType=signature допустимый диапазон составляет 20–250 пикселей; При fieldType=stamp допустимый диапазон составляет 30–280 пикселей; Для сквозной печати этот параметр указывать не требуется. |
| | | signatureOptions | string | false | Параметры виджета подписи. Применимо только при fieldType, равном signature Допустимые значения: template: шаблонная подпись handDrawn: ручная подпись upload: загрузка изображения подписи с локального устройства aiHandDrawn: ИИ-рукописная подпись Можно выбрать несколько значений, разделяя их запятыми; по умолчанию выбраны все |
| | | movable | boolean | false | Разрешить перемещение позиции во время подписания, по умолчанию false false — разрешателю запрещено изменять положение своего виджета подписи true — разрешателю разрешено изменять положение своего виджета подписи |
| | | allowedOptions | array | false | Параметры, позволяющие разрешителю утверждать или отклонять документ; применимо при fieldType, равном approval. По умолчанию ["approve", "decline"] approve- Согласие decline-Отклонить |
| | | pageNo | string | false | Номера страниц для подписи; непрерывные номера страниц соединяются символом «-», отдельные номера — символом «,» Пример: 1-3,6-10 При pagingSealMode=assignedPages передавайте диапазон номеров страниц для наложения сквозной печати. Сквозная печать может использоваться только для документов, состоящих более чем из одной страницы. |
| | | posX | float | false | Координата по оси X [Внимание] Если fieldType равен signature, то координаты указывают на область подписанияНижний левый угол; Если fieldType равен stamp, то координаты указывают на область проставления печатиЦентральная точкаПозиция Начиная с 3 февраля 2026 года, при fieldType равном signature или stamp координаты указывают на центральную точку области проставления печати. Для сквозной печати можно передавать 0, но нельзя передавать null; элемент управления фиксируется по правому краю документа. |
| | | posY | float | false | Координата по оси Y [Внимание] Если fieldType равен signature, то координаты указывают на область подписанияНижний левый угол; Если fieldType равен stamp, координаты указывают на область печати штампаЦентральная точкаПозиция Начиная с 3 февраля 2026 года, если fieldType равен signature или stamp, его координаты указывают на центральную точку области печати штампа. |
| | fillConfigs | array | false | Заполните информацию о компоненте управления |
| | | fieldName | string | false | Название компонента управления, ограничение по количеству символов — 128 |
| | | required | boolean | false | Обязательное поле, по умолчанию обязательно для заполнения true — обязательно для заполнения false — не обязательно для заполнения |
| | | fieldType | string | false | Тип компонента управления: 1 — однострочный текст 15 — флажок |
| | | textField | object | false | Свойства текстового компонента управления |
| | | | overflowType | int | false | Применяется только к text, по умолчанию 1 1 — автоматическое уменьшение размера шрифта 2-Ограничение ввода |
| | | | minFontSize | float | false | Действует только для text, только при overflowType=1, по умолчанию 8 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72 |
| | | | width | int | false | Ширина элемента управления, по умолчанию 160px |
| | | | font | int | false | Действует только для text, шрифт, по умолчанию SimSun (Сун) 1-SimSun (Сун) 2-New SimSun (Новый Сун) 4-HeiTi (Хэйти) 5-KaiTi (Кайти) 6-Arial 7-Helvetica 9-Times New Roman 10-FangSong (Фансун) 11-Georgia 12-Monospace |
| | | | fontSize | float | false | Действует только для text, размер шрифта, по умолчанию 12 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72 |
| | | | textColor | string | false | Действует только для text, цвет в шестнадцатеричном формате, по умолчанию черный #000 |
| | | | bold | boolean | false | Действует только для text, жирный шрифт, по умолчанию false true-Жирный false-Не жирный |
| | | | italic | boolean | false | Действует только для text, курсив, по умолчанию false true-курсив false-не курсив |
| | | | underline | boolean | false | действует только для text, добавление подчеркивания к шрифту, по умолчанию false true-добавить подчеркивание false-не добавлять подчеркивание |
| | | | lineThrough | boolean | false | действует только для text, добавление зачеркивания, по умолчанию false true-добавить зачеркивание false-не добавлять зачеркивание |
| | | | horizontalAlignment | string | false | действует только для text, горизонтальное выравнивание по центру, по умолчанию left LEFT-по левому краю CENTER-по центру RIGHT-по правому краю |
| | | tickBoxField | object | false | свойства флажка |
| | | | tickOptions | array | false | действует только для tickBox, по умолчанию 1 1-галочка 2-дерево |
| | | posX | float | false | Координата X положения элемента управления |
| | | posY | float | false | Координата Y положения элемента управления |
| | | pageNo | string | false | Номер страницы, на которой находится элемент управления |
| | signDateConfigs | array | false | Информация о позиции даты подписания |
| | | movable | boolean | false | Разрешить перемещение позиции при подписании, по умолчанию false false — не разрешает подписанту изменять позицию своего элемента подписания true — разрешает подписанту изменять позицию своего элемента подписания |
| | | pageNo | string | false | Номера страниц для подписания; непрерывные номера страниц соединяются символом «-», отдельные номера страниц разделяются символом «,». Пример: 1-3, 6-10; Для разрывных диапазонов используйте символ «,» для разделения. |
| | | posX | float | false | Смещение по оси X, началом координат является левый нижний угол страницы |
| | | posY | float | false | Смещение по оси Y, началом координат является левый нижний угол страницы |
| | | signDateFormat | string | false | Формат даты подписания, формат по умолчанию: yyyy-MM-dd Поддерживаются указанные форматы: yyyy год MM месяц dd день yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MMM dd,yyyy dd MMM yyyy |