Foxit eSign (предварительная версия)

Foxit eSign — это решение электронной подписи, которое позволяет отправлять, подписывать и управлять документами в Интернете— устраняя необходимость печати, сканирования или рассылки. Отправьте документ, определите поля подписи и отправьте его получателям для быстрой, юридической привязки eSignatures.

Этот соединитель доступен в следующих продуктах и регионах:

Service	Class	Regions
Copilot Studio	Premium	Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Standard	Все регионы Logic Apps , кроме следующих: - Azure для государственных организаций регионы - Azure регионы Китая - Министерство обороны США (DoD)
Power Apps	Premium	Все регионы Power Apps кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Premium	Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Contact
Name	Поддержка Foxit eSign
URL	https://www.foxit.com
Адрес электронной почты	api@foxit.com

Метаданные соединителя
Publisher	Foxit Software Inc.
Веб-сайт	https://www.foxit.com/esign-pdf/
Политика конфиденциальности	https://www.foxit.com/company/privacy-policy.html
Categories	Продуктивность; Содержимое и файлы

Foxit eSign

Foxit eSign — это корпоративное решение электронной подписи, которое позволяет предприятиям отправлять, подписывать и администрировать юридически обязательные документы полностью в Интернете — устраняя необходимость печати, сканирования или рассылки. Отправьте документ, определите поля подписи и отправьте его получателям для быстрого, безопасного eSignatures. Foxit eSign полностью соответствует основным законам электронной подписи, включая ESIGN и UETA, использует шифрование для защиты документов во время передачи и неактивных данных, а также поддерживает многофакторную проверку подлинности, чтобы обеспечить доступ и подписывать документы только авторизованным подписчикам.

Соединитель Foxit eSign для Microsoft Power Automate позволяет автоматизировать полный рабочий процесс подписывания документов — от создания конвертов и отправки их для подписи, отслеживания состояния, скачивания завершенных документов, управления шаблонами и активации подчиненных действий при возникновении событий конверта.

Publisher: Foxit Corporation

Необходимые условия

Чтобы использовать этот соединитель, вам потребуется:

План Microsoft Power Apps или Power Automate с пользовательским соединителем или доступом к соединителю premium
Учетная запись Foxit eSign — создайте ее здесь
Доступ к API включен в учетной записи Foxit eSign (см. сведения о получении учетных данных ниже)

Получение учетных данных

Создайте учетную запись Foxit eSign , если у вас еще нет учетной записи.
Обратитесь к группе продаж Foxit, чтобы запросить доступ к API для включения в вашей учетной записи. После утверждения доступ к API будет активирован в вашей учетной записи.
В Power Automate найдите Foxit eSign в списке соединителей и выберите "Создать подключение".
Вы будете перенаправлены на страницу входа Foxit eSign. Войдите с помощью учетных данных Foxit eSign, чтобы авторизовать подключение.
После авторизованного подключения подключение будет готово к использованию в потоках.

Getting Started

После создания подключения можно начать сборку потоков с помощью соединителя Foxit eSign:

Используйте триггеры для автоматического запуска потока при возникновении события конверта (например, при подписании всех сторон).
Используйте действия для создания конвертов, отправки напоминаний подписи, скачивания завершенных документов, управления шаблонами и т. д.
Объединение нескольких действий — например, создайте конверт из шаблона, дождитесь полного выполнения триггера, а затем скачайте подписанный документ и сохраните его в SharePoint.

Поддерживаемые триггеры

Trigger	Description
При отправке конверта	Срабатывает при отправке конверта получателям. Требуется значение "Уровень веб-перехватчика" для учетной записи.
Просмотр конверта	Запускается, когда получатель открывается и просматривает конверт.
При подписании конверта	Срабатывает, когда получатель подписывает конверт.
При отмене конверта	Возникает при отмене конверта получателем или отправителем.
Когда конверт полностью выполняется	Срабатывает, когда все получатели подписали и конверт полностью завершен.
При удалении конверта	Возникает при удалении конверта.

Поддерживаемые действия

Конверты

Действие	Description
Создание конверта из URL-адреса	Создает и отправляет конверт с помощью общедоступного URL-адреса PDF.
Создание конверта из Base64	Создает и отправляет конверт с помощью pdf-документа с кодировкой Base64.
Создание конверта из шаблона	Создает и отправляет конверт из существующего шаблона Foxit eSign.
Получение сведений о конверте	Извлекает полные сведения и текущее состояние конверта.
Получение идентификаторов конвертов	Извлекает список идентификаторов конвертов на основе критериев фильтра.
Отправка напоминания о подписи	Отправляет уведомление о напоминании ожидающих подписчиков конверта.
Скачивание файлов конверта	Загружает все подписанные документы в конверт в виде ZIP-файла.
Скачивание PDF-файла с одним документом	Загружает один документ из конверта в формате PDF.
Перемещение конвертов в корзину	Перемещает один или несколько конвертов в корзину.
Отмена конверта	Отменяет конверт и уведомляет получателей.
Удаление конвертов	Окончательно удаляет один или несколько конвертов.
Получение журнала действий конверта	Извлекает полный журнал действий для конверта.
Получение журнала удаленных конвертов	Извлекает журнал удаленных конвертов в учетной записи.

Templates

Действие	Description
Создание шаблона из URL-адреса	Создает шаблон повторно используемой подписи с помощью общедоступного URL-адреса PDF.
Создание шаблона из Base64	Создает шаблон повторно используемой подписи с помощью pdf-документа с кодировкой Base64.
Получение сведений о шаблоне	Извлекает полные сведения о конкретном шаблоне, включая определения полей.
Получение шаблонов по идентификаторам шаблонов	Извлекает сведения для одного или нескольких шаблонов по идентификаторам.
Получение списка всех шаблонов	Извлекает все шаблоны, доступные в учетной записи.

Webhooks

Действие	Description
Вывод списка всех каналов веб-перехватчика	Возвращает список всех каналов веб-перехватчика, настроенных в учетной записи.
Получение сведений о канале веб-перехватчика	Извлекает сведения о конкретном канале веб-перехватчика.

Группы электронной почты

Действие	Description
Создание группы электронной почты	Создает новую группу электронной почты для использования в качестве получателей в конвертах.
Получение сведений о группе электронной почты	Извлекает сведения и члены группы электронной почты.

Отчеты

Действие	Description
Скачивание отчета	Загружает отчет об активности учетной записи в Microsoft Excel формате.

Известные проблемы и ограничения

Ограничение скорости: API Foxit eSign позволяет выполнять до 4000 запросов за 5 минут на учетную запись. Запросы, превышающие это ограничение, получают 429 Too Many Requests ответ. Рекомендуется реализовать логику повторных попыток с экспоненциальным обратным отступом в потоках, чтобы справиться с этим корректно.
Ограничение размера файла: максимальный размер файла для каждого документа составляет 25 МБ. Это ограничение применяется к отдельным файлам, а не к общему размеру конверта.
Автозапись веб-перехватчика. Из-за ограничения в API удаления веб-перехватчика Foxit eSign (который использует метод POST, а не DELETE), Power Automate не может автоматически очистить подписки канала веб-перехватчика при удалении или изменении потока триггеров. Используйте действие "Список всех каналов веб-перехватчика" , чтобы определить активные каналы и портал Foxit eSign, чтобы удалить подписки при удалении потока.
При отправке конверта — только уровень учетной записи: триггер "При отправке конверта" активируется только в том случае, если для уровня веб-перехватчика задано значение Account. Он не запускается для конвертов, созданных на уровне приложения API . Убедитесь, что при настройке этого триггера выбран уровень учетной записи.
Региональная доступность: соединитель доступен как для учетных записей Северной Америки (NA1), так и для регионов ЕС. Выберите соответствующий регион сервера при настройке подключения. Подключение к неправильному региону приведет к сбоям проверки подлинности.
Размер документа Base64. При использовании конверта из Base64 или создания шаблона из действий Base64 строка с кодировкой Base64 должна соответствовать исходному файлу не более 25 МБ.

Support

Для поддержки разработчиков обратитесь в группу devsupport@foxitsoftware.comFoxit eSign.

Чтобы отправить обращение в службу поддержки, посетите сайт https://kb.foxit.com/s/submit-a-case.

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Вывод списка всех каналов веб-перехватчика	Возвращает список всех каналов веб-перехватчика, настроенных в вашей учетной записи.
Отмена конверта	Отменяет отправленный конверт. Получатели больше не смогут подписывать документы.
Отмена подписки триггера веб-перехватчика	Удаляет активную подписку канала веб-перехватчика по идентификатору канала. Используйте это действие для очистки подписок веб-перехватчика, которые больше не нужны.
Отправка напоминания о подписи	Отправляет уведомление о напоминании ожидающим получателям конверта, предлагая им завершить подпись.
Перемещение конвертов в корзину	Перемещает один или несколько конвертов в корзину. Конверты в корзине не удаляются окончательно.
Получение журнала действий конверта	Извлекает полный журнал действий для конверта, показывающий все действия, выполняемые получателями и отправителем.
Получение журнала удаленных конвертов	Извлекает журнал конвертов, которые были удалены или перемещены в корзину.
Получение идентификаторов конверта	Возвращает список идентификаторов конвертов, отфильтрованных по состоянию. Используйте это для поиска конвертов в определенном состоянии.
Получение сведений о группе электронной почты	Извлекает сведения о существующей группе электронной почты.
Получение сведений о канале веб-перехватчика	Извлекает сведения о конкретном канале веб-перехватчика.
Получение сведений о конверте	Получает полные сведения о конверте, включая его состояние, получатели и документы.
Получение сведений о шаблоне	Извлекает полные сведения о конкретном шаблоне, включая его поля и получатели.
Получение списка всех шаблонов	Возвращает список всех шаблонов, доступных в вашей учетной записи.
Получение шаблонов по идентификаторам шаблонов	Извлекает сведения для одного или нескольких шаблонов по идентификаторам.
Скачивание PDF-файла с одним документом	Загружает один документ из конверта в виде PDF-файла.
Скачивание отчета	Загружает отчет о действиях конверта в виде файла Microsoft Excel. Используйте фильтры, чтобы сузить результаты по состоянию, диапазону дат, имени конверта, автору или подписи.
Скачивание файлов конверта	Загружает завершенные документы из конверта в виде файла.
Создание группы электронной почты	Создает новую группу электронной почты, которую можно использовать для отправки конвертов нескольким получателям одновременно.
Создание конверта из Base64	Создает и отправляет конверт с помощью pdf-документа с кодировкой Base64.
Создание конверта из URL-адреса	Создает и отправляет конверт с помощью общедоступных URL-адресов PDF. Укажите URL-адреса документа и сведения о получателе для запуска процесса подписывания.
Создание конверта из шаблона	Создает и отправляет конверт с помощью существующего шаблона. Сведения о получателе можно настроить.
Создание шаблона из Base64	Создает новый шаблон с помощью строки PDF в кодировке Base64. Используйте это, если PDF-файл уже доступен в виде строки Base64 в потоке, например из файла SharePoint или документа OneDrive.
Создание шаблона из URL-адреса	Создает новый шаблон с помощью общедоступного URL-адреса PDF.
Удаление конвертов	Окончательно удаляет один или несколько конвертов.

Вывод списка всех каналов веб-перехватчика

Идентификатор операции:: ListallWebhookChannels

Возвращает список всех каналов веб-перехватчика, настроенных в вашей учетной записи.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнен ли запрос успешно.
Всего каналов	total_channel	integer	Общее количество каналов веб-перехватчика, настроенных в учетной записи.
Каналы веб-перехватчика	templatesList	array of object	Список всех каналов веб-перехватчика в учетной записи.
Идентификатор канала	templatesList.channelId	integer	Уникальный идентификатор канала веб-перехватчика.
Идентификатор компании	templatesList.companyId	integer	Учетная запись компании, к которой принадлежит этот канал.
Имя канала	templatesList.channelName	string	Имя канала веб-перехватчика.
URL-адрес вебхука	templatesList.webhookUrl	string	URL-адрес, который Foxit eSign будет вызывать при возникновении события подписки.
Секрет веб-перехватчика	templatesList.webhookSecret	string	Секретный ключ, используемый для проверки полезных данных веб-перехватчика.
Дата создания	templatesList.dateCreated	integer	Дата создания канала в миллисекундах Unix.
Дата обновления	templatesList.dateUpdated	integer	Дата последнего обновления канала в миллисекундах Unix.
Уровень веб-перехватчика	templatesList.webhookLevel	string	Область канала веб-перехватчика. Либо "Учетная запись" (триггеры для всех конвертов) или "ПРИЛОЖЕНИЕ API" (триггеры только для конвертов, созданных через API).
Статус	templatesList.status	string	Текущее состояние канала. Либо "активный", либо "деактивный".
Отправленный конверт	templatesList.eventsSubscribedMap.folder_sent	boolean	Активирует при отправке конверта получателям.
Просмотр конверта	templatesList.eventsSubscribedMap.folder_viewed	boolean	Активируется при открытии конверта получателем.
Подписанный конверт	templatesList.eventsSubscribedMap.folder_signed	boolean	Активируется при подписании конверта получателем.
Конверт отменен	templatesList.eventsSubscribedMap.folder_cancelled	boolean	Активирует при отмене конверта.
Конверт выполнен	templatesList.eventsSubscribedMap.folder_executed	boolean	Триггеры, когда все стороны подписали и конверт полностью выполняется.
Конверт удален	templatesList.eventsSubscribedMap.folder_deleted	boolean	Активирует при удалении конверта.

Отмена конверта

Идентификатор операции:: CancelEnvelope

Отменяет отправленный конверт. Получатели больше не смогут подписывать документы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор конверта	folderId	True	integer	Идентификатор конверта для отмены.
Причина отмены	reason_for_cancellation	True	string	Причина отмены этого конверта. Это записывается в журнал действий конверта.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнен ли запрос успешно.
Отмененные идентификаторы конвертов	folders cancelled	array of integer	Список идентификаторов конвертов, которые были успешно отменены.

Отмена подписки триггера веб-перехватчика

Идентификатор операции:: DeleteTriggerWebhookChannel

Удаляет активную подписку канала веб-перехватчика по идентификатору канала. Используйте это действие для очистки подписок веб-перехватчика, которые больше не нужны.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор канала	channelId	True	integer	Идентификатор канала веб-перехватчика для удаления.

Отправка напоминания о подписи

Идентификатор операции:: SendSignatureReminder

Отправляет уведомление о напоминании ожидающим получателям конверта, предлагая им завершить подпись.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор конверта	folderId	True	integer	Идентификатор конверта.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнен ли запрос успешно.
Идентификатор конверта	reminder sent	integer	Идентификатор конверта, для которого отправлено напоминание.

Перемещение конвертов в корзину

Идентификатор операции:: MoveEnvelopestoRecycleBin

Перемещает один или несколько конвертов в корзину. Конверты в корзине не удаляются окончательно.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы папок	folderIds	True	array of integer	Массив идентификаторов конвертов для действия.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнена ли операция успешно.

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

Идентификатор операции:: GetEnvelopeActivityHistory

Извлекает полный журнал действий для конверта, показывающий все действия, выполняемые получателями и отправителем.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор конверта	folderId	True	integer	Уникальный идентификатор конверта, журнал действий которого требуется извлечь.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнен ли запрос успешно.
Идентификатор конверта	details.folderId	integer	Уникальный идентификатор конверта.
Вложенные документы	details.enclosedDocuments	string	Имя документа, заключенного в конверт.
Получатели	details.envelopeRecipients	string	Имена всех получателей на конверте.
Author	details.author	string	Имя пользователя, создавшего конверт.
Статус	details.status	string	Текущее состояние конверта (например, SHARED, EXECUTED, CANCELLED).
Последняя дата действия	details.latestActivityDate	string	Дата и время последнего действия в конверте.
Дата создания	details.dateCreated	string	Дата и время создания конверта.
Дата отправки	details.dateSent	string	Дата и время отправки конверта получателям.
Мероприятия	details.activities	array of object	Хронологический список всех действий, выполненных на этом конверте.
Activity	details.activities.activity	string	Читаемое человеком описание действия, которое произошло.
Действие	details.activities.action	string	Тип выполняемого действия (например, "Создано", "Приглашение отправлено", "Открыто", "Просмотр", "Подписанный").
Пользователь	details.activities.user	string	Имя пользователя, выполнившего действие.
Состояние конверта	details.activities.folderStatus	string	Состояние конверта в то время, когда произошло это действие.
Time	details.activities.time	string	Дата и время выполнения действия.
Source	details.activities.source	string	Источник, из которого выполнялось действие (например, Интернет).
IP-адрес	details.activities.ipAddress	string	IP-адрес, из которого выполнялось действие, если он доступен.

Получение журнала удаленных конвертов

Идентификатор операции:: GetDeletedEnvelopeHistory

Извлекает журнал конвертов, которые были удалены или перемещены в корзину.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор конверта	folderId	True	string	Уникальный идентификатор конверта, журнал удаления которого требуется извлечь.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнен ли запрос успешно.
Удаленные сведения о конверте	Deleted Folder Log Info	array of object	Сводка сведений об удаленном конверте.
Идентификатор конверта	Deleted Folder Log Info.folderId	integer	Уникальный идентификатор удаленного конверта.
Имя конверта	Deleted Folder Log Info.folderName	string	Имя удаленного конверта.
Имя документа	Deleted Folder Log Info.documentName	string	Имя документа в удаленном конверте.
Код документа	Deleted Folder Log Info.documentId	string	Уникальный идентификатор документа в удаленном конверте.
Дата удаления	Deleted Folder Log Info.deletionDate	integer	Дата и время удаления конверта в миллисекундах Unix.
Удалено по	Deleted Folder Log Info.deletedBy	string	Имя пользователя, который удалил конверт.
Журнал журналов удаления	Deleted Folder Log History	array of object	Пошаговый журнал всех действий по удалению, выполненных на конверте.
Выполняется	Deleted Folder Log History.partiesName	string	Имя пользователя, выполнившего шаг удаления.
Source	Deleted Folder Log History.source	string	Источник, из которого было инициировано удаление (например, веб-интерфейс, API).
Event	Deleted Folder Log History.event	string	Определенное действие удаления (например, удаление папки, удаление всех сторон из папки).

Получение идентификаторов конверта

Идентификатор операции:: GetEnvelopeIds

Возвращает список идентификаторов конвертов, отфильтрованных по состоянию. Используйте это для поиска конвертов в определенном состоянии.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Дата из	dateFrom	True	string	Начало диапазона дат создания конверта. Принятый формат: ГГГГ-ММ-ДД.
Дата до	dateTo	True	string	Конец диапазона дат создания конверта. Принятый формат: ГГГГ-ММ-ДД. Значение dateTo должно находиться в течение 6 месяцев от значения dateFrom.
Статус	status		string	Фильтрация конвертов по состоянию. Принятые значения: ИСПОЛНЯЕМЫЕ, ОБЩИЕ, ЧЕРНОВИК, ЧАСТИЧНО ПОДПИСАННЫЕ, ОТМЕНЕННЫЕ, ПРОСРОЧЕННЫЕ, УДАЛЕННЫЕ. Если опущено, возвращаются конверты с любым состоянием.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнен ли запрос успешно.
Message	message	string	Сводное сообщение, указывающее, сколько идентификаторов конвертов возвращено.
Идентификаторы конвертов	allFolderIds	array of integer	Список идентификаторов конвертов, соответствующих критериям фильтра. Используйте эти идентификаторы с получением сведений о конверте для получения полных сведений о конверте.

Получение сведений о группе электронной почты

Идентификатор операции:: GetEmailGroupDetails

Извлекает сведения о существующей группе электронной почты.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имена групп электронной почты	emailGroupNames	True	array of string	Массив имен групп электронной почты, используемых для идентификации групп.

Возвращаемое значение

Имя	Путь	Тип	Описание
Группы электронной почты	allEmailGroups	array of object	Список групп электронной почты, соответствующих запрошенным именам групп.
Идентификатор группы	allEmailGroups.groupId	integer	Уникальный идентификатор группы электронной почты.
Имя группы	allEmailGroups.groupName	string	Имя группы электронной почты.
Описание группы	allEmailGroups.groupDesc	string	Описание группы электронной почты.
Дата создания	allEmailGroups.dateCreated	integer	Дата создания группы электронной почты в миллисекундах Unix.
Идентификатор компании	allEmailGroups.companyId	integer	Учетная запись компании, к которой принадлежит эта группа электронной почты.
Parties	allEmailGroups.parties	array of object	Список получателей в этой группе электронной почты.
Имя (Первое имя)	allEmailGroups.parties.firstName	string	Имя получателя.
Фамилия	allEmailGroups.parties.lastName	string	Фамилия получателя.
Адрес электронной почты	allEmailGroups.parties.emailId	string	Адрес электронной почты получателя.

Получение сведений о канале веб-перехватчика

Идентификатор операции:: GetWebhookChannelDetails

Извлекает сведения о конкретном канале веб-перехватчика.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор канала	channelId	True	string	Уникальный идентификатор извлекаемого канала веб-перехватчика.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнен ли запрос успешно.
Идентификатор	channel.channelId	integer	Уникальный идентификатор канала веб-перехватчика.
Идентификатор компании	channel.companyId	integer	Учетная запись компании, к которой принадлежит этот канал.
Name	channel.channelName	string	Имя канала веб-перехватчика.
URL-адрес вебхука	channel.webhookUrl	string	URL-адрес, который Foxit eSign будет вызывать при возникновении события подписки.
Секрет веб-перехватчика	channel.webhookSecret	string	Секретный ключ, используемый для проверки полезных данных веб-перехватчика.
Дата создания	channel.dateCreated	integer	Дата создания канала в миллисекундах Unix.
Дата обновления	channel.dateUpdated	integer	Дата последнего обновления канала в миллисекундах Unix.
Уровень веб-перехватчика	channel.webhookLevel	string	Область канала веб-перехватчика. Либо "Учетная запись" (триггеры для всех конвертов) или "ПРИЛОЖЕНИЕ API" (триггеры только для конвертов, созданных через API).
Статус	channel.status	string	Текущее состояние канала. Либо "активный", либо "деактивный".
Отправленный конверт	channel.eventsSubscribedMap.folder_sent	boolean	Активирует при отправке конверта получателям.
Просмотр конверта	channel.eventsSubscribedMap.folder_viewed	boolean	Активируется при открытии конверта получателем.
Подписанный конверт	channel.eventsSubscribedMap.folder_signed	boolean	Активируется при подписании конверта получателем.
Конверт отменен	channel.eventsSubscribedMap.folder_cancelled	boolean	Активирует при отмене конверта.
Конверт выполнен	channel.eventsSubscribedMap.folder_executed	boolean	Триггеры, когда все стороны подписали и конверт полностью выполняется.
Конверт удален	channel.eventsSubscribedMap.folder_deleted	boolean	Активирует при удалении конверта.

Получение сведений о конверте

Идентификатор операции:: GetEnvelopeDetails

Получает полные сведения о конверте, включая его состояние, получатели и документы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор конверта	folderId	True	integer	Уникальный идентификатор извлекаемого конверта.
Маркер доступа	access_token		string	Маркер доступа OAuth 2.0 для проверки подлинности.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнена ли операция успешно (например, "успешно").
Идентификатор	folder.folderId	integer	Уникальный идентификатор конверта.
Name	folder.folderName	string	Имя конверта.
Идентификатор автора	folder.folderAuthorId	integer	Уникальный идентификатор пользователя, создавшего конверт.
Имя автора	folder.folderAuthorFirstName	string	Первое имя создателя конверта.
Автор фамилии	folder.folderAuthorLastName	string	Фамилия создателя конверта.
Создание электронной почты	folder.folderAuthorEmail	string	Адрес электронной почты создателя конверта.
Роль автора	folder.folderAuthorRole	string	Роль учетной записи создателя конверта.
Идентификатор компании	folder.folderCompanyId	integer	Уникальный идентификатор компании, к которой принадлежит конверт.
Дата создания	folder.folderCreationDate	integer	Дата и время создания конверта в миллисекундах Unix.
Дата отправки	folder.folderSentDate	integer	Дата и время отправки конверта получателям в миллисекундах Unix. Значение NULL, если еще не отправлено.
Статус	folder.folderStatus	string	Текущее состояние конверта (например, SHARED, EXECUTED, ЧЕРНОВИК, ОТМЕНЕНО).
Идентификаторы документов	folder.folderDocumentIds	array of integer	Список идентификаторов документов, включенных в этот конверт.
Documents	folder.documentsList	array of object	Сведения о каждом документе, включенном в конверт.
Код документа	folder.documentsList.documentId	integer	Уникальный идентификатор документа.
Идентификатор контракта	folder.documentsList.contractId	integer	Уникальный идентификатор контракта, связанного с этим документом.
Идентификатор компании	folder.documentsList.companyId	integer	Уникальный идентификатор компании, к которой принадлежит этот документ.
Создано кем	folder.documentsList.contractCreatedBy	integer	Идентификатор пользователя, создавшего контракт.
Создано	folder.documentsList.contractCreatedOn	integer	Дата создания контракта в миллисекундах Unix.
Тип контракта	folder.documentsList.contractType	string	Тип или категория контракта.
Состояние документа	folder.documentsList.contractStatus	string	Текущее состояние подписи документа (например, WAITING_FOR_SIGNATURE, EXECUTED).
Возможно изменение	folder.documentsList.editable	boolean	Указывает, можно ли изменить документ.
Идентификатор версии	folder.documentsList.contractVersionId	integer	Уникальный идентификатор текущей версии документа.
Имя версии	folder.documentsList.contractVersionName	string	Имя текущей версии документа.
Описание версии	folder.documentsList.contractVersionDesc	string	Описание текущей версии документа.
Версия, созданная с помощью	folder.documentsList.versionCreatedby	integer	Идентификатор пользователя, создавшего эту версию документа.
Версия, созданная в	folder.documentsList.versionCreatedOn	integer	Дата создания этой версии документа в миллисекундах Unix.
Номер версии	folder.documentsList.contractVersionNumber	integer	Номер версии документа.
Получатели	folder.folderRecipientParties	array of object	Список получателей для этого конверта, включая состояние подписи и ссылки на доступ.
Идентификатор получателя	folder.folderRecipientParties.partyId	integer	Уникальный идентификатор получателя.
Идентификатор получателя	folder.folderRecipientParties.partyDetails.partyId	integer	Уникальный идентификатор получателя.
Имя (Первое имя)	folder.folderRecipientParties.partyDetails.firstName	string	Имя получателя.
Фамилия	folder.folderRecipientParties.partyDetails.lastName	string	Фамилия получателя.
Адрес электронной почты	folder.folderRecipientParties.partyDetails.emailId	string	Адрес электронной почты получателя.
Address	folder.folderRecipientParties.partyDetails.address	string	Адрес получателя.
Дата создания учетной записи	folder.folderRecipientParties.partyDetails.dateCreated	integer	Дата создания учетной записи получателя в миллисекундах Unix.
Разрешения	folder.folderRecipientParties.contractPermissions	string	Разрешения подписывания, предоставленные этому получателю (например, FILL_FIELDS_AND_SIGN).
Порядок подписывания	folder.folderRecipientParties.partySequence	integer	Позиция этого получателя в порядке подписи.
Последовательность рабочих процессов	folder.folderRecipientParties.workflowSignSequence	integer	Номер последовательности подписывания рабочего процесса для этого получателя.
Идентификатор конверта	folder.folderRecipientParties.envelopeId	integer	Идентификатор конверта, к которому принадлежит этот получатель.
Режим общего доступа	folder.folderRecipientParties.sharingMode	string	Метод, используемый для совместного использования документа с этим получателем (например, электронной почты).
URL-адрес подписывания	folder.folderRecipientParties.folderAccessURL	string	Уникальный URL-адрес подписи для этого получателя. Значение NULL, если конверт уже завершен или отменен.
Режим безопасности	folder.folderRecipientParties.securityMode	string	Режим безопасности, применяемый к доступу этого получателя.
Дополнительные комментарии	folder.folderRecipientParties.extraComments	string	Любые дополнительные комментарии, включенные в приглашение на подпись для этого получателя.
URL-адрес доступа для автора	folder.folderAccessURLForAuthor	string	URL-адрес автора конверта для доступа к документу. NULL, если неприменимо.
Массовый идентификатор	folder.bulkId	integer	Идентификатор пакета массовой отправки, к которому относится этот конверт, если он есть.
Принудительное применение порядка подписей	folder.enforceSignWorkflow	boolean	Указывает, должны ли получатели входить в указанный порядок.
Текущий шаг рабочего процесса	folder.currentWorkflowStep	integer	Текущий шаг в рабочем процессе подписывания.
Источник транзакций	folder.transactionSource	string	Источник, инициирующий эту транзакцию конверта.
Возможно изменение	folder.editable	boolean	Указывает, можно ли изменить конверт.
подписывание In-Person	folder.inPersonSignable	boolean	Указывает, может ли конверт быть вошедший в систему лично.
Переопределение напоминаний	folder.overrideAccountReminders	boolean	Указывает, переопределяются ли параметры напоминания на уровне учетной записи для этого конверта.
Идентификатор	folder.envelopeId	integer	Уникальный идентификатор конверта. То же значение, что и идентификатор конверта (folderId).
Name	folder.envelopeName	string	Имя конверта. То же значение, что и имя конверта (folderName).
Идентификатор инициатора	folder.envelopeOriginatorId	integer	Идентификатор пользователя, создавшего конверт.
Идентификатор компании	folder.envelopeCompanyId	integer	Идентификатор компании, к которой принадлежит конверт.
Date	folder.envelopeDate	integer	Дата и время создания конверта в миллисекундах Unix.
Общая дата	folder.envelopeSharedDate	integer	Дата и время совместного использования конверта получателями в миллисекундах Unix. Значение NULL, если еще не предоставлен общий доступ.
Статус	folder.envelopeStatus	string	Текущее состояние конверта. То же значение, что и состояние конверта (folderStatus).
Идентификаторы контрактов	folder.envelopeContractIds	array of integer	Список идентификаторов контрактов, связанных с этим конвертом.
Разрешения участника	folder.envelopePartyPermissions	array of object	Список получателей и их разрешений подписывания. Та же структура, что и получатели.
Идентификатор получателя	folder.envelopePartyPermissions.partyId	integer	Уникальный идентификатор получателя.
Имя (Первое имя)	folder.envelopePartyPermissions.partyDetails.firstName	string	Имя получателя.
Фамилия	folder.envelopePartyPermissions.partyDetails.lastName	string	Фамилия получателя.
Адрес электронной почты	folder.envelopePartyPermissions.partyDetails.emailId	string	Адрес электронной почты получателя.
Разрешения	folder.envelopePartyPermissions.contractPermissions	string	Разрешения подписывания для этого получателя.
Порядок подписывания	folder.envelopePartyPermissions.partySequence	integer	Позиция этого получателя в порядке подписи.
URL-адрес подписывания	folder.envelopePartyPermissions.folderAccessURL	string	Уникальный URL-адрес подписи для этого получателя.
Все поля	allFields	array of object	Список всех полей подписи и формы, помещенных в документы конверта.
Идентификатор поля	allFields.fieldTagId	integer	Уникальный идентификатор поля.
Код документа	allFields.contractId	integer	Идентификатор документа, к которому относится это поле.
Идентификатор версии	allFields.versionId	integer	Идентификатор версии документа, к которому относится это поле.
Тип поля	allFields.fieldType	string	Тип поля (например, signfield, textfield, datefield, checkboxfield, dropdownfield, initialfield).
Номер страницы	allFields.documentPageNumber	integer	Номер страницы, в котором размещено это поле.
Идентификатор документа поля	allFields.docFieldId	string	Идентификатор уровня документа для этого поля.
Ответственный участник	allFields.partyResponsible	integer	Идентификатор стороны, ответственный за заполнение этого поля.
Зависит	allFields.dependent	boolean	Указывает, зависит ли видимость этого поля от значения другого поля.
Обязательный	allFields.required	boolean	Указывает, нужно ли заполнить это поле перед отправкой документа.
Значение поля	allFields.value	string	Текущее значение поля, если заполнено.
Значения полей	allFieldsNameValue	array of object	Упрощенный список всех имен полей и их текущих значений. Используйте это для чтения заполненных данных поля из подписанного конверта.
Идентификатор поля	allFieldsNameValue.fieldId	integer	Уникальный идентификатор поля.
Код документа	allFieldsNameValue.documentId	integer	Идентификатор документа, к которому относится это поле.
Идентификатор версии	allFieldsNameValue.documentVersionId	integer	Идентификатор версии документа, к которому относится это поле.
Тип поля	allFieldsNameValue.fieldType	string	Тип поля (например, textfield, signfield, datefield, checkboxfield, dropdownfield).
Имя поля	allFieldsNameValue.name	string	Метка или имя поля, как определено в шаблоне.
Значение поля	allFieldsNameValue.value	string	Введенное или выбранное для этого поля значение.
Журнал конвертов	Folder History	array of object	Путь аудита всех действий, выполненных на этом конверте, в хронологическом порядке.
Имя (Первое имя)	Folder History.firstName	string	Первое имя человека, выполняющего действие.
Фамилия	Folder History.lastName	string	Фамилия лица, выполняющего действие.
Адрес электронной почты	Folder History.email	string	Адрес электронной почты пользователя, выполняющего действие.
Идентификатор конверта	Folder History.envelopeId	integer	Идентификатор конверта, на котором было выполнено действие.
Date	Folder History.dateChanged	integer	Дата и время выполнения действия в миллисекундах Unix.
ИД стороны	Folder History.changeDoneByParty	integer	Идентификатор стороны лица, выполняющего действие.
Действие	Folder History.action	string	Действие, выполненное на конверте (например, Created, InviteSentTo, InviteAccepted, Signed, Executed).

Получение сведений о шаблоне

Идентификатор операции:: GetTemplateDetails

Извлекает полные сведения о конкретном шаблоне, включая его поля и получатели.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ИД шаблона	templateId	True	string	Уникальный идентификатор извлекаемого шаблона.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнен ли запрос успешно.
Идентификатор	template.templateId	integer	Уникальный идентификатор шаблона.
Name	template.templateName	string	Имя шаблона.
Description	template.templateDesc	string	Описание шаблона.
Type	template.templateType	string	Тип шаблона.
Дата создания	template.templateCreationDate	integer	Дата создания шаблона в миллисекундах Unix.
Дата последнего обновления	template.templateLastUpdateDate	integer	Дата последнего обновления шаблона в миллисекундах Unix.
Возможно изменение	template.editable	boolean	Указывает, можно ли изменить шаблон.
Число сторон	template.numberOfParties	integer	Число сторон подписывания, определенных в шаблоне.
Всего страниц	template.totalPages	integer	Общее количество страниц в документе шаблона.
Идентификатор компании	template.companyId	integer	Учетная запись компании, к которой принадлежит шаблон.
Общий доступ ко всем	template.shareAll	boolean	Указывает, предоставлен ли шаблон всем пользователям в учетной записи.
Шаблон пользовательского имени	template.templateCustomName	string	Шаблон пользовательского имени, примененный к конвертам, созданным на основе этого шаблона.
Разрешения участника	template.templatePartyPermissions	array of object	Список ролей получателей и их разрешений подписывания, определенных в этом шаблоне.
ИД стороны	template.templatePartyPermissions.template_party_id	integer	Уникальный идентификатор записи участника шаблона.
Идентификатор	template.templatePartyPermissions.templateId	integer	Идентификатор шаблона, к которому принадлежит эта сторона.
Разрешения	template.templatePartyPermissions.templatePermissions	string	Разрешения подписывания для этой стороны (например, FILL_FIELDS_AND_SIGN).
Порядок подписывания	template.templatePartyPermissions.partySequence	integer	Позиция заказа подписывания для этой стороны.
Роль участника	template.templatePartyPermissions.templatePartyRole	string	Имя роли, назначенное этой стороне. Используйте это значение при создании конверта из этого шаблона.
ИД стороны	template.templatePartyPermissions.partyId	integer	Идентификатор стороны, назначенной этой роли, при предварительной назначении.
ИД стороны	template.templateCreatedBy.partyId	integer	Уникальный идентификатор пользователя.
Имя (Первое имя)	template.templateCreatedBy.firstName	string	Имя пользователя.
Фамилия	template.templateCreatedBy.lastName	string	Фамилия пользователя.
Адрес электронной почты	template.templateCreatedBy.emailId	string	Адрес электронной почты пользователя.
Отдел	template.templateCreatedBy.department	string	Подразделение пользователя.
Название	template.templateCreatedBy.title	string	Название задания пользователя.
Активный	template.templateCreatedBy.active	boolean	Указывает, активна ли учетная запись пользователя.
ИД стороны	template.templateLastUpdatedBy.partyId	integer	Уникальный идентификатор пользователя.
Имя (Первое имя)	template.templateLastUpdatedBy.firstName	string	Имя пользователя.
Фамилия	template.templateLastUpdatedBy.lastName	string	Фамилия пользователя.
Адрес электронной почты	template.templateLastUpdatedBy.emailId	string	Адрес электронной почты пользователя.
Отдел	template.templateLastUpdatedBy.department	string	Подразделение пользователя.
Название	template.templateLastUpdatedBy.title	string	Название задания пользователя.
Активный	template.templateLastUpdatedBy.active	boolean	Указывает, активна ли учетная запись пользователя.
Все поля	allfields	array of object	Список всех полей, определенных в этом шаблоне.
Идентификатор тега поля	allfields.fieldTagId	integer	Уникальный идентификатор поля.
ИД шаблона	allfields.templateId	integer	Идентификатор шаблона, к которому принадлежит это поле.
Идентификатор компании	allfields.companyId	integer	Учетная запись компании, к которой относится это поле.
Тип поля	allfields.fieldType	string	Тип поля (например, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Номер страницы	allfields.documentPageNumber	integer	Номер страницы документа, в котором размещено это поле.
Ответственный участник	allfields.partyResponsible	integer	Номер последовательности сторон, отвечающий за выполнение этого поля.
Последовательность сторон	allfields.partyResponsibleSequence	integer	Последовательность позиции ответственной стороны.
Идентификатор поля документа	allfields.docFieldId	string	Идентификатор этого поля в документе.
Зависимый	allfields.dependent	boolean	Указывает, зависит ли видимость этого поля от значения другого поля.
Порядок вкладок	allfields.tabOrder	integer	Порядок вкладок для навигации между полями.
Обязательный	allfields.required	boolean	Указывает, должно ли это поле быть завершено до того, как документ можно будет подписать.
Имя настраиваемого поля	allfields.customFieldName	string	Настраиваемое имя, назначенное этому полю.
Общий доступ ко всем	allfields.shareAll	boolean	Указывает, является ли это поле общим для всех пользователей.
Разрешить редактирование	allfields.allowEdit	boolean	Указывает, можно ли изменить это поле получателем.
Имя текстового поля	allfields.textfieldName	string	Метка текстового поля (применимо, если fieldType — textfield).
Ценность	allfields.value	string	Предварительно заполненное или введенное значение поля.
Размер шрифта	allfields.fontSize	integer	Размер шрифта, используемый для текста в этом поле.
Цвет шрифта	allfields.fontColor	string	Цвет шрифта, используемый для текста в этом поле (например, #000000).
Только для чтения	allfields.readOnly	boolean	Указывает, доступно ли поле только для чтения и не может быть изменено получателем.
Многострочный	allfields.multiLine	boolean	Указывает, принимает ли текстовое поле несколько строк входных данных (применимо, если fieldType — textfield).
Ограничение символов	allfields.characterLimit	integer	Максимальное число символов, разрешенных в поле (применимо, если fieldType — textfield).
Имя поля даты	allfields.datefieldName	string	Метка поля даты (применимо, если fieldType — datefield).
Формат даты	allfields.dateFormat	string	Формат даты, используемый этим полем (например, MM/DD/YYYY) (применимо, если тип поля — datefield).
Имя флажка	allfields.cbname	string	Метка поля флажка (применимо, если fieldType — checkboxfield).
Группа флажков	allfields.cbgroup	string	Имя группы для этого флажка, используемое при связывании нескольких флажков (применимо, если fieldType — checkboxfield).
Проверено	allfields.checked	boolean	Указывает, установлен ли флажок по умолчанию (применимо, если параметр fieldType имеет значение checkboxfield).
Имя защищенного поля	allfields.securedfieldName	string	Метка защищенного поля (применимо, если fieldType — securedfield).
Символы для отображения	allfields.charToDisplay	integer	Число незамаскированных символов, отображаемых в конце значения защищенного поля (применимо, если fieldType — securedfield).
Идентификатор подписи	allfields.signatureId	string	Идентификатор подписи, примененной к этому полю знака (применимо, если fieldType имеет значение Signfield).
Начальное изображение	allfields.initialImage	string	Данные изображения для инициал, примененных к этому полю (применимо, если fieldType — initialfield).
Имя поля вложения	allfields.attachmentfieldName	string	Имя поля вложения (применимо, если fieldType — attachmentfield).
Описание вложения	allfields.attachmentfieldDescription	string	Описание того, что нужно подключить (применимо, если fieldType имеет значение "attachmentfield".

Получение списка всех шаблонов

Идентификатор операции:: GetalistofallTemplates

Возвращает список всех шаблонов, доступных в вашей учетной записи.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнен ли запрос успешно.
Всего шаблонов	total_templates	integer	Общее количество шаблонов в вашей учетной записи.
Список шаблонов	templatesList	array of object	Список всех шаблонов, доступных в учетной записи.
ИД шаблона	templatesList.templateId	integer	Уникальный идентификатор шаблона. Используйте этот идентификатор с созданием конверта из шаблона для отправки шаблона для подписывания.
Имя шаблона	templatesList.templateName	string	Имя шаблона.
Описание шаблона	templatesList.templateDesc	string	Описание шаблона.
Тип шаблона	templatesList.templateType	string	Тип или категория шаблона.
Дата создания	templatesList.templateCreationDate	integer	Дата создания шаблона в миллисекундах Unix.
Дата последнего обновления	templatesList.templateLastUpdateDate	integer	Дата последнего обновления шаблона в миллисекундах Unix.
Возможно изменение	templatesList.editable	boolean	Указывает, можно ли изменить шаблон.
Число сторон	templatesList.numberOfParties	integer	Число сторон подписывания, определенных в шаблоне.
Идентификатор компании	templatesList.companyId	integer	Учетная запись компании, к которой принадлежит шаблон.
Общий доступ ко всем	templatesList.shareAll	boolean	Указывает, предоставлен ли шаблон всем пользователям в учетной записи.
ИД стороны	templatesList.templateCreatedBy.partyId	integer	Уникальный идентификатор пользователя.
Имя (Первое имя)	templatesList.templateCreatedBy.firstName	string	Имя пользователя.
Фамилия	templatesList.templateCreatedBy.lastName	string	Фамилия пользователя.
Адрес электронной почты	templatesList.templateCreatedBy.emailId	string	Адрес электронной почты пользователя.
ИД стороны	templatesList.templateLastUpdatedBy.partyId	integer	Уникальный идентификатор пользователя.
Имя (Первое имя)	templatesList.templateLastUpdatedBy.firstName	string	Имя пользователя.
Фамилия	templatesList.templateLastUpdatedBy.lastName	string	Фамилия пользователя.
Адрес электронной почты	templatesList.templateLastUpdatedBy.emailId	string	Адрес электронной почты пользователя.

Получение шаблонов по идентификаторам шаблонов

Идентификатор операции:: GetTemplatesbyTemplateIds

Извлекает сведения для одного или нескольких шаблонов по идентификаторам.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы шаблона	templateIds	True	array of integer	Массив идентификаторов шаблонов для получения.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнен ли запрос успешно.
Всего шаблонов	total_templates	integer	Общее количество возвращаемых шаблонов.
Список шаблонов	templateIdList	object	Карта данных шаблона, ключом к которым является идентификатор шаблона. Каждая запись содержит сведения о шаблоне и его поля.

Скачивание PDF-файла с одним документом

Идентификатор операции:: DownloadSingleDocumentPDF

Загружает один документ из конверта в виде PDF-файла.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор конверта	folderId	True	string	Уникальный идентификатор конверта, содержащего документ для скачивания.
Номер документа	docNumber	True	string	Индекс документа, который нужно скачать, начиная с 1.

Возвращаемое значение

response: binary

Скачивание отчета

Идентификатор операции:: DownloadReport

Загружает отчет о действиях конверта в виде файла Microsoft Excel. Используйте фильтры, чтобы сузить результаты по состоянию, диапазону дат, имени конверта, автору или подписи.

Параметры

Имя	Ключ	Тип	Описание
envelopeStatus	status	string	Состояния папки, по которой мы отфильтруем отчет
Дата создания из	creationDateFrom	string	Начало диапазона дат создания. Принятый формат: ГГГГ-ММ-ДД.
Дата создания	creationDateTo	string	Конец диапазона дат создания. Принятый формат: ГГГГ-ММ-ДД.
Имя конверта	folderName	string	Любая папка, содержащая эту строку.
Включение полей	includeFields	string	Задайте значение true, чтобы включить значения поля конверта в отчет. По умолчанию используется значение false.
Создание электронной почты	authorEmail	string	Отфильтруйте отчет, чтобы включить только конверты, созданные этим адресом электронной почты автора.
Электронная почта подписывющего средства	signerEmail	string	Отфильтруйте отчет, чтобы включить только конверты, в которых этот адрес электронной почты является подписывающей.

Возвращаемое значение

Файл отчета: binary

Скачивание файлов конверта

Идентификатор операции:: DownloadEnvelopeFiles

Загружает завершенные документы из конверта в виде файла.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор конверта	folderId	True	string	Уникальный идентификатор конверта, документы которого необходимо скачать.

Возвращаемое значение

response: binary

Создание группы электронной почты

Идентификатор операции:: CreateEmailGroup

Создает новую группу электронной почты, которую можно использовать для отправки конвертов нескольким получателям одновременно.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя группы	emailGroupName	True	string	Имя новой группы электронной почты.
Описание группы	emailGroupDescription		string	Необязательное описание группы электронной почты.
Разрешить расширенную проверку электронной почты	allowAdvancedEmailValidation		boolean	При включении Foxit eSign проверяет, доступны ли все адреса электронной почты в группе перед отправкой.
Имя (Первое имя)	firstName	True	string	Имя получателя.
Фамилия	lastName	True	string	Фамилия получателя.
Адрес электронной почты	emailId	True	string	Адрес электронной почты получателя.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнен ли запрос успешно.
Message	message	string	Сообщение подтверждения для выполняемого действия.
Идентификатор группы	emailGroup.groupId	integer	Уникальный идентификатор группы электронной почты. Используйте этот идентификатор при отправке конвертов в группу.
Имя группы	emailGroup.groupName	string	Имя группы электронной почты.
Описание группы	emailGroup.groupDesc	string	Описание группы электронной почты.
Дата создания	emailGroup.dateCreated	integer	Дата создания группы электронной почты в миллисекундах Unix.
Идентификатор компании	emailGroup.companyId	integer	Учетная запись компании, к которой принадлежит эта группа электронной почты.
Parties	emailGroup.parties	array of object	Список получателей в группе электронной почты.
Имя (Первое имя)	emailGroup.parties.firstName	string	Имя получателя.
Фамилия	emailGroup.parties.lastName	string	Фамилия получателя.
Адрес электронной почты	emailGroup.parties.emailId	string	Адрес электронной почты получателя.

Создание конверта из Base64

Идентификатор операции:: CreateEnvelopefromBase64

Создает и отправляет конверт с помощью pdf-документа с кодировкой Base64.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя конверта	folderName	True	string	Имя этого конверта.
Тип ввода	inputType		string	Тип входных данных для источника документа. Исправлено значение base64 для этого действия.
Строки файла Base64	base64FileString	True	array of string	Массив документов PDF в кодировке Base64 для отправки.
Имена файлов	fileNames	True	array of string	Массив отображаемых имен для каждого документа в том же порядке, что и массив строк файлов Base64.
Имя (Первое имя)	firstName	True	string	Имя получателя.
Фамилия	lastName	True	string	Фамилия получателя.
Адрес электронной почты	emailId	True	string	Адрес электронной почты получателя.
permissions	permission	True	string
Последовательность	sequence	True	integer	Используйте это поле, чтобы назначить получателю порядковый номер в списке сторон-получателей. Используйте уникальные порядковые номера для каждой стороны, начиная с 1, например 1,2,3,4.... Если один пользователь отображается несколько раз в рабочем процессе подписывания, назначьте другую последовательность каждый раз, когда получатель повторяется.
signerAuthLevels	signerAuthLevel		string	Уровень проверки подлинности, который подписыватель будет использовать в целях проверки
Заполнитель	isPlaceholder		boolean	Используйте это поле для инициирования стороной заполнителя. Примечание. 1. Значение параметра firstName, lastName, emailId должно быть пустым для этой стороны. 2. Чтобы добавить заполнитель, один получатель должен быть переквалван с разрешением "PARTY_ASSIGNER".
Роль получателя	partyRole		string	Используйте это поле для назначения роли заполнителя.
Разрешить изменение имени	allowNameChange		string	Значение может иметь значение true или false. Этот параметр позволяет подписывшему обновлять имя и фамилию перед завершением процесса подписывания.
Последовательность рабочих процессов	workflowSequence		integer	Назначьте этому получателю порядковый номер рабочего процесса. Если включена последовательность входа, получатели получают приглашение на подписывание в порядке последовательности по возрастанию.
Идентификатор электронной почты узла	hostEmailId		string	Адрес электронной почты администратора In-Person.
Код доступа	userDefinedAccessCode		string	Параметр будет содержать код доступа, если значение signerAuthLevel задано как "Определяемый пользователем код доступа" для проверки подлинности. Примечание. 1. Коды не учитывает регистр. 2. Система не отправляет этот код, поэтому необходимо предоставить общий доступ к этому коду напрямую с подписывателем. 3. Код доступа может содержать алфавиты, числа и следующие специальные символы: @,&,{,},%,(),~,\|,!,+,^.
Партия — группа электронной почты	partyIsEmailGroup		boolean	Используйте этот параметр при создании участника в качестве массового. Примечание: Если этот параметр имеет значение true, firstName, lastName и emailId этой стороны будут игнорироваться.
Идентификатор группы электронной почты	emailGroupId		integer	Передайте адрес электронной почты идентификатор группы, который вы хотите использовать для массового создания.
Массовая операция единого входа	allowSingleSignerInBulk		boolean	Используйте этот параметр, чтобы разрешить вход только одному пользователю в группу электронной почты.
Код набора	dialingCode		string	Используйте это поле для назначения кодов телефонного номера страны— это префиксы мобильного номера получателю в списке получателей.
Номер мобильного устройства	mobileNumber		string	Используйте это поле для назначения мобильного номера получателю в списке сторон-получателей.
Поля	Fields		object
Отправить сейчас	sendNow		boolean	При включении Foxit eSign немедленно отправляет уникальную ссылку подписи на адрес электронной почты каждого получателя. Отключите это, чтобы сохранить конверт в виде черновика.
Создание внедренного сеанса подписывания	createEmbeddedSigningSession	True	boolean	Маркер сеанса подписывания будет создан без отправки сообщений электронной почты получателям.
Создание внедренного сеанса подписи для всех сторон	createEmbeddedSigningSessionForAllParties		boolean	Если задано значение true, внедренный URL-адрес подписи будет создан для каждого получателя в конверте.
Обработка текстовых тегов	processTextTags	True	boolean	Значение может иметь значение true или false. Это поле используется для определения того, должен ли Foxit eSign анализировать документы для текстовых тегов, чтобы преобразовать их в поля Foxit eSign.
Обработка полей Acro	processAcroFields	True	boolean	Это поле используется для определения того, следует ли Foxit eSign анализировать документы для AcroFields, чтобы преобразовать их в поля Foxit eSign.
Последовательность входа	signInSequence		boolean	Это поле используется для определения того, будут ли получатели подписывать документы конверта в последовательности. Если значение false, все получатели получают приглашение по электронной почте одновременно. Когда значение true, каждый получатель получает приглашение по электронной почте последовательно после того, как предыдущий получатель завершает требуемую задачу, например подписывание документов или полей заполнения и т. д.
Включение пользователя	inPersonEnable		boolean	Это поле используется для запуска процесса подписи пользователя, который можно легко завершить на любом устройстве в течение нескольких минут и избегает подписей на основе электронной почты, где это необходимо. Если значение false, все получатели получают приглашение по электронной почте одновременно. Когда значение true, администратор получает приглашение, чтобы инициировать процесс подписывания для подписывчика.
Исправление сторон получателя	fixRecipientParties		boolean	Если значение true, то в внедренном представлении отправки не удается изменить стороны конверта, которые уже добавлены в рамках этого запроса.
Исправление документов	fixDocuments		boolean	Если значение true, то в внедренной отправке не удается изменить документы для конверта, который уже добавлен в рамках этого запроса.
Отправить URL-адрес успешного выполнения	sendSuccessUrl		string	Введите абсолютный URL-адрес целевой страницы, на которую подписыватель будет перенаправлен после успешной отправки папки в внедренном представлении отправки.
Url-адрес ошибки отправки	sendErrorUrl		string	Введите абсолютный URL-адрес целевой страницы, на которую подписыватель будет перенаправлен, если ошибка возникает во время отправки папки в внедренном представлении отправки.
Создание внедренного сеанса отправки	createEmbeddedSendingSession		boolean	Если задано значение true, он создаст внедренный маркер для открытия представления подготовки документа Foxit eSign.
Встроенные идентификаторы электронной почты подписывания	embeddedSignersEmailIds		array of string	Массив идентификаторов электронной почты получателей, для которых необходимо создать внедренный сеанс подписи. Идентификаторы электронной почты от получателей, добавленные в список сторон.
Url-адрес успешности подписывания	signSuccessUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены после успешного входа в внедренное представление подписи.
URL-адрес отклонения подписи	signDeclineUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены, если отказ в входе в внедренное представление подписывания.
Url-адрес для входа позже	signLaterUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены, если вы решите войти позже в внедренном представлении подписи.
URL-адрес ошибки подписи	signErrorUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены на сообщение об ошибке при подписании документа в внедренном представлении подписывания.
Разрешить отправку и внедренный сеанс подписи	allowSendNowAndEmbeddedSigningSession		boolean	Если задано значение true, Foxit eSign отправит уникальную ссылку подписи каждому получателю. Это применимо только при отправке параметровNow и createEmbeddedSigningSession.
Расширенная проверка электронной почты	allowAdvancedEmailValidation		boolean	Проверьте адрес электронной почты сторон, если задано значение true.
Подписать URL-адрес успешности всех сторон	signSuccessUrlAllParties		boolean	Если задано значение true, подписыватель будет перенаправлен на URL-адрес, предоставленный в signSuccessUrl после успешного подписания. Это применимо только в том случае, если значение sendNow имеет значение true.
Идентификатор шаблона электронной почты	emailTemplateId		integer	Передайте идентификатор шаблона электронной почты, чтобы отправить шаблоны электронной почты, отличные от шаблонов электронной почты по умолчанию.
Идентификатор инструкции signer	signerInstructionId		integer	Передайте идентификатор инструкции для отправки инструкций подписи, отличных от инструкций подписи по умолчанию.
Идентификатор инструкции подтверждения	confirmationInstructionId		string	Передайте идентификатор инструкции подтверждения для отправки инструкций подтверждения, отличных от инструкций по умолчанию.
Цвет темы	themeColor		string	Введите значение CSS, чтобы задать цвет темы.
Срок действия сеанса	sessionExpire		boolean	Задайте значение true, чтобы инициировать срок действия внедренного сеанса подписи.
Истечение срока	expiry		integer	Требуется, если sessionExpire имеет значение true. Введите длительность в миллисекундах истечения срока действия в внедренном сеансе подписи.
Имя зависимого поля	dependentFieldName	True	string	Имя поля, видимость которого контролируется родительским полем.
Имя родительского поля	parentFieldName	True	string	Имя родительского поля, значение которого управляет видимостью зависимого поля. Поддерживаемые типы родительских полей: textfield, textbox, checkbox, radiobutton, раскрывающийся список.
Значение родительского поля	parentFieldValue	True	string	Значение родительского поля, которое активирует зависимое поле, чтобы стать видимым. Для полей флажка и переключателя используйте флажок или снятый флажок.
Options	options	True	string	Дополнительные параметры сопоставления для текстовых родительских полей. Допустимые значения: isblank, allowNull, содержит.
Metadata	metadata		object	Это должно быть в паре значений ключа. Разрешено не более 1000 пар значений ключей.
Электронная почта отправителя	senderEmail		string	введите сообщение электронной почты другого пользователя в учетной записи, которая будет использоваться для отправки этой папки документа участникам получателя.
Кнопка "Скрыть добавить меня"	hideAddMeButton		boolean	Если значение true, оно скрывает кнопку "Добавить меня" для получателей в внедренном сеансе отправки.
Скрыть кнопку "Добавить новую"	hideAddNewButton		boolean	Если значение true, оно скрывает кнопку "Добавить новый" для получателей в внедренном сеансе отправки.
Кнопка "Скрыть добавление группы"	hideAddGroupButton		boolean	Если значение true, оно скрывает кнопку "Добавить группу" для получателей в внедренном сеансе отправки.
Скрытие имени поля для получателей	hideFieldNameForRecipients		boolean	Скрытие имен полей получателей для полей записи данных и расширенных полей. (Кроме переключателя, флажка, изображения и гиперссылки).
Скрытие границы флажка	hideCheckboxBorder		boolean	Границы флажка будут скрыты в исполняемых документах.
Параметр выбора средства скрытия подписывателя	hideSignerSelectOption		boolean	Если задано значение true, оно скрывает поле ввода "Существующее имя и электронная почта" для получателей в внедренном сеансе отправки.
Скрытие действий подписи	hideSignerActions		boolean	Если значение true, оно скрывает подписыватель "изменить", "изменить" и "удалить" действия для получателей в внедренном сеансе отправки.
Скрыть имя отправителя	hideSenderName		boolean	Если значение true, оно скрывает имя отправителя на получателях в внедренном сеансе отправки.
Скрыть имя папки	hideFolderName		boolean	Если задано значение true, имя папки будет скрыто при навигации в обоих внедренных сеансах.
Скрытие имени документов	hideDocumentsName		boolean	Если значение true, оно скрывает имя документа в обоих внедренных сеансах.
Скрыть отклонить знак	hideDeclineToSign		boolean	Если значение true, оно скрывает параметр "Отклонить знак" для подписывчика.
Скрытие дополнительных действий	hideMoreAction		boolean	Если задано значение true, кнопка "Дополнительные действия" будет скрыта при отправке и подписи сеанса. В случае "Отправить сейчас": true, он не будет скрывать ничего.
Кнопка "Скрыть отправку"	hideSendButton		boolean	Если задано значение true, кнопка "Отправить" будет скрыта во встроенном сеансе отправки.
Скрыть следующее обязательное полеbtn	hideNextRequiredFieldbtn		boolean	Если задано значение true, скрывает кнопку навигации, которая перемещает подписывающих элементов в следующее необходимое поле.
Обязательный внедренный сеанс	requiredBothEmbeddedSession		boolean	Если значение true, оно создаст внедренные URL-адреса отправки и подписывания вместе.
Пароль конверта	folderPassword		string	Этот пароль потребуется для входа или автора, чтобы открыть документ с цифровой подписью. Если параметр остается пустым, пароль не потребуется для открытия документа с цифровой подписью.
Включение пошаговые шаги	enableStepByStep		boolean	Чтобы включить пошаговое действие в внедренном сеансе отправки.
Скрытие параметра "Добавить стороны"	hideAddPartiesOption		boolean	Если задано значение true, параметр добавления сторон будет скрыт в режиме создания черновика и шаблона.
Самозаверять	selfSign		boolean	Он включает встроенный самостоятельный вход через API. Этот параметр применяется только в том случае, если параметр createEmbeddedSendingSession имеет значение true.
Url-адрес успешности самозаверяющего входа	selfSignerSuccessUrl		string	Введите абсолютный URL-адрес целевой страницы на веб-сайте или приложении, на который пользователь будет перенаправлен после успешной отправки папки в внедренном представлении отправки.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	folder.folderId	integer	Уникальный идентификатор только что созданного конверта. Используйте это в последующих действиях для ссылки на этот конверт.
Name	folder.folderName	string	Имя только что созданного конверта.
Пользовательское имя	folder.folderCustomName	string	Настраиваемое имя конверта.
Password	folder.folderPassword	string	Пароль доступа для конверта, если задан.
Идентификатор создателя	folder.folderAuthorId	integer	Уникальный идентификатор создателя конверта.
Имя создателя	folder.folderAuthorFirstName	string	Имя создателя конверта.
Фамилия создателя	folder.folderAuthorLastName	string	Фамилия создателя конверта.
Создатель электронной почты	folder.folderAuthorEmail	string	Адрес электронной почты создателя конверта.
Роль создателя	folder.folderAuthorRole	string	Роль создателя конверта.
Идентификатор компании	folder.folderCompanyId	integer	Уникальный идентификатор компании, которая владеет конвертом.
Дата создания	folder.folderCreationDate	integer	Дата создания конверта (метка времени Unix в миллисекундах).
Дата отправки	folder.folderSentDate	integer	Дата отправки конверта (метка времени Unix в миллисекундах).
Статус	folder.folderStatus	string	Текущее состояние конверта.
Настраиваемое поле 1	folder.custom_field1	string	Первое настраиваемое поле метаданных для конверта.
Настраиваемое поле 2	folder.custom_field2	string	Второе поле настраиваемых метаданных для конверта.
Metadata	folder.metadata	string	Пользовательские метаданные, связанные с конвертом.
Идентификаторы документов	folder.folderDocumentIds	array of integer	Список идентификаторов документов, содержащихся в конверте.
Documents	folder.documentsList	array of object	Список документов в конверте.
Код документа	folder.documentsList.documentId	integer	Уникальный идентификатор документа.
Идентификатор контракта	folder.documentsList.contractId	integer	Уникальный идентификатор контракта.
Идентификатор компании	folder.documentsList.companyId	integer	Уникальный идентификатор компании.
Создано кем	folder.documentsList.contractCreatedBy	integer	Идентификатор пользователя, создавшего контракт.
Создано	folder.documentsList.contractCreatedOn	string	Дата и время создания контракта.
Тип контракта	folder.documentsList.contractType	string	Тип контракта.
Состояние контракта	folder.documentsList.contractStatus	string	Текущее состояние контракта.
Возможно изменение	folder.documentsList.editable	boolean	Указывает, является ли элемент редактируемым.
Идентификатор версии	folder.documentsList.contractVersionId	integer	Уникальный идентификатор версии контракта.
Имя версии	folder.documentsList.contractVersionName	string	Имя версии контракта.
Описание версии	folder.documentsList.contractVersionDesc	string	Описание версии контракта.
Версия, созданная с помощью	folder.documentsList.versionCreatedby	integer	Идентификатор пользователя, создавшего эту версию.
Версия, созданная в	folder.documentsList.versionCreatedOn	string	Дата и время создания этой версии.
Номер версии	folder.documentsList.contractVersionNumber	integer	Номер версии контракта.
Источник транзакций	folder.documentsList.contractTransactionSource	string	Исходная система, инициирующая транзакцию контракта.
Получатели	folder.folderRecipientParties	array of object	Список получателей для этого конверта.
Идентификатор получателя	folder.folderRecipientParties.partyId	integer	Уникальный идентификатор получателя.
Идентификатор получателя	folder.folderRecipientParties.partyDetails.partyId	integer	Уникальный идентификатор получателя.
Имя (Первое имя)	folder.folderRecipientParties.partyDetails.firstName	string	Имя получателя.
Фамилия	folder.folderRecipientParties.partyDetails.lastName	string	Фамилия получателя.
Адрес электронной почты	folder.folderRecipientParties.partyDetails.emailId	string	Адрес электронной почты получателя.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Указывает, является ли эта сторона получателем заполнителя.
Address	folder.folderRecipientParties.partyDetails.address	string	Физический адрес получателя.
Дата создания	folder.folderRecipientParties.partyDetails.dateCreated	integer	Дата создания записи (метка времени Unix в миллисекундах).
Отказ от сообщений электронной почты	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Указывает, отказался ли получатель от уведомлений по электронной почте.
Уникальный идентификатор получателя	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Уникальный системный идентификатор для этого получателя.
Уровень проверки подлинности	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Метод проверки подлинности, необходимый для этого получателя.
Дата обновления пароля	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Дата последнего обновления пароля.
Состояние обновления пароля	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Указывает, был ли обновлен пароль.
Идентификатор компании	folder.folderRecipientParties.partyDetails.companyId	integer	Уникальный идентификатор компании.
Роль пользователя	folder.folderRecipientParties.partyDetails.userRole	string	Роль, назначенная пользователю.
Отдел	folder.folderRecipientParties.partyDetails.department	string	Отдел, к которому принадлежит пользователь.
Название	folder.folderRecipientParties.partyDetails.title	string	Название задания пользователя.
Активный	folder.folderRecipientParties.partyDetails.active	boolean	Указывает, активен ли пользователь или запись.
Locale	folder.folderRecipientParties.partyDetails.requestLocale	string	Параметр языкового стандарта для пользователя.
Совместное использование с Dept	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Указывает, являются ли конверты общими для отдела.
Код набора	folder.folderRecipientParties.partyDetails.dialingCode	string	Международный телефонный код для номера телефона.
Номер мобильного устройства	folder.folderRecipientParties.partyDetails.mobileNumber	string	Номер мобильного телефона.
Фильтр состояния	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Фильтр состояния документа.
Фильтр по дате	folder.folderRecipientParties.partyDetails.docDateFilter	string	Фильтр для даты документа.
Безопасный доступ к полю	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Указывает, имеет ли пользователь доступ к защищенным полям.
Разверните боковую панель	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Указывает, развернута ли боковая панель по умолчанию.
Adv. Проверка электронной почты	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Указывает, включена ли расширенная проверка электронной почты.
Идентификатор диспетчера	folder.folderRecipientParties.partyDetails.managerId	string	Уникальный идентификатор руководителя пользователя.
Число входа	folder.folderRecipientParties.partyDetails.loginCount	integer	Количество попыток входа пользователя.
Электронная почта сброса пароля	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Указывает, следует ли отправлять электронную почту сброса пароля.
Идентификатор отдела	folder.folderRecipientParties.partyDetails.departmentId	string	Уникальный идентификатор отдела.
Основная компания	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Основная компания, связанная с пользователем.
Тип устройства	folder.folderRecipientParties.partyDetails.deviceType	string	Тип используемого устройства.
Токен устройства	folder.folderRecipientParties.partyDetails.deviceToken	string	Маркер push-уведомлений для устройства.
Описание субподрядчика	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Описание субподрядчика или внешнего подписывателя.
Организация субподрядчика	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Имя организации субподрядчика или внешнего подписчика.
Дата добавления субподрядчика	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Дата добавления субподрядчика (метка времени Unix в миллисекундах).
Source	folder.folderRecipientParties.partyDetails.source	string	Исходная система, из которой добавлен внешний подписыватель.
Код набора	folder.folderRecipientParties.dialingCode	string	Международный телефонный код для номера телефона.
Номер мобильного устройства	folder.folderRecipientParties.mobileNumber	string	Номер мобильного телефона.
Тип подписи	folder.folderRecipientParties.signerSignatureType	string	Тип подписи, который будет использовать подписыватель.
Разрешения	folder.folderRecipientParties.contractPermissions	string	Разрешения, предоставленные этой стороне для контракта.
Порядок подписывания	folder.folderRecipientParties.partySequence	integer	Порядковый номер заказа подписи для этого получателя.
Последовательность рабочих процессов	folder.folderRecipientParties.workflowSignSequence	integer	Порядковый номер подписывания рабочего процесса.
Идентификатор конверта	folder.folderRecipientParties.envelopeId	integer	Уникальный идентификатор конверта.
Идентификатор компании-получателя	folder.folderRecipientParties.partyCompanyId	integer	Уникальный идентификатор компании, связанной с этим получателем.
Режим общего доступа	folder.folderRecipientParties.sharingMode	string	Режим общего доступа для этого конверта.
URL-адрес доступа получателя	folder.folderRecipientParties.folderAccessURL	string	URL-адрес получателя может использовать для доступа и подписывания конверта.
Режим безопасности	folder.folderRecipientParties.securityMode	string	Режим безопасности, применяемый к этому конверту.
Comments	folder.folderRecipientParties.extraComments	string	Дополнительные комментарии, включенные в конверт.
Разрешить изменение имени	folder.folderRecipientParties.allowNameChange	boolean	Указывает, разрешено ли получателю обновлять свое имя.
Обновлено имя	folder.folderRecipientParties.signerNameUpdated	boolean	Указывает, обновил ли подписыватель свое имя.
Уровень проверки подлинности подписи	folder.folderRecipientParties.signerAuthenticationLevel	string	Уровень проверки подлинности, необходимый для входа.
Код доступа	folder.folderRecipientParties.userDefinedAccessCode	string	Код пользовательского доступа, определенный для подписателя.
Идентификатор подписи	folder.folderRecipientParties.signatureId	string	Уникальный идентификатор подписи.
Роль получателя	folder.folderRecipientParties.partyRole	string	Роль, назначенная этому получателю в рабочем процессе подписывания.
Поле компании	folder.folderRecipientParties.companyFieldValue	string	Значение поля имени компании в сигнатуре.
Поле заголовка	folder.folderRecipientParties.titleFieldValue	string	Значение поля заголовка в сигнатуре.
Причина подписывания	folder.folderRecipientParties.reasonSigning	string	Причина подписывания документа получателем.
Добавлено поле оплаты	folder.folderRecipientParties.payFieldAdded	boolean	Указывает, добавлено ли поле оплаты.
Получатель	folder.folderRecipientParties.payee	boolean	Указывает, является ли получатель выплатой.
Повторяющийся платеж	folder.folderRecipientParties.recurringFieldExist	boolean	Указывает, существует ли повторяющееся поле оплаты.
Печать и подписание готово	folder.folderRecipientParties.printAndSignCompleted	boolean	Указывает, завершен ли процесс печати и подписи.
Paid	folder.folderRecipientParties.paid	boolean	Указывает, завершена ли оплата.
Необязательный разрешенный подписыватель	folder.folderRecipientParties.allowOptionalSigner	boolean	Указывает, является ли этот получатель необязательным подписывателем.
Необязательные подписи	folder.folderRecipientParties.optionalSigners	array of integer	Список необязательных идентификаторов сторон подписывающей стороны для этого конверта.
URL-адрес подписи автора	folder.folderAccessURLForAuthor	string	URL-адрес отправителя может использовать для доступа к конверту.
Черновик URL-адрес доступа	folder.draftFolderAccessURL	string	URL-адрес, используемый для доступа к черновику версии конверта.
Подписание зала заседаний	folder.boardRoomSign	boolean	Указывает, включен ли режим подписывания комнаты для доски.
Включить логотип	folder.includeLogo	boolean	Указывает, включен ли логотип компании в сообщения электронной почты.
Цвет фона кнопки	folder.email_btnBgColor	string	Цвет фона кнопки электронной почты.
Цвет текста кнопки	folder.email_btnTxtColor	string	Цвет текста кнопки электронной почты.
Логотип электронной почты	folder.emailTemplateLogo	string	URL-адрес логотипа, используемый в шаблоне электронной почты.
Идентификатор шаблона электронной почты	folder.emailTemplateId	integer	Уникальный идентификатор шаблона электронной почты.
Заголовок электронной почты	folder.emailHeader	string	Текст заголовка, используемый в сообщениях электронной почты уведомлений.
Нижний колонтитул электронной почты	folder.emailFooter	string	Текст нижнего колонтитула, используемый в сообщениях электронной почты уведомлений.
Очистка запланированного	folder.purgeFlag	boolean	Указывает, запланирована ли очистка конверта.
Дата начала очистки	folder.purgeStartDate	string	Дата начала очистки.
Дата окончания очистки	folder.purgeEndDate	string	Дата завершения очистки.
Идентификатор массовой отправки	folder.bulkId	integer	Уникальный идентификатор операции массового отправки.
Принудительное применение порядка подписей	folder.enforceSignWorkflow	boolean	Указывает, должны ли получатели входить в определенную последовательность.
Текущий шаг	folder.currentWorkflowStep	integer	Текущий шаг в рабочем процессе подписывания.
Источник транзакций	folder.transactionSource	string	Исходная система, инициирующая эту транзакцию.
Возможно изменение	folder.editable	boolean	Указывает, является ли элемент редактируемым.
подписывание In-Person	folder.inPersonSignable	boolean	Указывает, может ли конверт быть вошедший в систему лично.
Переопределение напоминаний	folder.overrideAccountReminders	boolean	Указывает, переопределяются ли параметры напоминания на уровне учетной записи.
Переопределение делегирования	folder.overrideAccountRecipientDelegation	boolean	Указывает, переопределяются ли параметры делегирования на уровне учетной записи.
Разрешить делегирование	folder.allowRecipientsToDelegate	boolean	Указывает, разрешено ли получателям делегировать подпись.
Идентификатор	folder.envelopeId	integer	Уникальный идентификатор конверта.
Name	folder.envelopeName	string	Имя конверта.
Идентификатор инициатора	folder.envelopeOriginatorId	integer	Уникальный идентификатор пользователя, создавшего конверт.
Идентификатор компании	folder.envelopeCompanyId	integer	Уникальный идентификатор компании, которая владеет конвертом.
Date	folder.envelopeDate	integer	Дата создания конверта (метка времени Unix в миллисекундах).
Общая дата	folder.envelopeSharedDate	integer	Дата совместного использования конверта (метка времени Unix в миллисекундах).
Статус	folder.envelopeStatus	string	Текущее состояние конверта.
Идентификаторы контрактов	folder.envelopeContractIds	array of integer	Список идентификаторов контрактов, связанных с этим конвертом.
Разрешения получателя	folder.envelopePartyPermissions	array of object	Список разрешений получателя для этого конверта.
Идентификатор получателя	folder.envelopePartyPermissions.partyId	integer	Уникальный идентификатор получателя.
Идентификатор получателя	folder.envelopePartyPermissions.partyDetails.partyId	integer	Уникальный идентификатор получателя.
Имя (Первое имя)	folder.envelopePartyPermissions.partyDetails.firstName	string	Имя получателя.
Фамилия	folder.envelopePartyPermissions.partyDetails.lastName	string	Фамилия получателя.
Адрес электронной почты	folder.envelopePartyPermissions.partyDetails.emailId	string	Адрес электронной почты получателя.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Указывает, является ли эта сторона получателем заполнителя.
Address	folder.envelopePartyPermissions.partyDetails.address	string	Физический адрес получателя.
Дата создания	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Дата создания записи (метка времени Unix в миллисекундах).
Отказ от сообщений электронной почты	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Указывает, отказался ли получатель от уведомлений по электронной почте.
Уникальный идентификатор получателя	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Уникальный системный идентификатор для этого получателя.
Уровень проверки подлинности	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Метод проверки подлинности, необходимый для этого получателя.
Дата обновления пароля	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Дата последнего обновления пароля.
Состояние обновления пароля	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Указывает, был ли обновлен пароль.
Идентификатор компании	folder.envelopePartyPermissions.partyDetails.companyId	integer	Уникальный идентификатор компании.
Роль пользователя	folder.envelopePartyPermissions.partyDetails.userRole	string	Роль, назначенная пользователю.
Отдел	folder.envelopePartyPermissions.partyDetails.department	string	Отдел, к которому принадлежит пользователь.
Название	folder.envelopePartyPermissions.partyDetails.title	string	Название задания пользователя.
Активный	folder.envelopePartyPermissions.partyDetails.active	boolean	Указывает, активен ли пользователь или запись.
Locale	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Параметр языкового стандарта для пользователя.
Совместное использование с Dept	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Указывает, являются ли конверты общими для отдела.
Код набора	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Международный телефонный код для номера телефона.
Номер мобильного устройства	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Номер мобильного телефона.
Фильтр состояния	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Фильтр состояния документа.
Фильтр по дате	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Фильтр для даты документа.
Безопасный доступ к полю	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Указывает, имеет ли пользователь доступ к защищенным полям.
Разверните боковую панель	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Указывает, развернута ли боковая панель по умолчанию.
Adv. Проверка электронной почты	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Указывает, включена ли расширенная проверка электронной почты.
Идентификатор диспетчера	folder.envelopePartyPermissions.partyDetails.managerId	string	Уникальный идентификатор руководителя пользователя.
Число входа	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Количество попыток входа пользователя.
Электронная почта сброса пароля	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Указывает, следует ли отправлять электронную почту сброса пароля.
Идентификатор отдела	folder.envelopePartyPermissions.partyDetails.departmentId	string	Уникальный идентификатор отдела.
Основная компания	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Основная компания, связанная с пользователем.
Тип устройства	folder.envelopePartyPermissions.partyDetails.deviceType	string	Тип используемого устройства.
Токен устройства	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Маркер push-уведомлений для устройства.
Описание субподрядчика	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Описание субподрядчика или внешнего подписывателя.
Организация субподрядчика	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Имя организации субподрядчика или внешнего подписчика.
Дата добавления субподрядчика	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Дата добавления субподрядчика (метка времени Unix в миллисекундах).
Source	folder.envelopePartyPermissions.partyDetails.source	string	Исходная система, из которой добавлен внешний подписыватель.
Код набора	folder.envelopePartyPermissions.dialingCode	string	Международный телефонный код для номера телефона.
Номер мобильного устройства	folder.envelopePartyPermissions.mobileNumber	string	Номер мобильного телефона.
Тип подписи	folder.envelopePartyPermissions.signerSignatureType	string	Тип подписи, который будет использовать подписыватель.
Разрешения	folder.envelopePartyPermissions.contractPermissions	string	Разрешения, предоставленные этой стороне для контракта.
Порядок подписывания	folder.envelopePartyPermissions.partySequence	integer	Порядковый номер заказа подписи для этого получателя.
Последовательность рабочих процессов	folder.envelopePartyPermissions.workflowSignSequence	integer	Порядковый номер подписывания рабочего процесса.
Идентификатор конверта	folder.envelopePartyPermissions.envelopeId	integer	Уникальный идентификатор конверта.
Идентификатор компании-получателя	folder.envelopePartyPermissions.partyCompanyId	integer	Уникальный идентификатор компании, связанной с этим получателем.
Режим общего доступа	folder.envelopePartyPermissions.sharingMode	string	Режим общего доступа для этого конверта.
URL-адрес доступа получателя	folder.envelopePartyPermissions.folderAccessURL	string	URL-адрес получателя может использовать для доступа и подписывания конверта.
Режим безопасности	folder.envelopePartyPermissions.securityMode	string	Режим безопасности, применяемый к этому конверту.
Comments	folder.envelopePartyPermissions.extraComments	string	Дополнительные комментарии, включенные в конверт.
Разрешить изменение имени	folder.envelopePartyPermissions.allowNameChange	boolean	Указывает, разрешено ли получателю обновлять свое имя.
Обновлено имя	folder.envelopePartyPermissions.signerNameUpdated	boolean	Указывает, обновил ли подписыватель свое имя.
Уровень проверки подлинности подписи	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Уровень проверки подлинности, необходимый для входа.
Код доступа	folder.envelopePartyPermissions.userDefinedAccessCode	string	Код пользовательского доступа, определенный для подписателя.
Идентификатор подписи	folder.envelopePartyPermissions.signatureId	string	Уникальный идентификатор подписи.
Роль получателя	folder.envelopePartyPermissions.partyRole	string	Роль, назначенная этому получателю в рабочем процессе подписывания.
Поле компании	folder.envelopePartyPermissions.companyFieldValue	string	Значение поля имени компании в сигнатуре.
Поле заголовка	folder.envelopePartyPermissions.titleFieldValue	string	Значение поля заголовка в сигнатуре.
Причина подписывания	folder.envelopePartyPermissions.reasonSigning	string	Причина подписывания документа получателем.
Добавлено поле оплаты	folder.envelopePartyPermissions.payFieldAdded	boolean	Указывает, добавлено ли поле оплаты.
Получатель	folder.envelopePartyPermissions.payee	boolean	Указывает, является ли получатель выплатой.
Повторяющийся платеж	folder.envelopePartyPermissions.recurringFieldExist	boolean	Указывает, существует ли повторяющееся поле оплаты.
Печать и подписание готово	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Указывает, завершен ли процесс печати и подписи.
Paid	folder.envelopePartyPermissions.paid	boolean	Указывает, завершена ли оплата.
Уровень проверки подлинности	folder.envelopeAuthenticationLevel	string	Уровень проверки подлинности, необходимый для конверта.
Массовая операция единого входа	folder.allowSingleSignerInBulk	boolean	Указывает, разрешен ли единый вход в режиме массовой отправки.
именование File-Based	folder.folderNameBasedOnFileNaming	boolean	Указывает, основано ли имя папки на основе имени файла.
Имя File-Based документа	folder.documentNameBasedOnFileNaming	boolean	Указывает, основано ли имя документа на основе имени файла.
Имя File-Based сертификата	folder.certificateNameBasedOnFileNaming	boolean	Указывает, основано ли имя сертификата на основе имени файла.
Именование файлов pre-Exec	folder.enableFileNamingBeforeExecution	boolean	Указывает, включена ли именование файлов перед выполнением документа.
Добавлено payee	folder.payeeAddedd	boolean	Указывает, был ли добавлен платеж.
включена Self-Signing	folder.selfSignerEnabled	boolean	Указывает, включен ли режим самозаверяющей подписи.
Нотарий включено	folder.notaryEnabled	boolean	Указывает, включена ли подписывание нотарии.
Ограниченная видимость	folder.limitedVisibilityFlag	boolean	Указывает, включена ли ограниченная видимость для этого конверта.
Видимость после знака	folder.postSigningVisibility	boolean	Указывает, включена ли видимость после подписи.
Мокрый сигнатур	folder.wetSignatureEnabled	boolean	Указывает, включены ли мокрые подписи.
Слияние включено	folder.mergeEnabled	boolean	Указывает, включена ли слияние документов.
Внедренные сеансы подписывания	embeddedSigningSessions	array of object	Список внедренных сеансов подписывания, по одному на получателя. Только если createEmbeddedSigningSession имеет значение true.
Электронная почта подписывющего средства	embeddedSigningSessions.emailIdOfSigner	string	Адрес электронной почты получателя для этого внедренного сеанса подписи.
Токен подписывания	embeddedSigningSessions.embeddedToken	string	Уникальный маркер для внедренного сеанса подписи этого получателя.
URL-адрес сеанса подписывания	embeddedSigningSessions.embeddedSessionURL	string	URL-адрес, который нужно открыть или внедрить для этого получателя, чтобы подписать документ.
Внедренный маркер отправки	embeddedToken	string	Маркер для внедренного сеанса отправки. Значение true только при созданииEmbeddedSendingSession.
Отправка URL-адреса сеанса	embeddedSessionURL	string	URL-адрес для открытия или внедрения для автора конверта для подготовки и отправки конверта. Значение true только при созданииEmbeddedSendingSession.
Result	result	string	Результат операции.
Message	message	string	Сообщение, описывающее результат операции.

Создание конверта из URL-адреса

Идентификатор операции:: CreateEnvelopefromURL

Создает и отправляет конверт с помощью общедоступных URL-адресов PDF. Укажите URL-адреса документа и сведения о получателе для запуска процесса подписывания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя конверта	folderName	True	string	Имя этого конверта.
Тип ввода	inputType		string	Задает формат источника документа. Задайте url-адрес для предоставления URL-адресов файлов или base64, чтобы предоставить содержимое файла в кодировке Base64.
URL-адреса файлов	fileUrls	True	array of string	Массив общедоступных URL-адресов, указывающих на документы, добавляемые в этот конверт.
Имена файлов	fileNames	True	array of string	Массив отображаемых имен для каждого документа в том же порядке, что и URL-адреса файлов.
Имя (Первое имя)	firstName	True	string	Имя получателя.
Фамилия	lastName	True	string	Фамилия получателя.
Адрес электронной почты	emailId	True	string	Адрес электронной почты получателя.
permissions	permission	True	string
Последовательность	sequence	True	integer	Используйте это поле, чтобы назначить получателю порядковый номер в списке сторон-получателей. Используйте уникальные порядковые номера для каждой стороны, начиная с 1, например 1,2,3,4.... Если один пользователь несколько раз отображается в рабочем процессе подписывания, назначьте другую последовательность каждый раз, когда получатель повторяется.
signerAuthLevels	signerAuthLevel		string	Уровень проверки подлинности, который подписыватель будет использовать в целях проверки
Заполнитель	isPlaceholder		boolean	Используйте это поле для инициирования стороной заполнителя. Примечание. 1. Значение параметра firstName, lastName, emailId должно быть пустым для этой стороны. 2. Чтобы добавить заполнитель, один получатель должен быть переквалван с разрешением "PARTY_ASSIGNER".
Роль получателя	partyRole		string	Используйте это поле для назначения роли заполнителя.
Разрешить изменение имени	allowNameChange		string	Значение может иметь значение true или false. Этот параметр позволяет подписывшему обновлять имя и фамилию перед завершением процесса подписывания.
Последовательность рабочих процессов	workflowSequence		integer	Назначьте этому получателю порядковый номер рабочего процесса. Если включена последовательность входа, получатели получают приглашение на подписывание в порядке последовательности по возрастанию.
Идентификатор электронной почты узла	hostEmailId		string	Адрес электронной почты администратора In-Person.
Код доступа	userDefinedAccessCode		string	Параметр будет содержать код доступа, если значение signerAuthLevel задано как "Определяемый пользователем код доступа" для проверки подлинности. Примечание. 1. Коды не учитывает регистр. 2. Система не отправляет этот код, поэтому необходимо предоставить общий доступ к этому коду напрямую с подписывателем. 3. Код доступа может содержать алфавиты, числа и следующие специальные символы: @,&,{,},%,(),~,\|,!,+,^.
Партия — группа электронной почты	partyIsEmailGroup		boolean	Используйте этот параметр при создании участника в качестве массового. Примечание: Если этот параметр имеет значение true, firstName, lastName и emailId этой стороны будут игнорироваться.
Идентификатор группы электронной почты	emailGroupId		integer	Передайте адрес электронной почты идентификатор группы, который вы хотите использовать для массового создания.
Массовая операция единого входа	allowSingleSignerInBulk		boolean	Используйте этот параметр, чтобы разрешить вход только одному пользователю в группу электронной почты.
Код набора	dialingCode		string	Используйте это поле для назначения кодов телефонного номера страны— это префиксы мобильного номера получателю в списке получателей.
Номер мобильного устройства	mobileNumber		string	Используйте это поле для назначения мобильного номера получателю в списке сторон-получателей.
Поля	Fields		object
Отправить сейчас	sendNow		boolean	При включении Foxit eSign немедленно отправляет уникальную ссылку подписи на адрес электронной почты каждого получателя. Отключите это, чтобы сохранить конверт в виде черновика.
Создание внедренного сеанса подписывания	createEmbeddedSigningSession	True	boolean	Маркер сеанса подписывания будет создан без отправки сообщений электронной почты получателям.
Создание внедренного сеанса подписи для всех сторон	createEmbeddedSigningSessionForAllParties		boolean	Если задано значение true, внедренный URL-адрес подписи будет создан для каждого получателя в конверте.
Обработка текстовых тегов	processTextTags	True	boolean	Значение может иметь значение true или false. Это поле используется для определения того, должен ли Foxit eSign анализировать документы для текстовых тегов, чтобы преобразовать их в поля Foxit eSign.
Обработка полей Acro	processAcroFields	True	boolean	Это поле используется для определения того, следует ли Foxit eSign анализировать документы для AcroFields, чтобы преобразовать их в поля Foxit eSign.
Последовательность входа	signInSequence		boolean	Это поле используется для определения того, будут ли получатели подписывать документы конверта в последовательности. Если значение false, все получатели получают приглашение по электронной почте одновременно. Когда значение true, каждый получатель получает приглашение по электронной почте последовательно после того, как предыдущий получатель завершает требуемую задачу, например подписывание документов или полей заполнения и т. д.
Включение пользователя	inPersonEnable		boolean	Это поле используется для запуска процесса подписи пользователя, который можно легко завершить на любом устройстве в течение нескольких минут и избегает подписей на основе электронной почты, где это необходимо. Если значение false, все получатели получают приглашение по электронной почте одновременно. Когда значение true, администратор получает приглашение, чтобы инициировать процесс подписывания для подписывчика.
Исправление сторон получателя	fixRecipientParties		boolean	Если значение true, то в внедренном представлении отправки не удается изменить стороны конверта, которые уже добавлены в рамках этого запроса.
Исправление документов	fixDocuments		boolean	Если значение true, то в внедренной отправке не удается изменить документы для конверта, который уже добавлен в рамках этого запроса.
Отправить URL-адрес успешного выполнения	sendSuccessUrl		string	Введите абсолютный URL-адрес целевой страницы, на которую подписыватель будет перенаправлен после успешной отправки папки в внедренном представлении отправки.
Url-адрес ошибки отправки	sendErrorUrl		string	Введите абсолютный URL-адрес целевой страницы, на которую подписыватель будет перенаправлен, если ошибка возникает во время отправки папки в внедренном представлении отправки.
Создание внедренного сеанса отправки	createEmbeddedSendingSession		boolean	Если задано значение true, он создаст внедренный маркер для открытия представления подготовки документа Foxit eSign.
Встроенные идентификаторы электронной почты подписывания	embeddedSignersEmailIds		array of string	Массив идентификаторов электронной почты получателей, для которых необходимо создать внедренный сеанс подписи. Идентификаторы электронной почты от получателей, добавленные в список сторон.
Url-адрес успешности подписывания	signSuccessUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены после успешного входа в внедренное представление подписи.
URL-адрес отклонения подписи	signDeclineUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены, если отказ в входе в внедренное представление подписывания.
Url-адрес для входа позже	signLaterUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены, если вы решите войти позже в внедренном представлении подписи.
URL-адрес ошибки подписи	signErrorUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены на сообщение об ошибке при подписании документа в внедренном представлении подписывания.
Разрешить отправку и внедренный сеанс подписи	allowSendNowAndEmbeddedSigningSession		boolean	Если задано значение true, Foxit eSign отправит уникальную ссылку подписи каждому получателю. Это применимо только при отправке параметровNow и createEmbeddedSigningSession.
Расширенная проверка электронной почты	allowAdvancedEmailValidation		boolean	Проверьте адрес электронной почты сторон, если задано значение true.
Подписать URL-адрес успешности всех сторон	signSuccessUrlAllParties		boolean	Если задано значение true, подписыватель будет перенаправлен на URL-адрес, предоставленный в signSuccessUrl после успешного подписания. Это применимо только в том случае, если значение sendNow имеет значение true.
Идентификатор шаблона электронной почты	emailTemplateId		integer	Передайте идентификатор шаблона электронной почты, чтобы отправить шаблоны электронной почты, отличные от шаблонов электронной почты по умолчанию.
Идентификатор инструкции signer	signerInstructionId		integer	Передайте идентификатор инструкции для отправки инструкций подписи, отличных от инструкций подписи по умолчанию.
Идентификатор инструкции подтверждения	confirmationInstructionId		string	Передайте идентификатор инструкции подтверждения для отправки инструкций подтверждения, отличных от инструкций по умолчанию.
Цвет темы	themeColor		string	Введите значение CSS, чтобы задать цвет темы.
Срок действия сеанса	sessionExpire		boolean	Задайте значение true, чтобы инициировать срок действия внедренного сеанса подписи.
Истечение срока	expiry		integer	Требуется, если sessionExpire имеет значение true. Введите длительность в миллисекундах истечения срока действия в внедренном сеансе подписи.
Имя зависимого поля	dependentFieldName	True	string	Имя поля, видимость которого контролируется родительским полем.
Имя родительского поля	parentFieldName	True	string	Имя родительского поля, значение которого управляет видимостью зависимого поля. Поддерживаемые типы родительских полей: textfield, textbox, checkbox, radiobutton, раскрывающийся список.
Значение родительского поля	parentFieldValue	True	string	Значение родительского поля, которое активирует зависимое поле, чтобы стать видимым. Для полей флажка и переключателя используйте флажок или снятый флажок.
Options	options	True	string	Дополнительные параметры сопоставления для текстовых родительских полей. Допустимые значения: isblank, allowNull, содержит.
Metadata	metadata		object	Это должно быть в паре значений ключа. Разрешено не более 1000 пар значений ключей.
Электронная почта отправителя	senderEmail		string	введите сообщение электронной почты другого пользователя в учетной записи, которая будет использоваться для отправки этой папки документа участникам получателя.
Кнопка "Скрыть добавить меня"	hideAddMeButton		boolean	Если значение true, оно скрывает кнопку "Добавить меня" для получателей в внедренном сеансе отправки.
Скрыть кнопку "Добавить новую"	hideAddNewButton		boolean	Если значение true, оно скрывает кнопку "Добавить новый" для получателей в внедренном сеансе отправки.
Кнопка "Скрыть добавление группы"	hideAddGroupButton		boolean	Если значение true, оно скрывает кнопку "Добавить группу" для получателей в внедренном сеансе отправки.
Скрытие имени поля для получателей	hideFieldNameForRecipients		boolean	Скрытие имен полей для получателей полей записи данных и расширенных полей. (Кроме переключателя, флажка, изображения и гиперссылки).
Скрытие границы флажка	hideCheckboxBorder		boolean	Границы флажка будут скрыты в исполняемых документах.
Параметр выбора средства скрытия подписывателя	hideSignerSelectOption		boolean	Если задано значение true, оно скрывает поле ввода "Существующее имя и электронная почта" для получателей в внедренном сеансе отправки.
Скрытие действий подписи	hideSignerActions		boolean	Если значение true, оно скрывает подписыватель "изменить", "изменить" и "удалить" действия для получателей в внедренном сеансе отправки.
Скрыть имя отправителя	hideSenderName		boolean	Если значение true, оно скрывает имя отправителя на получателях в внедренном сеансе отправки.
Скрыть имя папки	hideFolderName		boolean	Если задано значение true, имя папки будет скрыто при навигации в обоих внедренных сеансах.
Скрытие имени документов	hideDocumentsName		boolean	Если значение true, оно скрывает имя документа в обоих внедренных сеансах.
Скрыть отклонить знак	hideDeclineToSign		boolean	Если значение true, оно скрывает параметр "Отклонить знак" для подписывчика.
Скрытие дополнительных действий	hideMoreAction		boolean	Если задано значение true, кнопка "Дополнительные действия" будет скрыта при отправке и подписи сеанса. В случае "Отправить сейчас": true, он не будет скрывать ничего.
Кнопка "Скрыть отправку"	hideSendButton		boolean	Если задано значение true, кнопка "Отправить" будет скрыта во встроенном сеансе отправки.
Скрыть следующее обязательное полеbtn	hideNextRequiredFieldbtn		boolean	Если задано значение true, скрывает кнопку навигации, которая перемещает подписывающих элементов в следующее необходимое поле.
Обязательный внедренный сеанс	requiredBothEmbeddedSession		boolean	Если значение true, оно создаст внедренные URL-адреса отправки и подписывания вместе.
Пароль конверта	folderPassword		string	Этот пароль потребуется для входа или автора, чтобы открыть документ с цифровой подписью. Если параметр остается пустым, пароль не потребуется для открытия документа с цифровой подписью.
Включение пошаговые шаги	enableStepByStep		boolean	Чтобы включить пошаговое действие в внедренном сеансе отправки.
Скрытие параметра "Добавить стороны"	hideAddPartiesOption		boolean	Если задано значение true, параметр добавления сторон будет скрыт в режиме создания черновика и шаблона.
Самозаверять	selfSign		boolean	Он включает встроенный самостоятельный вход через API. Этот параметр применяется только в том случае, если параметр createEmbeddedSendingSession имеет значение true.
Url-адрес успешности самозаверяющего входа	selfSignerSuccessUrl		string	Введите абсолютный URL-адрес целевой страницы на веб-сайте или приложении, на который пользователь будет перенаправлен после успешной отправки папки в внедренном представлении отправки.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	folder.folderId	integer	Уникальный идентификатор только что созданного конверта. Используйте это в последующих действиях для ссылки на этот конверт.
Name	folder.folderName	string	Имя только что созданного конверта.
Пользовательское имя	folder.folderCustomName	string	Настраиваемое имя конверта.
Password	folder.folderPassword	string	Пароль доступа для конверта, если задан.
Идентификатор создателя	folder.folderAuthorId	integer	Уникальный идентификатор создателя конверта.
Имя создателя	folder.folderAuthorFirstName	string	Имя создателя конверта.
Фамилия создателя	folder.folderAuthorLastName	string	Фамилия создателя конверта.
Создатель электронной почты	folder.folderAuthorEmail	string	Адрес электронной почты создателя конверта.
Роль создателя	folder.folderAuthorRole	string	Роль создателя конверта.
Идентификатор компании	folder.folderCompanyId	integer	Уникальный идентификатор компании, которая владеет конвертом.
Дата создания	folder.folderCreationDate	integer	Дата создания конверта (метка времени Unix в миллисекундах).
Дата отправки	folder.folderSentDate	integer	Дата отправки конверта (метка времени Unix в миллисекундах).
Статус	folder.folderStatus	string	Текущее состояние конверта.
Настраиваемое поле 1	folder.custom_field1	string	Первое настраиваемое поле метаданных для конверта.
Настраиваемое поле 2	folder.custom_field2	string	Второе поле настраиваемых метаданных для конверта.
Metadata	folder.metadata	string	Пользовательские метаданные, связанные с конвертом.
Идентификаторы документов	folder.folderDocumentIds	array of integer	Список идентификаторов документов, содержащихся в конверте.
Documents	folder.documentsList	array of object	Список документов в конверте.
Код документа	folder.documentsList.documentId	integer	Уникальный идентификатор документа.
Идентификатор контракта	folder.documentsList.contractId	integer	Уникальный идентификатор контракта.
Идентификатор компании	folder.documentsList.companyId	integer	Уникальный идентификатор компании.
Создано кем	folder.documentsList.contractCreatedBy	integer	Идентификатор пользователя, создавшего контракт.
Создано	folder.documentsList.contractCreatedOn	string	Дата и время создания контракта.
Тип контракта	folder.documentsList.contractType	string	Тип контракта.
Состояние контракта	folder.documentsList.contractStatus	string	Текущее состояние контракта.
Возможно изменение	folder.documentsList.editable	boolean	Указывает, является ли элемент редактируемым.
Идентификатор версии	folder.documentsList.contractVersionId	integer	Уникальный идентификатор версии контракта.
Имя версии	folder.documentsList.contractVersionName	string	Имя версии контракта.
Описание версии	folder.documentsList.contractVersionDesc	string	Описание версии контракта.
Версия, созданная с помощью	folder.documentsList.versionCreatedby	integer	Идентификатор пользователя, создавшего эту версию.
Версия, созданная в	folder.documentsList.versionCreatedOn	string	Дата и время создания этой версии.
Номер версии	folder.documentsList.contractVersionNumber	integer	Номер версии контракта.
Источник транзакций	folder.documentsList.contractTransactionSource	string	Исходная система, инициирующая транзакцию контракта.
Получатели	folder.folderRecipientParties	array of object	Список получателей для этого конверта.
Идентификатор получателя	folder.folderRecipientParties.partyId	integer	Уникальный идентификатор получателя.
Идентификатор получателя	folder.folderRecipientParties.partyDetails.partyId	integer	Уникальный идентификатор получателя.
Имя (Первое имя)	folder.folderRecipientParties.partyDetails.firstName	string	Имя получателя.
Фамилия	folder.folderRecipientParties.partyDetails.lastName	string	Фамилия получателя.
Адрес электронной почты	folder.folderRecipientParties.partyDetails.emailId	string	Адрес электронной почты получателя.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Указывает, является ли эта сторона получателем заполнителя.
Address	folder.folderRecipientParties.partyDetails.address	string	Физический адрес получателя.
Дата создания	folder.folderRecipientParties.partyDetails.dateCreated	integer	Дата создания записи (метка времени Unix в миллисекундах).
Отказ от сообщений электронной почты	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Указывает, отказался ли получатель от уведомлений по электронной почте.
Уникальный идентификатор получателя	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Уникальный системный идентификатор для этого получателя.
Уровень проверки подлинности	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Метод проверки подлинности, необходимый для этого получателя.
Дата обновления пароля	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Дата последнего обновления пароля.
Состояние обновления пароля	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Указывает, был ли обновлен пароль.
Идентификатор компании	folder.folderRecipientParties.partyDetails.companyId	integer	Уникальный идентификатор компании.
Роль пользователя	folder.folderRecipientParties.partyDetails.userRole	string	Роль, назначенная пользователю.
Отдел	folder.folderRecipientParties.partyDetails.department	string	Отдел, к которому принадлежит пользователь.
Название	folder.folderRecipientParties.partyDetails.title	string	Название задания пользователя.
Активный	folder.folderRecipientParties.partyDetails.active	boolean	Указывает, активен ли пользователь или запись.
Locale	folder.folderRecipientParties.partyDetails.requestLocale	string	Параметр языкового стандарта для пользователя.
Совместное использование с Dept	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Указывает, являются ли конверты общими для отдела.
Код набора	folder.folderRecipientParties.partyDetails.dialingCode	string	Международный телефонный код для номера телефона.
Номер мобильного устройства	folder.folderRecipientParties.partyDetails.mobileNumber	string	Номер мобильного телефона.
Фильтр состояния	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Фильтр состояния документа.
Фильтр по дате	folder.folderRecipientParties.partyDetails.docDateFilter	string	Фильтр для даты документа.
Безопасный доступ к полю	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Указывает, имеет ли пользователь доступ к защищенным полям.
Разверните боковую панель	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Указывает, развернута ли боковая панель по умолчанию.
Adv. Проверка электронной почты	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Указывает, включена ли расширенная проверка электронной почты.
Идентификатор диспетчера	folder.folderRecipientParties.partyDetails.managerId	string	Уникальный идентификатор руководителя пользователя.
Число входа	folder.folderRecipientParties.partyDetails.loginCount	integer	Количество попыток входа пользователя.
Электронная почта сброса пароля	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Указывает, следует ли отправлять электронную почту сброса пароля.
Идентификатор отдела	folder.folderRecipientParties.partyDetails.departmentId	string	Уникальный идентификатор отдела.
Основная компания	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Основная компания, связанная с пользователем.
Тип устройства	folder.folderRecipientParties.partyDetails.deviceType	string	Тип используемого устройства.
Токен устройства	folder.folderRecipientParties.partyDetails.deviceToken	string	Маркер push-уведомлений для устройства.
Описание субподрядчика	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Описание субподрядчика или внешнего подписывателя.
Организация субподрядчика	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Имя организации субподрядчика или внешнего подписчика.
Дата добавления субподрядчика	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Дата добавления субподрядчика (метка времени Unix в миллисекундах).
Source	folder.folderRecipientParties.partyDetails.source	string	Исходная система, из которой добавлен внешний подписыватель.
Код набора	folder.folderRecipientParties.dialingCode	string	Международный телефонный код для номера телефона.
Номер мобильного устройства	folder.folderRecipientParties.mobileNumber	string	Номер мобильного телефона.
Тип подписи	folder.folderRecipientParties.signerSignatureType	string	Тип подписи, который будет использовать подписыватель.
Разрешения	folder.folderRecipientParties.contractPermissions	string	Разрешения, предоставленные этой стороне для контракта.
Порядок подписывания	folder.folderRecipientParties.partySequence	integer	Порядковый номер заказа подписи для этого получателя.
Последовательность рабочих процессов	folder.folderRecipientParties.workflowSignSequence	integer	Порядковый номер подписывания рабочего процесса.
Идентификатор конверта	folder.folderRecipientParties.envelopeId	integer	Уникальный идентификатор конверта.
Идентификатор компании-получателя	folder.folderRecipientParties.partyCompanyId	integer	Уникальный идентификатор компании, связанной с этим получателем.
Режим общего доступа	folder.folderRecipientParties.sharingMode	string	Режим общего доступа для этого конверта.
URL-адрес доступа получателя	folder.folderRecipientParties.folderAccessURL	string	URL-адрес получателя может использовать для доступа и подписывания конверта.
Режим безопасности	folder.folderRecipientParties.securityMode	string	Режим безопасности, применяемый к этому конверту.
Comments	folder.folderRecipientParties.extraComments	string	Дополнительные комментарии, включенные в конверт.
Разрешить изменение имени	folder.folderRecipientParties.allowNameChange	boolean	Указывает, разрешено ли получателю обновлять свое имя.
Обновлено имя	folder.folderRecipientParties.signerNameUpdated	boolean	Указывает, обновил ли подписыватель свое имя.
Уровень проверки подлинности подписи	folder.folderRecipientParties.signerAuthenticationLevel	string	Уровень проверки подлинности, необходимый для входа.
Код доступа	folder.folderRecipientParties.userDefinedAccessCode	string	Код пользовательского доступа, определенный для подписателя.
Идентификатор подписи	folder.folderRecipientParties.signatureId	string	Уникальный идентификатор подписи.
Роль получателя	folder.folderRecipientParties.partyRole	string	Роль, назначенная этому получателю в рабочем процессе подписывания.
Поле компании	folder.folderRecipientParties.companyFieldValue	string	Значение поля имени компании в сигнатуре.
Поле заголовка	folder.folderRecipientParties.titleFieldValue	string	Значение поля заголовка в сигнатуре.
Причина подписывания	folder.folderRecipientParties.reasonSigning	string	Причина подписывания документа получателем.
Добавлено поле оплаты	folder.folderRecipientParties.payFieldAdded	boolean	Указывает, добавлено ли поле оплаты.
Получатель	folder.folderRecipientParties.payee	boolean	Указывает, является ли получатель выплатой.
Повторяющийся платеж	folder.folderRecipientParties.recurringFieldExist	boolean	Указывает, существует ли повторяющееся поле оплаты.
Печать и подписание готово	folder.folderRecipientParties.printAndSignCompleted	boolean	Указывает, завершен ли процесс печати и подписи.
Paid	folder.folderRecipientParties.paid	boolean	Указывает, завершена ли оплата.
Необязательный разрешенный подписыватель	folder.folderRecipientParties.allowOptionalSigner	boolean	Указывает, является ли этот получатель необязательным подписывателем.
Необязательные подписи	folder.folderRecipientParties.optionalSigners	array of integer	Список необязательных идентификаторов сторон подписывающей стороны для этого конверта.
URL-адрес подписи автора	folder.folderAccessURLForAuthor	string	URL-адрес отправителя может использовать для доступа к конверту.
Черновик URL-адрес доступа	folder.draftFolderAccessURL	string	URL-адрес, используемый для доступа к черновику версии конверта.
Подписание зала заседаний	folder.boardRoomSign	boolean	Указывает, включен ли режим подписывания комнаты для доски.
Включить логотип	folder.includeLogo	boolean	Указывает, включен ли логотип компании в сообщения электронной почты.
Цвет фона кнопки	folder.email_btnBgColor	string	Цвет фона кнопки электронной почты.
Цвет текста кнопки	folder.email_btnTxtColor	string	Цвет текста кнопки электронной почты.
Логотип электронной почты	folder.emailTemplateLogo	string	URL-адрес логотипа, используемый в шаблоне электронной почты.
Идентификатор шаблона электронной почты	folder.emailTemplateId	integer	Уникальный идентификатор шаблона электронной почты.
Заголовок электронной почты	folder.emailHeader	string	Текст заголовка, используемый в сообщениях электронной почты уведомлений.
Нижний колонтитул электронной почты	folder.emailFooter	string	Текст нижнего колонтитула, используемый в сообщениях электронной почты уведомлений.
Очистка запланированного	folder.purgeFlag	boolean	Указывает, запланирована ли очистка конверта.
Дата начала очистки	folder.purgeStartDate	string	Дата начала очистки.
Дата окончания очистки	folder.purgeEndDate	string	Дата завершения очистки.
Идентификатор массовой отправки	folder.bulkId	integer	Уникальный идентификатор операции массового отправки.
Принудительное применение порядка подписей	folder.enforceSignWorkflow	boolean	Указывает, должны ли получатели входить в определенную последовательность.
Текущий шаг	folder.currentWorkflowStep	integer	Текущий шаг в рабочем процессе подписывания.
Источник транзакций	folder.transactionSource	string	Исходная система, инициирующая эту транзакцию.
Возможно изменение	folder.editable	boolean	Указывает, является ли элемент редактируемым.
подписывание In-Person	folder.inPersonSignable	boolean	Указывает, может ли конверт быть вошедший в систему лично.
Переопределение напоминаний	folder.overrideAccountReminders	boolean	Указывает, переопределяются ли параметры напоминания на уровне учетной записи.
Переопределение делегирования	folder.overrideAccountRecipientDelegation	boolean	Указывает, переопределяются ли параметры делегирования на уровне учетной записи.
Разрешить делегирование	folder.allowRecipientsToDelegate	boolean	Указывает, разрешено ли получателям делегировать подпись.
Идентификатор	folder.envelopeId	integer	Уникальный идентификатор конверта.
Name	folder.envelopeName	string	Имя конверта.
Идентификатор инициатора	folder.envelopeOriginatorId	integer	Уникальный идентификатор пользователя, создавшего конверт.
Идентификатор компании	folder.envelopeCompanyId	integer	Уникальный идентификатор компании, которая владеет конвертом.
Date	folder.envelopeDate	integer	Дата создания конверта (метка времени Unix в миллисекундах).
Общая дата	folder.envelopeSharedDate	integer	Дата совместного использования конверта (метка времени Unix в миллисекундах).
Статус	folder.envelopeStatus	string	Текущее состояние конверта.
Идентификаторы контрактов	folder.envelopeContractIds	array of integer	Список идентификаторов контрактов, связанных с этим конвертом.
Разрешения получателя	folder.envelopePartyPermissions	array of object	Список разрешений получателя для этого конверта.
Идентификатор получателя	folder.envelopePartyPermissions.partyId	integer	Уникальный идентификатор получателя.
Идентификатор получателя	folder.envelopePartyPermissions.partyDetails.partyId	integer	Уникальный идентификатор получателя.
Имя (Первое имя)	folder.envelopePartyPermissions.partyDetails.firstName	string	Имя получателя.
Фамилия	folder.envelopePartyPermissions.partyDetails.lastName	string	Фамилия получателя.
Адрес электронной почты	folder.envelopePartyPermissions.partyDetails.emailId	string	Адрес электронной почты получателя.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Указывает, является ли эта сторона получателем заполнителя.
Address	folder.envelopePartyPermissions.partyDetails.address	string	Физический адрес получателя.
Дата создания	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Дата создания записи (метка времени Unix в миллисекундах).
Отказ от сообщений электронной почты	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Указывает, отказался ли получатель от уведомлений по электронной почте.
Уникальный идентификатор получателя	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Уникальный системный идентификатор для этого получателя.
Уровень проверки подлинности	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Метод проверки подлинности, необходимый для этого получателя.
Дата обновления пароля	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Дата последнего обновления пароля.
Состояние обновления пароля	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Указывает, был ли обновлен пароль.
Идентификатор компании	folder.envelopePartyPermissions.partyDetails.companyId	integer	Уникальный идентификатор компании.
Роль пользователя	folder.envelopePartyPermissions.partyDetails.userRole	string	Роль, назначенная пользователю.
Отдел	folder.envelopePartyPermissions.partyDetails.department	string	Отдел, к которому принадлежит пользователь.
Название	folder.envelopePartyPermissions.partyDetails.title	string	Название задания пользователя.
Активный	folder.envelopePartyPermissions.partyDetails.active	boolean	Указывает, активен ли пользователь или запись.
Locale	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Параметр языкового стандарта для пользователя.
Совместное использование с Dept	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Указывает, являются ли конверты общими для отдела.
Код набора	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Международный телефонный код для номера телефона.
Номер мобильного устройства	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Номер мобильного телефона.
Фильтр состояния	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Фильтр состояния документа.
Фильтр по дате	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Фильтр для даты документа.
Безопасный доступ к полю	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Указывает, имеет ли пользователь доступ к защищенным полям.
Разверните боковую панель	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Указывает, развернута ли боковая панель по умолчанию.
Adv. Проверка электронной почты	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Указывает, включена ли расширенная проверка электронной почты.
Идентификатор диспетчера	folder.envelopePartyPermissions.partyDetails.managerId	string	Уникальный идентификатор руководителя пользователя.
Число входа	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Количество попыток входа пользователя.
Электронная почта сброса пароля	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Указывает, следует ли отправлять электронную почту сброса пароля.
Идентификатор отдела	folder.envelopePartyPermissions.partyDetails.departmentId	string	Уникальный идентификатор отдела.
Основная компания	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Основная компания, связанная с пользователем.
Тип устройства	folder.envelopePartyPermissions.partyDetails.deviceType	string	Тип используемого устройства.
Токен устройства	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Маркер push-уведомлений для устройства.
Описание субподрядчика	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Описание субподрядчика или внешнего подписывателя.
Организация субподрядчика	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Имя организации субподрядчика или внешнего подписчика.
Дата добавления субподрядчика	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Дата добавления субподрядчика (метка времени Unix в миллисекундах).
Source	folder.envelopePartyPermissions.partyDetails.source	string	Исходная система, из которой добавлен внешний подписыватель.
Код набора	folder.envelopePartyPermissions.dialingCode	string	Международный телефонный код для номера телефона.
Номер мобильного устройства	folder.envelopePartyPermissions.mobileNumber	string	Номер мобильного телефона.
Тип подписи	folder.envelopePartyPermissions.signerSignatureType	string	Тип подписи, который будет использовать подписыватель.
Разрешения	folder.envelopePartyPermissions.contractPermissions	string	Разрешения, предоставленные этой стороне для контракта.
Порядок подписывания	folder.envelopePartyPermissions.partySequence	integer	Порядковый номер заказа подписи для этого получателя.
Последовательность рабочих процессов	folder.envelopePartyPermissions.workflowSignSequence	integer	Порядковый номер подписывания рабочего процесса.
Идентификатор конверта	folder.envelopePartyPermissions.envelopeId	integer	Уникальный идентификатор конверта.
Идентификатор компании-получателя	folder.envelopePartyPermissions.partyCompanyId	integer	Уникальный идентификатор компании, связанной с этим получателем.
Режим общего доступа	folder.envelopePartyPermissions.sharingMode	string	Режим общего доступа для этого конверта.
URL-адрес доступа получателя	folder.envelopePartyPermissions.folderAccessURL	string	URL-адрес получателя может использовать для доступа и подписывания конверта.
Режим безопасности	folder.envelopePartyPermissions.securityMode	string	Режим безопасности, применяемый к этому конверту.
Comments	folder.envelopePartyPermissions.extraComments	string	Дополнительные комментарии, включенные в конверт.
Разрешить изменение имени	folder.envelopePartyPermissions.allowNameChange	boolean	Указывает, разрешено ли получателю обновлять свое имя.
Обновлено имя	folder.envelopePartyPermissions.signerNameUpdated	boolean	Указывает, обновил ли подписыватель свое имя.
Уровень проверки подлинности подписи	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Уровень проверки подлинности, необходимый для входа.
Код доступа	folder.envelopePartyPermissions.userDefinedAccessCode	string	Код пользовательского доступа, определенный для подписателя.
Идентификатор подписи	folder.envelopePartyPermissions.signatureId	string	Уникальный идентификатор подписи.
Роль получателя	folder.envelopePartyPermissions.partyRole	string	Роль, назначенная этому получателю в рабочем процессе подписывания.
Поле компании	folder.envelopePartyPermissions.companyFieldValue	string	Значение поля имени компании в сигнатуре.
Поле заголовка	folder.envelopePartyPermissions.titleFieldValue	string	Значение поля заголовка в сигнатуре.
Причина подписывания	folder.envelopePartyPermissions.reasonSigning	string	Причина подписывания документа получателем.
Добавлено поле оплаты	folder.envelopePartyPermissions.payFieldAdded	boolean	Указывает, добавлено ли поле оплаты.
Получатель	folder.envelopePartyPermissions.payee	boolean	Указывает, является ли получатель выплатой.
Повторяющийся платеж	folder.envelopePartyPermissions.recurringFieldExist	boolean	Указывает, существует ли повторяющееся поле оплаты.
Печать и подписание готово	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Указывает, завершен ли процесс печати и подписи.
Paid	folder.envelopePartyPermissions.paid	boolean	Указывает, завершена ли оплата.
Уровень проверки подлинности	folder.envelopeAuthenticationLevel	string	Уровень проверки подлинности, необходимый для конверта.
Массовая операция единого входа	folder.allowSingleSignerInBulk	boolean	Указывает, разрешен ли единый вход в режиме массовой отправки.
именование File-Based	folder.folderNameBasedOnFileNaming	boolean	Указывает, основано ли имя папки на основе имени файла.
Имя File-Based документа	folder.documentNameBasedOnFileNaming	boolean	Указывает, основано ли имя документа на основе имени файла.
Имя File-Based сертификата	folder.certificateNameBasedOnFileNaming	boolean	Указывает, основано ли имя сертификата на основе имени файла.
Именование файлов pre-Exec	folder.enableFileNamingBeforeExecution	boolean	Указывает, включена ли именование файлов перед выполнением документа.
Добавлено payee	folder.payeeAddedd	boolean	Указывает, был ли добавлен платеж.
включена Self-Signing	folder.selfSignerEnabled	boolean	Указывает, включен ли режим самозаверяющей подписи.
Нотарий включено	folder.notaryEnabled	boolean	Указывает, включена ли подписывание нотарии.
Ограниченная видимость	folder.limitedVisibilityFlag	boolean	Указывает, включена ли ограниченная видимость для этого конверта.
Видимость после знака	folder.postSigningVisibility	boolean	Указывает, включена ли видимость после подписи.
Мокрый сигнатур	folder.wetSignatureEnabled	boolean	Указывает, включены ли мокрые подписи.
Слияние включено	folder.mergeEnabled	boolean	Указывает, включена ли слияние документов.
Внедренные сеансы подписывания	embeddedSigningSessions	array of object	Список внедренных сеансов подписывания, по одному на получателя. Только если createEmbeddedSigningSession имеет значение true.
Электронная почта подписывющего средства	embeddedSigningSessions.emailIdOfSigner	string	Адрес электронной почты получателя для этого внедренного сеанса подписи.
Токен подписывания	embeddedSigningSessions.embeddedToken	string	Уникальный маркер для внедренного сеанса подписи этого получателя.
URL-адрес сеанса подписывания	embeddedSigningSessions.embeddedSessionURL	string	URL-адрес, который нужно открыть или внедрить для этого получателя, чтобы подписать документ.
Внедренный маркер отправки	embeddedToken	string	Маркер для внедренного сеанса отправки. Значение true только при созданииEmbeddedSendingSession.
Отправка URL-адреса сеанса	embeddedSessionURL	string	URL-адрес для открытия или внедрения для автора конверта для подготовки и отправки конверта. Значение true только при созданииEmbeddedSendingSession.
Result	result	string	Результат операции.
Message	message	string	Сообщение, описывающее результат операции.

Создание конверта из шаблона

Идентификатор операции:: CreateEnvelopefromTemplate

Создает и отправляет конверт с помощью существующего шаблона. Сведения о получателе можно настроить.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя конверта	folderName		string	Имя папки документов. Если это значение не указано, имя папки документа сохраняется так же, как и имена шаблонов.
Идентификаторы шаблона	templateIds	True	array of integer	Массив идентификаторов шаблонов, которые вы хотите использовать для создания документов для этой папки.
Поля	fields		object	Вы можете передать значения полей, используемые в шаблонах, чтобы предварительно заполнить их в документах, созданных на основе шаблона. FIELD_NAME — это имя поля, используемого в шаблоне. FIELD_VALUE — это значение поля документа.
Расширенная проверка электронной почты	allowAdvancedEmailValidation		boolean	Проверьте адреса электронной почты сторон, если задано значение true.
Имя (Первое имя)	firstName	True	string	Имя получателя.
Фамилия	lastName	True	string	Фамилия получателя.
Адрес электронной почты	emailId	True	string	Адрес электронной почты получателя.
permissions	permission	True	string
Последовательность	sequence	True	integer	Используйте это поле, чтобы назначить получателю порядковый номер в списке сторон-получателей. Используйте уникальные порядковые номера для каждой стороны, начиная с 1, например 1,2,3,4.... Если один пользователь отображается несколько раз в рабочем процессе подписывания, назначьте другую последовательность каждый раз, когда получатель повторяется.
signerAuthLevels	signerAuthLevel		string	Уровень проверки подлинности, который подписыватель будет использовать в целях проверки
Заполнитель	isPlaceholder		boolean	Используйте это поле для инициирования стороной заполнителя. Примечание. 1. Значение параметра firstName, lastName, emailId должно быть пустым для этой стороны. 2. Чтобы добавить заполнитель, один получатель должен быть переквалван с разрешением "PARTY_ASSIGNER".
Роль получателя	partyRole		string	Используйте это поле для назначения роли заполнителя.
Разрешить изменение имени	allowNameChange		string	Значение может иметь значение true или false. Этот параметр позволяет подписывшему обновлять имя и фамилию перед завершением процесса подписывания.
Последовательность рабочих процессов	workflowSequence		integer	Назначьте этому получателю порядковый номер рабочего процесса. Если включена последовательность входа, получатели получают приглашение на подписывание в порядке последовательности по возрастанию.
Идентификатор электронной почты узла	hostEmailId		string	Адрес электронной почты администратора In-Person.
Код доступа	userDefinedAccessCode		string	Параметр будет содержать код доступа, если значение signerAuthLevel задано как "Определяемый пользователем код доступа" для проверки подлинности. Примечание. 1. Коды не учитывает регистр. 2. Система не отправляет этот код, поэтому необходимо предоставить общий доступ к этому коду напрямую с подписывателем. 3. Код доступа может содержать алфавиты, числа и следующие специальные символы: @,&,{,},%,(),~,\|,!,+,^.
Партия — группа электронной почты	partyIsEmailGroup		boolean	Используйте этот параметр при создании участника в качестве массового. Примечание: Если этот параметр имеет значение true, firstName, lastName и emailId этой стороны будут игнорироваться.
Идентификатор группы электронной почты	emailGroupId		integer	Передайте адрес электронной почты идентификатор группы, который вы хотите использовать для массового создания.
Массовая операция единого входа	allowSingleSignerInBulk		boolean	Используйте этот параметр, чтобы разрешить вход только одному пользователю в группу электронной почты.
Код набора	dialingCode		string	Используйте это поле для назначения кодов телефонного номера страны— это префиксы мобильного номера получателю в списке получателей.
Номер мобильного устройства	mobileNumber		string	Используйте это поле для назначения мобильного номера получателю в списке сторон-получателей.
Пароль конверта	folderPassword		string	Этот пароль потребуется для входа или автора, чтобы открыть документ с цифровой подписью. Если параметр остается пустым, пароль не потребуется для открытия документа с цифровой подписью.
Последовательность входа	signInSequence		boolean	Это поле используется для определения того, будут ли получатели подписывать документы конверта в последовательности. Если значение false, все получатели получают приглашение по электронной почте одновременно. Когда значение true, каждый получатель получает приглашение по электронной почте последовательно после того, как предыдущий получатель завершает требуемую задачу, например подписывание документов или полей заполнения и т. д.
Включение пользователя	inPersonEnable		boolean	Это поле используется для запуска процесса подписи пользователя, который можно легко завершить на любом устройстве в течение нескольких минут и избегает подписей на основе электронной почты, где это необходимо. Если значение false, все получатели получают приглашение по электронной почте одновременно. Когда значение true, администратор получает приглашение, чтобы инициировать процесс подписывания для подписывчика.
Отправить сейчас	sendNow		boolean	При включении Foxit eSign немедленно отправляет уникальную ссылку подписи на адрес электронной почты каждого получателя. Отключите это, чтобы сохранить конверт в виде черновика.
Подписать URL-адрес успешности всех сторон	signSuccessUrlAllParties		boolean	Если задано значение true, подписыватель будет перенаправлен на URL-адрес, предоставленный в signSuccessUrl после успешного подписания. Это применимо только в том случае, если значение sendNow имеет значение true.
Создание внедренного сеанса отправки	createEmbeddedSendingSession		boolean	Если задано значение true, он создаст внедренный URL-адрес для открытия представления подготовки документа Foxit eSign.
Исправление сторон получателя	fixRecipientParties		boolean	Если значение true, то в внедренном представлении отправки не удается изменить стороны конверта, которые уже добавлены в рамках этого запроса.
Исправление документов	fixDocuments		boolean	Если значение true, то в внедренной отправке не удается изменить документы для конверта, который уже добавлен в рамках этого запроса.
Отправить URL-адрес успешного выполнения	sendSuccessUrl		string	Введите абсолютный URL-адрес целевой страницы, на которую подписыватель будет перенаправлен после успешной отправки папки в внедренном представлении отправки.
Url-адрес ошибки отправки	sendErrorUrl		string	Введите абсолютный URL-адрес целевой страницы, на которую подписыватель будет перенаправлен, если ошибка возникает во время отправки папки в внедренном представлении отправки.
Параметр выбора средства скрытия подписывателя	hideSignerSelectOption		boolean	Если задано значение true, оно скрывает поле ввода "Существующее имя и электронная почта" для получателей в внедренном сеансе отправки.
Скрытие действий подписи	hideSignerActions		boolean	Если значение true, оно скрывает подписыватель "изменить", "изменить" и "удалить" действия для получателей в внедренном сеансе отправки.
Скрыть имя отправителя	hideSenderName		boolean	Если значение true, оно скрывает имя отправителя на получателях в внедренном сеансе отправки.
Кнопка "Скрыть отправку"	hideSendButton		boolean	Если задано значение true, кнопка "Отправить" будет скрыта во встроенном сеансе отправки.
Скрыть имя папки	hideFolderName		boolean	Если задано значение true, имя папки будет скрыто при навигации в обоих внедренных сеансах.
Скрытие имени документов	hideDocumentsName		boolean	Если значение true, оно скрывает имя документа в обоих внедренных сеансах.
Кнопка "Скрыть добавить меня"	hideAddMeButton		boolean	Если значение true, оно скрывает кнопку "Добавить меня" для получателей в внедренном сеансе отправки.
Скрыть кнопку "Добавить новую"	hideAddNewButton		boolean	Если значение true, оно скрывает кнопку "Добавить новый" для получателей в внедренном сеансе отправки.
Кнопка "Скрыть добавление группы"	hideAddGroupButton		boolean	Если значение true, оно скрывает кнопку "Добавить группу" для получателей в внедренном сеансе отправки.
Создание внедренного сеанса подписывания	createEmbeddedSigningSession		boolean	Маркер сеанса подписывания будет создан без отправки сообщений электронной почты получателям.
Создание внедренного сеанса подписи для всех сторон	createEmbeddedSigningSessionForAllParties		boolean	Если задано значение true, для каждого получателя в конверте создается внедренный URL-адрес подписи. Если значение false, то только получатели, перечисленные в идентификаторах электронной почты внедренных подписей, получают внедренный сеанс.
Встроенные идентификаторы электронной почты подписывания	embeddedSignersEmailIds		array of string	Массив идентификаторов электронной почты получателей, для которых необходимо создать внедренный сеанс подписи. Идентификаторы электронной почты от получателей, добавленные в список сторон.
Url-адрес успешности подписывания	signSuccessUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены после успешного входа в внедренное представление подписи.
URL-адрес отклонения подписи	signDeclineUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены, если отказ в входе в внедренное представление подписывания.
Url-адрес для входа позже	signLaterUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены, если вы решите войти позже в внедренном представлении подписи.
URL-адрес ошибки подписи	signErrorUrl		string	Введите абсолютный URL-адрес для подписчиков, которые будут перенаправлены на сообщение об ошибке при подписании документа в внедренном представлении подписывания.
Скрыть следующее обязательное поле Btn	hideNextRequiredFieldBtn		boolean	Если задано значение true, скрывает кнопку навигации, которая перемещает подписывающих элементов в следующее необходимое поле.
Цвет темы	themeColor		string	Введите значение CSS, чтобы задать цвет темы.
Скрыть отклонить знак	hideDeclineToSign		boolean	Если задано значение true, скрывает параметр "Отклонить для входа" на экране подписывания.
Скрытие дополнительных действий	hideMoreAction		boolean	Если задано значение true, скрывает кнопку "Дополнительные действия" в сеансе отправки и подписывания. Не действует, если send Now имеет значение true.
Скрытие параметра "Добавить стороны"	hideAddPartiesOption		boolean	Если задано значение true, скрыт параметр добавления сторон в режиме создания черновика и шаблона.
Срок действия сеанса	sessionExpire		boolean	Задайте значение true, чтобы инициировать срок действия внедренного сеанса подписи.
Истечение срока	expiry		integer	Требуется, если sessionExpire имеет значение true. Введите длительность в миллисекундах истечения срока действия в внедренном сеансе подписи.
Электронная почта отправителя	senderEmail		string	введите сообщение электронной почты другого пользователя в учетной записи, которая будет использоваться для отправки этой папки документа участникам получателя.
Разрешить отправку и внедренный сеанс подписи	allowSendNowAndEmbeddedSigningSession		boolean	Если задано значение true, Foxit eSign отправляет приглашение на подпись каждому получателю, а также создает внедренную ссылку подписи для получателей, электронная почта которых включена в embedded Signer Email. Электронная почта и внедренная ссылка одновременно активны.
Включение пошаговые шаги	enableStepByStep		boolean	Чтобы включить пошаговое действие в внедренном сеансе отправки.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнена ли операция успешно (например, "успешно").
Message	message	string	Описание результата операции.
Внедренные сеансы подписывания	embeddedSigningSessions	array of object	Список внедренных сеансов подписывания, по одному на получателя. Только если createEmbeddedSigningSession имеет значение true.
Электронная почта подписывющего средства	embeddedSigningSessions.emailIdOfSigner	string	Адрес электронной почты получателя для этого внедренного сеанса подписи.
Токен подписывания	embeddedSigningSessions.embeddedToken	string	Уникальный маркер для внедренного сеанса подписи этого получателя.
URL-адрес сеанса подписывания	embeddedSigningSessions.embeddedSessionURL	string	URL-адрес, который нужно открыть или внедрить для этого получателя, чтобы подписать документ.
Внедренный маркер отправки	embeddedToken	string	Маркер для внедренного сеанса отправки. Значение true только при созданииEmbeddedSendingSession.
Отправка URL-адреса сеанса	embeddedSessionURL	string	URL-адрес для открытия или внедрения для автора конверта для подготовки и отправки конверта. Значение true только при созданииEmbeddedSendingSession.
Идентификатор	folder.folderId	integer	Уникальный идентификатор созданного конверта. Используйте это для ссылки на конверт в последующих действиях.
Name	folder.folderName	string	Имя конверта.
Пользовательское имя	folder.folderCustomName	string	Пользовательское имя, назначенное конверту.
Password	folder.folderPassword	string	Пароль, заданный для конверта( если таковой есть).
Идентификатор автора	folder.folderAuthorId	integer	Уникальный идентификатор пользователя, создавшего конверт.
Имя автора	folder.folderAuthorFirstName	string	Первое имя создателя конверта.
Автор фамилии	folder.folderAuthorLastName	string	Фамилия создателя конверта.
Создание электронной почты	folder.folderAuthorEmail	string	Адрес электронной почты создателя конверта.
Роль автора	folder.folderAuthorRole	string	Роль учетной записи создателя конверта.
Идентификатор компании	folder.folderCompanyId	integer	Уникальный идентификатор компании, к которой принадлежит конверт.
Дата создания	folder.folderCreationDate	integer	Дата и время создания конверта в миллисекундах Unix.
Дата отправки	folder.folderSentDate	integer	Дата и время отправки конверта получателям в миллисекундах Unix.
Статус	folder.folderStatus	string	Текущее состояние конверта (например, SHARED, EXECUTED, ЧЕРНОВИК, ОТМЕНЕНО).
Настраиваемое поле 1	folder.custom_field1	string	Значение настраиваемого поля 1, заданное в конверте.
Настраиваемое поле 2	folder.custom_field2	string	Значение настраиваемого поля 2, заданное в конверте.
Metadata	folder.metadata	string	Любые дополнительные метаданные, связанные с конвертом.
Идентификаторы документов	folder.folderDocumentIds	array of integer	Список идентификаторов документов, включенных в этот конверт.
Documents	folder.documentsList	array of object	Сведения о каждом документе, включенном в конверт.
Код документа	folder.documentsList.documentId	integer	Уникальный идентификатор документа.
Идентификатор контракта	folder.documentsList.contractId	integer	Уникальный идентификатор контракта, связанного с этим документом.
Идентификатор компании	folder.documentsList.companyId	integer	Уникальный идентификатор компании, к которой принадлежит этот документ.
Создано кем	folder.documentsList.contractCreatedBy	integer	Идентификатор пользователя, создавшего контракт.
Создано	folder.documentsList.contractCreatedOn	string	Дата создания контракта.
Тип контракта	folder.documentsList.contractType	string	Тип контракта.
Состояние документа	folder.documentsList.contractStatus	string	Текущее состояние подписи документа (например, WAITING_FOR_SIGNATURE, EXECUTED).
Возможно изменение	folder.documentsList.editable	boolean	Указывает, можно ли изменить документ.
Идентификатор версии	folder.documentsList.contractVersionId	integer	Уникальный идентификатор текущей версии документа.
Имя версии	folder.documentsList.contractVersionName	string	Имя текущей версии документа.
Описание версии	folder.documentsList.contractVersionDesc	string	Описание текущей версии документа.
Версия, созданная с помощью	folder.documentsList.versionCreatedby	integer	Идентификатор пользователя, создавшего эту версию документа.
Версия, созданная в	folder.documentsList.versionCreatedOn	string	Дата создания версии документа.
Номер версии	folder.documentsList.contractVersionNumber	integer	Номер версии документа.
Источник транзакций	folder.documentsList.contractTransactionSource	string	Источник транзакции контракта.
Получатели	folder.folderRecipientParties	array of object	Список получателей для этого конверта, включая отдельные ссылки подписывания.
Идентификатор получателя	folder.folderRecipientParties.partyId	integer	Уникальный идентификатор получателя.
Идентификатор получателя	folder.folderRecipientParties.partyDetails.partyId	integer	Уникальный идентификатор получателя.
Имя (Первое имя)	folder.folderRecipientParties.partyDetails.firstName	string	Имя получателя.
Фамилия	folder.folderRecipientParties.partyDetails.lastName	string	Фамилия получателя.
Адрес электронной почты	folder.folderRecipientParties.partyDetails.emailId	string	Адрес электронной почты получателя.
Заполнитель	folder.folderRecipientParties.partyDetails.placeholder	boolean	Указывает, является ли этот получатель заполнителем.
Address	folder.folderRecipientParties.partyDetails.address	string	Адрес получателя.
Дата создания учетной записи	folder.folderRecipientParties.partyDetails.dateCreated	integer	Дата создания учетной записи получателя в миллисекундах Unix.
Отказ от сообщений электронной почты	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Указывает, отказался ли получатель от уведомлений по электронной почте.
Уникальный идентификатор участника	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Уникальный идентификатор строки для получателя.
Уровень проверки подлинности	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Уровень проверки подлинности, необходимый для этого получателя.
Идентификатор компании	folder.folderRecipientParties.partyDetails.companyId	integer	Идентификатор компании, к которой принадлежит получатель.
Роль пользователя	folder.folderRecipientParties.partyDetails.userRole	string	Роль получателя в своей организации.
Отдел	folder.folderRecipientParties.partyDetails.department	string	Отдел получателя.
Название	folder.folderRecipientParties.partyDetails.title	string	Название задания получателя.
Активный	folder.folderRecipientParties.partyDetails.active	boolean	Указывает, активна ли учетная запись получателя.
Код набора	folder.folderRecipientParties.partyDetails.dialingCode	string	Код номера телефона получателя.
Номер мобильного устройства	folder.folderRecipientParties.partyDetails.mobileNumber	string	Номер мобильного телефона получателя.
Описание субподрядчика	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Описание субподрядчика, если применимо.
Организация субподрядчика	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Название организации субподрядчика, если применимо.
Дата добавления субподрядчика	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Дата добавления субподрядчика в миллисекундах Unix.
Source	folder.folderRecipientParties.partyDetails.source	string	Источник, через который был добавлен получатель.
Код набора	folder.folderRecipientParties.dialingCode	string	Код абонентского номера получателя.
Номер мобильного устройства	folder.folderRecipientParties.mobileNumber	string	Мобильный номер получателя.
Тип подписи	folder.folderRecipientParties.signerSignatureType	string	Тип подписи, разрешенный для этого получателя.
Разрешения	folder.folderRecipientParties.contractPermissions	string	Разрешения подписывания, предоставленные этому получателю (например, FILL_FIELDS_AND_SIGN).
Порядок подписывания	folder.folderRecipientParties.partySequence	integer	Позиция этого получателя в порядке подписи.
Последовательность рабочих процессов	folder.folderRecipientParties.workflowSignSequence	integer	Номер последовательности подписывания рабочего процесса для этого получателя.
Идентификатор конверта	folder.folderRecipientParties.envelopeId	integer	Идентификатор конверта, к которому принадлежит этот получатель.
Идентификатор компании-участника	folder.folderRecipientParties.partyCompanyId	integer	Идентификатор компании, к которой принадлежит этот получатель.
Режим общего доступа	folder.folderRecipientParties.sharingMode	string	Метод, используемый для совместного использования документа с этим получателем (например, электронной почты).
URL-адрес подписывания	folder.folderRecipientParties.folderAccessURL	string	Уникальный URL-адрес подписи для этого получателя. Используйте эту ссылку для прямого доступа к ссылке подписывания.
Режим безопасности	folder.folderRecipientParties.securityMode	string	Режим безопасности, применяемый к доступу этого получателя.
Дополнительные комментарии	folder.folderRecipientParties.extraComments	string	Любые дополнительные комментарии, включенные в приглашение на подпись для этого получателя.
Разрешить изменение имени	folder.folderRecipientParties.allowNameChange	boolean	Указывает, разрешено ли получателю изменять имя перед подписью.
Обновлено имя	folder.folderRecipientParties.signerNameUpdated	boolean	Указывает, обновил ли получатель отображаемое имя.
Уровень проверки подлинности	folder.folderRecipientParties.signerAuthenticationLevel	string	Метод проверки подлинности, необходимый этому получателю для доступа к документу.
Код доступа	folder.folderRecipientParties.userDefinedAccessCode	string	Код пользовательского доступа, необходимый для открытия документа этим получателем.
Идентификатор подписи	folder.folderRecipientParties.signatureId	string	Идентификатор сохраненной подписи, используемой этим получателем.
Роль получателя	folder.folderRecipientParties.partyRole	string	Роль, назначенная этому получателю в конверте.
Значение поля компании	folder.folderRecipientParties.companyFieldValue	string	Значение поля компании, которое предварительно заполнено для этого получателя.
Значение поля заголовка	folder.folderRecipientParties.titleFieldValue	string	Значение поля заголовка, предварительно заполненное для этого получателя.
Причина подписывания	folder.folderRecipientParties.reasonSigning	string	Причина подписывания, предоставленной этим получателем.
Добавлено поле оплаты	folder.folderRecipientParties.payFieldAdded	boolean	Указывает, было ли добавлено поле оплаты для этого получателя.
Is Payee	folder.folderRecipientParties.payee	boolean	Указывает, является ли получатель выплатой.
Существует повторяющееся поле	folder.folderRecipientParties.recurringFieldExist	boolean	Указывает, существуют ли для этого получателя повторяющиеся поля оплаты.
Печать и подпись завершены	folder.folderRecipientParties.printAndSignCompleted	boolean	Указывает, завершил ли получатель действие печати и подписи.
Разрешить необязательный подписыватель	folder.folderRecipientParties.allowOptionalSigner	boolean	Указывает, может ли этот получатель пропускаться как необязательный подписыватель.
Необязательные подписи	folder.folderRecipientParties.optionalSigners	string	Список необязательных подписчиков, связанных с этим получателем, если таковой есть.
Paid	folder.folderRecipientParties.paid	boolean	Указывает, завершил ли этот получатель платеж.
URL-адрес доступа для автора	folder.folderAccessURLForAuthor	string	URL-адрес автора конверта для доступа к документу.
Черновик URL-адрес доступа	folder.draftFolderAccessURL	string	URL-адрес для доступа к конверту во время его создания в черновике.
Знак комнаты доски	folder.boardRoomSign	boolean	Указывает, включена ли подписывание комнаты доски для этого конверта.
Включить логотип	folder.includeLogo	boolean	Указывает, включен ли логотип компании в уведомления по электронной почте.
Цвет кнопки электронной почты	folder.email_btnBgColor	string	Цвет фона кнопки действия в сообщении для подписывания.
Цвет текста кнопки электронной почты	folder.email_btnTxtColor	string	Цвет текста кнопки действия в сообщении для подписывания.
Логотип электронной почты	folder.emailTemplateLogo	string	Изображение логотипа, используемое в шаблоне электронной почты.
Идентификатор шаблона электронной почты	folder.emailTemplateId	integer	Идентификатор шаблона электронной почты, используемого для подписывания уведомлений.
Заголовок электронной почты	folder.emailHeader	string	Текст пользовательского заголовка в сообщениях электронной почты для уведомлений о подписи.
Нижний колонтитул электронной почты	folder.emailFooter	string	Пользовательский текст нижнего колонтитула в сообщениях электронной почты для подписывания.
Очистка запланированного	folder.purgeFlag	boolean	Указывает, планируется ли этот конверт для автоматической очистки.
Дата начала очистки	folder.purgeStartDate	string	Дата начала периода очистки.
Дата окончания очистки	folder.purgeEndDate	string	Дата очистки конверта.
Массовый идентификатор	folder.bulkId	integer	Идентификатор пакета массовой отправки, к которому относится этот конверт, если он есть.
Принудительное применение порядка подписей	folder.enforceSignWorkflow	boolean	Указывает, должны ли получатели входить в указанный порядок.
Текущий шаг рабочего процесса	folder.currentWorkflowStep	integer	Текущий шаг в рабочем процессе подписывания.
Источник транзакций	folder.transactionSource	string	Источник, инициирующий эту транзакцию конверта.
Возможно изменение	folder.editable	boolean	Указывает, можно ли изменить конверт.
подписывание In-Person	folder.inPersonSignable	boolean	Указывает, может ли конверт быть вошедший в систему лично.
Переопределение напоминаний	folder.overrideAccountReminders	boolean	Указывает, переопределяются ли параметры напоминания на уровне учетной записи для этого конверта.
Переопределение делегирования	folder.overrideAccountRecipientDelegation	boolean	Указывает, переопределяются ли параметры делегирования на уровне учетной записи для этого конверта.
Разрешить делегирование	folder.allowRecipientsToDelegate	boolean	Указывает, могут ли получатели делегировать подписывание другому лицу.
Идентификатор	folder.envelopeId	integer	Уникальный идентификатор конверта. То же значение, что и идентификатор конверта (folderId).
Name	folder.envelopeName	string	Имя конверта. То же значение, что и имя конверта (folderName).
Идентификатор инициатора	folder.envelopeOriginatorId	integer	Идентификатор пользователя, создавшего конверт.
Идентификатор компании	folder.envelopeCompanyId	integer	Идентификатор компании, к которой принадлежит конверт.
Date	folder.envelopeDate	integer	Дата и время создания конверта в миллисекундах Unix.
Общая дата	folder.envelopeSharedDate	integer	Дата и время совместного использования конверта получателями в миллисекундах Unix.
Статус	folder.envelopeStatus	string	Текущее состояние конверта. То же значение, что и состояние конверта (folderStatus).
Идентификаторы контрактов	folder.envelopeContractIds	array of integer	Список идентификаторов контрактов, связанных с этим конвертом.
Разрешения участника	folder.envelopePartyPermissions	array of object	Список получателей и их разрешений подписывания. Та же структура, что и получатели.
Идентификатор получателя	folder.envelopePartyPermissions.partyId	integer	Уникальный идентификатор получателя.
URL-адрес подписывания	folder.envelopePartyPermissions.folderAccessURL	string	Уникальный URL-адрес подписи для этого получателя.
Разрешения	folder.envelopePartyPermissions.contractPermissions	string	Разрешения подписывания для этого получателя.
Порядок подписывания	folder.envelopePartyPermissions.partySequence	integer	Позиция этого получателя в порядке подписи.
Уровень проверки подлинности	folder.envelopeAuthenticationLevel	string	Уровень проверки подлинности, применяемый ко всему конверту.
Разрешить массовую рассылку единого входа	folder.allowSingleSignerInBulk	boolean	Указывает, разрешен ли единый вход в режиме массовой отправки.
Имя на основе файла	folder.folderNameBasedOnFileNaming	boolean	Указывает, является ли имя конверта производным от имени файла.
Имя документа на основе файла	folder.documentNameBasedOnFileNaming	boolean	Указывает, является ли имя документа производным от имени файла.
Имя сертификата на основе файла	folder.certificateNameBasedOnFileNaming	boolean	Указывает, является ли имя сертификата производным от имени файла.
Включение именования файлов	folder.enableFileNamingBeforeExecution	boolean	Указывает, запрашивается ли именование файлов перед отправкой конверта.
Добавлено payee	folder.payeeAddedd	boolean	Указывает, был ли добавлен платеж в конверт.
Самозаверяющего	folder.selfSignerEnabled	boolean	Указывает, является ли отправитель также подписывающей на этом конверте.
Нотарий включено	folder.notaryEnabled	boolean	Указывает, включена ли нотализация для этого конверта.
Ограниченная видимость	folder.limitedVisibilityFlag	boolean	Указывает, включена ли ограниченная видимость документа.
Видимость после подписывания	folder.postSigningVisibility	boolean	Указывает, могут ли получатели просматривать подписанный документ после завершения.
Влажная подпись включена	folder.wetSignatureEnabled	boolean	Указывает, включены ли мокрые (рукописные) подписи для этого конверта.
Слияние включено	folder.mergeEnabled	boolean	Указывает, включена ли слияние документов для этого конверта.

Создание шаблона из Base64

Идентификатор операции:: CreateTemplatefromBase64

Создает новый шаблон с помощью строки PDF в кодировке Base64. Используйте это, если PDF-файл уже доступен в виде строки Base64 в потоке, например из файла SharePoint или документа OneDrive.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя шаблона	templateName	True	string	Имя шаблона. Должен заканчиваться расширением .pdf (например, onboarding.pdf).
Строка файла Base64	base64FileString	True	string	Строка BASE64 PDF для создания шаблона. Он должен быть общедоступным при создании шаблона.
Тип ввода	inputType	True	string	Метод ввода для документа. Для этого действия всегда задано значение base64.
Обработка текстовых тегов	processTextTags	True	boolean	При включении Foxit eSign сканирует документ для текстовых тегов и автоматически преобразует их в поля подписи.
Обработка полей Acro	processAcroFields	True	boolean	При включении Foxit eSign сканирует документ для AcroFields и автоматически преобразует их в поля подписи.
Общий доступ ко всем	shareAll	True	boolean	Поделитесь этим шаблоном со всеми пользователями в вашей учетной записи.
Количество сторон	numberOfParties	True	integer	Количество получателей для этого шаблона. Должно быть меньше 20.
Цвет темы	themeColor		string	Значение цвета CSS для настройки темы внедренного сеанса шаблона (например, #42caf4).
Создание электронной почты	authorEmail		string	Адрес электронной почты другого пользователя в учетной записи, который должен быть задан в качестве автора этого шаблона.
Создание внедренного сеанса шаблона	createEmbeddedTemplateSession		boolean	Если задано значение true, создается внедренный сеанс шаблона, чтобы открыть редактор шаблона Foxit eSign напрямую и перетащить поля в шаблон.
URL-адрес перенаправления	redirectURL		string	Если создать внедренный сеанс шаблона имеет значение true, URL-адрес для перенаправления пользователя после нажатия кнопки "Сохранить и закрыть" в внедренном редакторе шаблонов.
Скрытие шаблона отправки	hideSendTemplate		boolean	Если значение true, кнопка "Отправить" скрыта в внедренном редакторе шаблонов.
Исправление сторон получателя	fixRecipientParties		boolean	Если значение true, получатели, которые уже добавлены, нельзя изменить в внедренном редакторе шаблонов.
Поля	Fields		object
permissions	permission	True	string
Последовательность	sequence	True	integer	Уникальный порядковый номер для этой стороны, начиная с 1. Определяет порядок подписывания при включении последовательности входа.
Роль получателя	partyRole	True	string	Роль, назначенная этой стороне в шаблоне.
Скрытие дополнительных действий	hideMoreAction		boolean	Если значение true, кнопка "Дополнительные действия" скрыта в внедренном сеансе шаблона.
Скрыть общий доступ со всеми	hideShareWithAll		boolean	Если задано значение true, параметр "Общий доступ со всеми" скрыт в внедренном сеансе шаблона.
Скрыть сторону добавления	hideAddParty		boolean	Если задано значение true, все параметры добавления скрыты в внедренном сеансе шаблона.
Кнопка "Скрыть меня"	hideMeButton		boolean	Если значение true, кнопка "Я" на получателях скрыта в внедренном сеансе шаблона.
Кнопка "Скрыть других"	hideOthersButton		boolean	Если значение true, кнопка "Другие" на получателях скрыта в внедренном сеансе шаблона.
Скрытие имени поля для получателей	hideFieldNameForRecipients		boolean	Если задано значение true, имена полей скрыты от получателей для записи данных и расширенных полей.
Скрытие границы флажка	hideCheckboxBorder		boolean	Если задано значение true, границы флажков скрыты в исполняемых документах.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнена ли операция успешно (например, "успешно").
Message	message	string	Описание результата операции.
Идентификатор	template.templateId	integer	Уникальный идентификатор созданного шаблона. Используйте это для создания конвертов из этого шаблона.
Name	template.templateName	string	Имя шаблона.
Description	template.templateDesc	string	Описание шаблона.
Type	template.templateType	string	Тип шаблона.
Дата создания	template.templateCreationDate	string	Дата создания шаблона.
Дата последнего обновления	template.templateLastUpdateDate	string	Дата последнего обновления шаблона.
Возможно изменение	template.editable	boolean	Указывает, можно ли изменить шаблон.
Число сторон	template.numberOfParties	integer	Число получателей, определенных в шаблоне.
Всего страниц	template.totalPages	integer	Общее количество страниц в документе шаблона.
Идентификатор компании	template.companyId	integer	Идентификатор компании, к которой принадлежит этот шаблон.
Общий доступ ко всем	template.shareAll	boolean	Указывает, предоставлен ли этот шаблон всем пользователям в учетной записи.
Разрешения участника	template.templatePartyPermissions	array of object	Список ролей получателя и их разрешений, определенных в этом шаблоне.
ИД стороны	template.templatePartyPermissions.template_party_id	integer	Уникальный идентификатор записи участника шаблона.
Идентификатор	template.templatePartyPermissions.templateId	integer	Идентификатор шаблона, к которому принадлежит эта сторона.
Разрешения	template.templatePartyPermissions.templatePermissions	string	Разрешения подписывания для этой стороны (например, FILL_FIELDS_AND_SIGN).
Порядок подписывания	template.templatePartyPermissions.partySequence	integer	Позиция заказа подписывания для этой стороны.
Роль участника	template.templatePartyPermissions.templatePartyRole	string	Имя роли, назначенное этой стороне в шаблоне. Используйте это при создании конверта из шаблона.
Идентификатор пользователя	template.templateCreatedBy.partyId	integer	Уникальный идентификатор пользователя.
Имя (Первое имя)	template.templateCreatedBy.firstName	string	Имя пользователя.
Фамилия	template.templateCreatedBy.lastName	string	Фамилия пользователя.
Адрес электронной почты	template.templateCreatedBy.emailId	string	Адрес электронной почты пользователя.
Поля шаблона	allfields	array of object	Список всех полей подписи и формы, определенных в шаблоне.
Идентификатор поля	allfields.fieldTagId	integer	Уникальный идентификатор поля.
ИД шаблона	allfields.templateId	integer	Идентификатор шаблона, к которому принадлежит это поле.
Идентификатор компании	allfields.companyId	integer	Учетная запись компании, к которой относится это поле.
Тип поля	allfields.fieldType	string	Тип поля (например, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Номер страницы	allfields.documentPageNumber	integer	Номер страницы документа, в котором размещено это поле.
Ответственный участник	allfields.partyResponsible	integer	Номер последовательности сторон, отвечающий за заполнение этого поля.
Последовательность сторон	allfields.partyResponsibleSequence	integer	Последовательность позиции ответственной стороны.
Идентификатор документа поля	allfields.docFieldId	string	Идентификатор уровня документа для этого поля.
Зависит	allfields.dependent	boolean	Указывает, зависит ли видимость этого поля от значения другого поля.
Порядок вкладок	allfields.tabOrder	integer	Порядок вкладок для навигации между полями.
Обязательный	allfields.required	boolean	Указывает, должно ли это поле быть заполнено перед подписью документа.
Имя настраиваемого поля	allfields.customFieldName	string	Настраиваемое имя, назначенное этому полю.
Общий доступ ко всем	allfields.shareAll	boolean	Указывает, является ли это поле общим для всех пользователей.
Разрешить редактирование	allfields.allowEdit	boolean	Указывает, можно ли изменить это поле получателем.
Имя текстового поля	allfields.textfieldName	string	Метка текстового поля (применимо, если fieldType — textfield).
Ценность	allfields.value	string	Предварительно заполненное или введенное значение поля.
Размер шрифта	allfields.fontSize	integer	Размер шрифта, используемый для текста в этом поле.
Цвет шрифта	allfields.fontColor	string	Цвет шрифта, используемый для текста в этом поле (например, #000000).
Только для чтения	allfields.readOnly	boolean	Указывает, доступно ли поле только для чтения и не может быть изменено получателем.
Многострочный	allfields.multiLine	boolean	Указывает, принимает ли текстовое поле несколько строк входных данных (применимо, если fieldType — textfield).
Ограничение символов	allfields.characterLimit	integer	Максимальное число символов, разрешенных в поле (применимо, если fieldType — textfield).
Имя поля даты	allfields.datefieldName	string	Метка поля даты (применимо, если fieldType — datefield).
Формат даты	allfields.dateFormat	string	Формат даты, используемый этим полем (например, MM/DD/YYYY) (применимо, если тип поля — datefield).
Имя флажка	allfields.cbname	string	Метка поля флажка (применимо, если fieldType — checkboxfield).
Группа флажков	allfields.cbgroup	string	Имя группы для этого флажка (применимо, если fieldType — checkboxfield).
Проверено	allfields.checked	boolean	Указывает, установлен ли флажок по умолчанию (применимо, если параметр fieldType имеет значение checkboxfield).
Имя защищенного поля	allfields.securedfieldName	string	Метка защищенного поля (применимо, если fieldType — securedfield).
Символы для отображения	allfields.charToDisplay	integer	Число незамаскированных символов, отображаемых в конце значения защищенного поля (применимо, если fieldType — securedfield).
Идентификатор подписи	allfields.signatureId	string	Идентификатор подписи, примененной к этому полю знака (применимо, если fieldType имеет значение Signfield).
Начальное изображение	allfields.initialImage	string	Данные изображения для инициал, примененных к этому полю (применимо, если fieldType — initialfield).
Имя поля вложения	allfields.attachmentfieldName	string	Имя поля вложения (применимо, если fieldType — attachmentfield).
Описание вложения	allfields.attachmentfieldDescription	string	Описание того, что нужно подключить (применимо, если fieldType имеет значение "attachmentfield".

Создание шаблона из URL-адреса

Идентификатор операции:: CreateTemplatefromURL

Создает новый шаблон с помощью общедоступного URL-адреса PDF.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя шаблона	templateName	True	string	Имя шаблона. Должен заканчиваться расширением .pdf (например, onboarding.pdf).
URL-адрес шаблона	templateUrl	True	string	Общедоступный URL-адрес PDF-документа, который будет использоваться в качестве шаблона.
Тип ввода	inputType	True	string	Метод ввода для документа. Для этого действия всегда задано значение URL-адрес.
Обработка текстовых тегов	processTextTags	True	boolean	При включении Foxit eSign сканирует документ для текстовых тегов и автоматически преобразует их в поля подписи.
Обработка полей Acro	processAcroFields	True	boolean	При включении Foxit eSign сканирует документ для AcroFields и автоматически преобразует их в поля подписи.
Общий доступ ко всем	shareAll	True	boolean	Поделитесь этим шаблоном со всеми пользователями в вашей учетной записи.
Количество сторон	numberOfParties	True	integer	Добавьте количество сторон в шаблоне. Значения этого параметра должны быть меньше 20.
Цвет темы	themeColor		string	Введите значение css для цвета, чтобы изменить тему createEmbeddedTemplateSession.
Создание электронной почты	authorEmail		string	Введите сообщение электронной почты другого пользователя в учетной записи, которая будет использоваться в качестве автора этого шаблона.
Создание внедренного сеанса шаблона	createEmbeddedTemplateSession		boolean	Если задано значение true, внедренный сеанс шаблона для непосредственного открытия представления подготовки шаблона Foxit eSign. Перетаскивание и удаление различных полей в шаблоне будет доступно.
URL-адрес перенаправления	redirectURL		string	Если createEmbeddedTemplateSession имеет значение true, абсолютный URL-адрес можно ввести для целевой страницы на любом веб-сайте или приложении, на который пользователь будет перенаправлен после нажатия кнопки "Сохранить и закрыть" в внедренном представлении шаблона.
Скрытие шаблона отправки	hideSendTemplate		boolean	Если задано значение true, кнопка "Отправить" будет скрыта в внедренном представлении шаблона.
Исправление сторон получателя	fixRecipientParties		boolean	Если значение true, то в внедренном представлении шаблона не удается изменить стороны для конверта, который уже добавлен.
Поля	Fields		object
permissions	permission	True	string
Последовательность	sequence	True	integer	Уникальный порядковый номер для этой стороны, начиная с 1. Определяет порядок подписывания при включении последовательности входа.
Роль получателя	partyRole	True	string	Роль, назначенная этой стороне в шаблоне.
Скрытие дополнительных действий	hideMoreAction		boolean	Если задано значение true, кнопка "Дополнительные действия" будет скрыта в сеансе шаблона.
Скрыть общий доступ со всеми	hideShareWithAll		boolean	Если задано значение true, он скрывает параметр "Поделиться со всеми" в сеансе шаблона.
Скрыть сторону добавления	hideAddParty		boolean	Если задано значение true, он скрывает все параметры участника в внедренном сеансе шаблона.
Кнопка "Скрыть меня"	hideMeButton		boolean	Если значение true, оно скрывает кнопку "Я" на получателях в внедренном сеансе шаблона.
Кнопка "Скрыть других"	hideOthersButton		boolean	Если значение true, оно скрывает кнопку "Другие" на получателях в внедренном сеансе шаблона.
Скрыть существующий параметр выбора контакта	hideExistingContactSelectOption		boolean	Если значение true, оно скрывает поле ввода "Поиск и добавление существующего контакта" для получателей сторон в внедренном сеансе шаблона.
Скрытие имени поля для получателей	hideFieldNameForRecipients		boolean	Скрытие имен полей для получателей полей записи данных и расширенных полей. (Кроме переключателя, флажка, изображения и гиперссылки).
Скрытие границы флажка	hideCheckboxBorder		boolean	Границы флажка будут скрыты в исполняемых документах.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнена ли операция успешно (например, "успешно").
Message	message	string	Описание результата операции.
Идентификатор	template.templateId	integer	Уникальный идентификатор созданного шаблона. Используйте это для создания конвертов из этого шаблона.
Name	template.templateName	string	Имя шаблона.
Description	template.templateDesc	string	Описание шаблона.
Type	template.templateType	string	Тип шаблона.
Дата создания	template.templateCreationDate	string	Дата создания шаблона.
Дата последнего обновления	template.templateLastUpdateDate	string	Дата последнего обновления шаблона.
Возможно изменение	template.editable	boolean	Указывает, можно ли изменить шаблон.
Число сторон	template.numberOfParties	integer	Число получателей, определенных в шаблоне.
Всего страниц	template.totalPages	integer	Общее количество страниц в документе шаблона.
Идентификатор компании	template.companyId	integer	Идентификатор компании, к которой принадлежит этот шаблон.
Общий доступ ко всем	template.shareAll	boolean	Указывает, предоставлен ли этот шаблон всем пользователям в учетной записи.
Шаблон пользовательского имени	template.templateCustomName	string	Шаблон пользовательского имени, примененный к конвертам, созданным на основе этого шаблона.
Разрешения участника	template.templatePartyPermissions	array of object	Список ролей получателя и их разрешений, определенных в этом шаблоне.
ИД стороны	template.templatePartyPermissions.template_party_id	integer	Уникальный идентификатор записи участника шаблона.
Идентификатор	template.templatePartyPermissions.templateId	integer	Идентификатор шаблона, к которому принадлежит эта сторона.
Разрешения	template.templatePartyPermissions.templatePermissions	string	Разрешения подписывания для этой стороны (например, FILL_FIELDS_AND_SIGN).
Порядок подписывания	template.templatePartyPermissions.partySequence	integer	Позиция заказа подписывания для этой стороны.
Роль участника	template.templatePartyPermissions.templatePartyRole	string	Имя роли, назначенное этой стороне в шаблоне. Используйте это при создании конверта из шаблона.
ИД стороны	template.templatePartyPermissions.partyId	integer	Идентификатор стороны, назначенной этой роли, при предварительной назначении.
Идентификатор пользователя	template.templateCreatedBy.partyId	integer	Уникальный идентификатор пользователя.
Имя (Первое имя)	template.templateCreatedBy.firstName	string	Имя пользователя.
Фамилия	template.templateCreatedBy.lastName	string	Фамилия пользователя.
Адрес электронной почты	template.templateCreatedBy.emailId	string	Адрес электронной почты пользователя.
Идентификатор компании	template.templateCreatedBy.companyId	integer	Идентификатор компании, к которой принадлежит пользователь.
Роль пользователя	template.templateCreatedBy.userRole	string	Роль пользователя в организации.
Активный	template.templateCreatedBy.active	boolean	Указывает, активна ли учетная запись пользователя.
Идентификатор пользователя	template.templateLastUpdatedBy.partyId	integer	Уникальный идентификатор пользователя.
Имя (Первое имя)	template.templateLastUpdatedBy.firstName	string	Имя пользователя.
Фамилия	template.templateLastUpdatedBy.lastName	string	Фамилия пользователя.
Адрес электронной почты	template.templateLastUpdatedBy.emailId	string	Адрес электронной почты пользователя.
Идентификатор компании	template.templateLastUpdatedBy.companyId	integer	Идентификатор компании, к которой принадлежит пользователь.
Роль пользователя	template.templateLastUpdatedBy.userRole	string	Роль пользователя в организации.
Активный	template.templateLastUpdatedBy.active	boolean	Указывает, активна ли учетная запись пользователя.
Поля шаблона	allfields	array of object	Список всех полей подписи и формы, определенных в шаблоне.
Идентификатор поля	allfields.fieldTagId	integer	Уникальный идентификатор поля.
ИД шаблона	allfields.templateId	integer	Идентификатор шаблона, к которому принадлежит это поле.
Идентификатор компании	allfields.companyId	integer	Учетная запись компании, к которой относится это поле.
Тип поля	allfields.fieldType	string	Тип поля (например, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Номер страницы	allfields.documentPageNumber	integer	Номер страницы документа, в котором размещено это поле.
Ответственный участник	allfields.partyResponsible	integer	Номер последовательности сторон, отвечающий за заполнение этого поля.
Последовательность сторон	allfields.partyResponsibleSequence	integer	Последовательность позиции ответственной стороны.
Идентификатор документа поля	allfields.docFieldId	string	Идентификатор уровня документа для этого поля.
Зависит	allfields.dependent	boolean	Указывает, зависит ли видимость этого поля от значения другого поля.
Порядок вкладок	allfields.tabOrder	integer	Порядок вкладок для навигации между полями.
Обязательный	allfields.required	boolean	Указывает, должно ли это поле быть заполнено перед подписью документа.
Имя настраиваемого поля	allfields.customFieldName	string	Настраиваемое имя, назначенное этому полю.
Общий доступ ко всем	allfields.shareAll	boolean	Указывает, является ли это поле общим для всех пользователей.
Разрешить редактирование	allfields.allowEdit	boolean	Указывает, можно ли изменить это поле получателем.
Имя текстового поля	allfields.textfieldName	string	Метка текстового поля (применимо, если fieldType — textfield).
Ценность	allfields.value	string	Предварительно заполненное или введенное значение поля.
Размер шрифта	allfields.fontSize	integer	Размер шрифта, используемый для текста в этом поле.
Цвет шрифта	allfields.fontColor	string	Цвет шрифта, используемый для текста в этом поле (например, #000000).
Только для чтения	allfields.readOnly	boolean	Указывает, доступно ли поле только для чтения и не может быть изменено получателем.
Многострочный	allfields.multiLine	boolean	Указывает, принимает ли текстовое поле несколько строк входных данных (применимо, если fieldType — textfield).
Ограничение символов	allfields.characterLimit	integer	Максимальное число символов, разрешенных в поле (применимо, если fieldType — textfield).
Имя поля даты	allfields.datefieldName	string	Метка поля даты (применимо, если fieldType — datefield).
Формат даты	allfields.dateFormat	string	Формат даты, используемый этим полем (например, MM/DD/YYYY) (применимо, если тип поля — datefield).
Имя флажка	allfields.cbname	string	Метка поля флажка (применимо, если fieldType — checkboxfield).
Группа флажков	allfields.cbgroup	string	Имя группы для этого флажка (применимо, если fieldType — checkboxfield).
Проверено	allfields.checked	boolean	Указывает, установлен ли флажок по умолчанию (применимо, если параметр fieldType имеет значение checkboxfield).
Имя защищенного поля	allfields.securedfieldName	string	Метка защищенного поля (применимо, если fieldType — securedfield).
Символы для отображения	allfields.charToDisplay	integer	Число незамаскированных символов, отображаемых в конце значения защищенного поля (применимо, если fieldType — securedfield).
Идентификатор подписи	allfields.signatureId	string	Идентификатор подписи, примененной к этому полю знака (применимо, если fieldType имеет значение Signfield).
Начальное изображение	allfields.initialImage	string	Данные изображения для инициал, примененных к этому полю (применимо, если fieldType — initialfield).
Имя поля вложения	allfields.attachmentfieldName	string	Имя поля вложения (применимо, если fieldType — attachmentfield).
Описание вложения	allfields.attachmentfieldDescription	string	Описание того, что нужно подключить (применимо, если fieldType имеет значение "attachmentfield".

Удаление конвертов

Идентификатор операции:: DeleteEnvelopes

Окончательно удаляет один или несколько конвертов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы папок	folderIds	True	array of integer	Массив идентификаторов конвертов для действия.

Возвращаемое значение

Имя	Путь	Тип	Описание
Result	result	string	Указывает, выполнена ли операция успешно.

Триггеры

Когда конверт полностью выполняется	Триггеры, когда все получатели подписали и конверт полностью выполняется.
При отмене конверта	Активируется при отмене конверта получателем или отправителем.
При отправке конверта	Активирует при отправке конверта получателям. Это событие возникает только в том случае, если для уровня веб-перехватчика задано значение Account.
При подписании конверта	Активирует, когда получатель подписывает конверт.
При удалении конверта	Активирует при удалении конверта.
Просмотр конверта	Активирует при открытии получателя и просматривает конверт.

Когда конверт полностью выполняется

Идентификатор операции:: TriggerEnvelopeExecuted

Триггеры, когда все получатели подписали и конверт полностью выполняется.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя канала	channelName	True	string	Имя для идентификации этой подписки веб-перехватчика в вашей учетной записи.
Уровень веб-перехватчика	webhookLevel	True	string	Учетная запись: пожары для всех конвертов (веб-интерфейс и API). Приложение API: запускается только для конвертов, созданных с помощью API.
Секрет веб-перехватчика	webhookSecret		string	Optional. Foxit eSign подписывает каждую полезные данные веб-перехватчика с помощью HMAC-SHA-256 с помощью этого секрета для проверки.

Возвращаемое значение

Данные события, полученные от Foxit eSign при срабатывании события веб-перехватчика.

WebhookEventPayload: WebhookEventPayload

При отмене конверта

Идентификатор операции:: TriggerEnvelopeCancelled

Активируется при отмене конверта получателем или отправителем.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя канала	channelName	True	string	Имя для идентификации этой подписки веб-перехватчика в вашей учетной записи.
Уровень веб-перехватчика	webhookLevel	True	string	Учетная запись: пожары для всех конвертов (веб-интерфейс и API). Приложение API: запускается только для конвертов, созданных с помощью API.
Секрет веб-перехватчика	webhookSecret		string	Optional. Foxit eSign подписывает каждую полезные данные веб-перехватчика с помощью HMAC-SHA-256 с помощью этого секрета для проверки.

Возвращаемое значение

Данные события, полученные от Foxit eSign при срабатывании события веб-перехватчика.

WebhookEventPayload: WebhookEventPayload

При отправке конверта

Идентификатор операции:: TriggerEnvelopeSent

Активирует при отправке конверта получателям. Это событие возникает только в том случае, если для уровня веб-перехватчика задано значение Account.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя канала	channelName	True	string	Имя для идентификации этой подписки веб-перехватчика в вашей учетной записи.
Уровень веб-перехватчика	webhookLevel	True	string	Учетная запись: пожары для конвертов, отправленных через Интернет или API. Приложение API: запускается только для конвертов, созданных с помощью API. Событие folder_sent запускается только на уровне учетной записи.
Секрет веб-перехватчика	webhookSecret		string	Optional. Foxit eSign подписывает каждую полезные данные веб-перехватчика с помощью HMAC-SHA-256 с помощью этого секрета для проверки.

Возвращаемое значение

Данные события, полученные от Foxit eSign при срабатывании события веб-перехватчика.

WebhookEventPayload: WebhookEventPayload

При подписании конверта

Идентификатор операции:: TriggerEnvelopeSigned

Активирует, когда получатель подписывает конверт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя канала	channelName	True	string	Имя для идентификации этой подписки веб-перехватчика в вашей учетной записи.
Уровень веб-перехватчика	webhookLevel	True	string	Учетная запись: пожары для всех конвертов (веб-интерфейс и API). Приложение API: запускается только для конвертов, созданных с помощью API.
Секрет веб-перехватчика	webhookSecret		string	Optional. Foxit eSign подписывает каждую полезные данные веб-перехватчика с помощью HMAC-SHA-256 с помощью этого секрета для проверки.

Возвращаемое значение

Данные события, полученные от Foxit eSign при срабатывании события веб-перехватчика.

WebhookEventPayload: WebhookEventPayload

При удалении конверта

Идентификатор операции:: TriggerEnvelopeDeleted

Активирует при удалении конверта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя канала	channelName	True	string	Имя для идентификации этой подписки веб-перехватчика в вашей учетной записи.
Уровень веб-перехватчика	webhookLevel	True	string	Учетная запись: пожары для всех конвертов (веб-интерфейс и API). Приложение API: запускается только для конвертов, созданных с помощью API.
Секрет веб-перехватчика	webhookSecret		string	Optional. Foxit eSign подписывает каждую полезные данные веб-перехватчика с помощью HMAC-SHA-256 с помощью этого секрета для проверки.

Возвращаемое значение

Данные события, полученные от Foxit eSign при срабатывании события веб-перехватчика.

WebhookEventPayload: WebhookEventPayload

Просмотр конверта

Идентификатор операции:: TriggerEnvelopeViewed

Активирует при открытии получателя и просматривает конверт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя канала	channelName	True	string	Имя для идентификации этой подписки веб-перехватчика в вашей учетной записи.
Уровень веб-перехватчика	webhookLevel	True	string	Учетная запись: пожары для всех конвертов (веб-интерфейс и API). Приложение API: запускается только для конвертов, созданных с помощью API.
Секрет веб-перехватчика	webhookSecret		string	Optional. Foxit eSign подписывает каждую полезные данные веб-перехватчика с помощью HMAC-SHA-256 с помощью этого секрета для проверки.

Возвращаемое значение

Данные события, полученные от Foxit eSign при срабатывании события веб-перехватчика.

WebhookEventPayload: WebhookEventPayload

Определения

WebhookEventPayload

Данные события, полученные от Foxit eSign при срабатывании события веб-перехватчика.

Имя	Путь	Тип	Описание
Название мероприятия	event_name	string	Имя события, которое запускается (например, folder_sent, folder_signed, folder_executed).
Дата события	event_date	integer	Дата и время возникновения события (метка времени Unix в миллисекундах).
Идентификатор	data.folder.folderId	integer	Уникальный идентификатор конверта.
Name	data.folder.folderName	string	Имя конверта.
Пользовательское имя	data.folder.folderCustomName	string	Пользовательское имя, назначенное конверту.
Password	data.folder.folderPassword	string	Пароль доступа для конверта, если задан.
Идентификатор создателя	data.folder.folderAuthorId	integer	Идентификатор пользователя создателя конверта.
Имя создателя	data.folder.folderAuthorFirstName	string	Первое имя создателя конверта.
Фамилия создателя	data.folder.folderAuthorLastName	string	Фамилия создателя конверта.
Создатель электронной почты	data.folder.folderAuthorEmail	string	Адрес электронной почты создателя конверта.
Роль создателя	data.folder.folderAuthorRole	string	Роль учетной записи создателя конверта.
Идентификатор компании	data.folder.folderCompanyId	integer	Идентификатор компании, принадлежащий конверту.
Дата создания	data.folder.folderCreationDate	integer	Дата создания конверта (метка времени Unix в миллисекундах).
Дата отправки	data.folder.folderSentDate	integer	Дата отправки конверта (метка времени Unix в миллисекундах).
Статус	data.folder.folderStatus	string	Текущее состояние конверта.
Настраиваемое поле 1	data.folder.custom_field1	string	Первое поле настраиваемых метаданных.
Настраиваемое поле 2	data.folder.custom_field2	string	Второе поле настраиваемых метаданных.
Metadata	data.folder.metadata	string	Пользовательские метаданные, связанные с конвертом.
Идентификаторы документов	data.folder.folderDocumentIds	array of integer	Список идентификаторов документов в конверте.
Documents	data.folder.documentsList	array of object	Список документов в конверте.
Код документа	data.folder.documentsList.documentId	integer	Уникальный идентификатор документа.
Идентификатор контракта	data.folder.documentsList.contractId	integer	Идентификатор контракта для этого документа.
Идентификатор компании	data.folder.documentsList.companyId	integer	Идентификатор компании для этого документа.
Создано кем	data.folder.documentsList.contractCreatedBy	integer	Идентификатор пользователя, создавшего контракт.
Создано	data.folder.documentsList.contractCreatedOn	integer	Дата создания контракта (метка времени Unix в миллисекундах).
Тип контракта	data.folder.documentsList.contractType	string	Тип контракта.
Состояние контракта	data.folder.documentsList.contractStatus	string	Текущее состояние контракта.
Возможно изменение	data.folder.documentsList.editable	boolean	Указывает, является ли документ редактируемым.
Идентификатор версии	data.folder.documentsList.contractVersionId	integer	Идентификатор версии контракта.
Имя версии	data.folder.documentsList.contractVersionName	string	Имя версии контракта.
Описание версии	data.folder.documentsList.contractVersionDesc	string	Описание версии контракта.
Версия, созданная с помощью	data.folder.documentsList.versionCreatedby	integer	Идентификатор пользователя, создавшего эту версию.
Версия, созданная в	data.folder.documentsList.versionCreatedOn	integer	Дата создания этой версии (метка времени Unix в миллисекундах).
Номер версии	data.folder.documentsList.contractVersionNumber	integer	Номер версии контракта.
Источник транзакций	data.folder.documentsList.contractTransactionSource	string	Исходная система, инициирующая контракт.
Получатели	data.folder.folderRecipientParties	array of object	Список получателей для этого конверта.
Идентификатор получателя	data.folder.folderRecipientParties.partyId	integer	Уникальный идентификатор получателя.
Идентификатор получателя	data.folder.folderRecipientParties.partyDetails.partyId	integer	Уникальный идентификатор получателя.
Имя (Первое имя)	data.folder.folderRecipientParties.partyDetails.firstName	string	Имя получателя.
Фамилия	data.folder.folderRecipientParties.partyDetails.lastName	string	Фамилия получателя.
Адрес электронной почты	data.folder.folderRecipientParties.partyDetails.emailId	string	Адрес электронной почты получателя.
Placeholder	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	Указывает, является ли это получателем заполнителя.
Address	data.folder.folderRecipientParties.partyDetails.address	string	Адрес получателя.
Дата создания	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	Дата создания записи получателя (метка времени Unix в миллисекундах).
Отказ от сообщений электронной почты	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Отказались ли получатель от сообщений электронной почты.
Уникальный идентификатор	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	Уникальный системный идентификатор для этого получателя.
Уровень проверки подлинности	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	Метод проверки подлинности для этого получателя.
Дата обновления пароля	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Дата последнего обновления пароля.
Состояние пароля	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Обновляется ли пароль.
Код набора	data.folder.folderRecipientParties.dialingCode	string	Международный код набора.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	Мобильный номер получателя.
Тип подписи	data.folder.folderRecipientParties.signerSignatureType	string	Тип подписи, который будет использовать подписыватель.
Разрешения	data.folder.folderRecipientParties.contractPermissions	string	Разрешения, предоставленные этому получателю.
Порядок подписывания	data.folder.folderRecipientParties.partySequence	integer	Порядок подписывания для этого получателя.
Последовательность рабочих процессов	data.folder.folderRecipientParties.workflowSignSequence	integer	Порядковый номер подписывания рабочего процесса.
Идентификатор конверта	data.folder.folderRecipientParties.envelopeId	integer	Идентификатор конверта, связанный с этим получателем.
Идентификатор компании-получателя	data.folder.folderRecipientParties.partyCompanyId	integer	Идентификатор компании этого получателя.
Режим общего доступа	data.folder.folderRecipientParties.sharingMode	string	Режим общего доступа для этого получателя.
URL-адрес подписи получателя	data.folder.folderRecipientParties.folderAccessURL	string	URL-адрес этого получателя для доступа и подписывания конверта.
Режим безопасности	data.folder.folderRecipientParties.securityMode	string	Режим безопасности для этого получателя.
Comments	data.folder.folderRecipientParties.extraComments	string	Дополнительные комментарии для получателя.
Разрешить изменение имени	data.folder.folderRecipientParties.allowNameChange	boolean	Может ли получатель обновить свое имя.
Обновлено имя	data.folder.folderRecipientParties.signerNameUpdated	boolean	Обновляет ли подписыватель свое имя.
Уровень проверки подлинности подписи	data.folder.folderRecipientParties.signerAuthenticationLevel	string	Уровень проверки подлинности, необходимый для входа.
Код доступа	data.folder.folderRecipientParties.userDefinedAccessCode	string	Пользовательский код доступа для подписывчика.
Идентификатор подписи	data.folder.folderRecipientParties.signatureId	string	Идентификатор примененной подписи.
Роль	data.folder.folderRecipientParties.partyRole	string	Роль этого получателя в рабочем процессе подписывания.
Поле компании	data.folder.folderRecipientParties.companyFieldValue	string	Значение поля имени компании.
Поле заголовка	data.folder.folderRecipientParties.titleFieldValue	string	Значение поля заголовка.
Причина подписывания	data.folder.folderRecipientParties.reasonSigning	string	Причина, указанная для подписания.
Добавлено поле оплаты	data.folder.folderRecipientParties.payFieldAdded	boolean	Будет ли добавлено поле оплаты.
Получатель	data.folder.folderRecipientParties.payee	boolean	Указывает, является ли этот получатель выплатой.
Повторяющийся платеж	data.folder.folderRecipientParties.recurringFieldExist	boolean	Существует ли повторяющееся поле оплаты.
Печать и подписание готово	data.folder.folderRecipientParties.printAndSignCompleted	boolean	Выполняется ли печать и знак.
Необязательный подписыватель	data.folder.folderRecipientParties.allowOptionalSigner	boolean	Указывает, является ли этот получатель необязательным подписывщиком.
Необязательные подписи	data.folder.folderRecipientParties.optionalSigners	array of integer	Необязательные идентификаторы стороннего участника.
Paid	data.folder.folderRecipientParties.paid	boolean	Завершена ли оплата.
URL-адрес доступа для автора	data.folder.folderAccessURLForAuthor	string	URL-адрес автора конверта для доступа к конверту.
Черновик URL-адрес доступа	data.folder.draftFolderAccessURL	string	URL-адрес для доступа к конверту в состоянии черновика.
Подписание зала заседаний	data.folder.boardRoomSign	boolean	Включен ли режим подписывания в зале заседаний.
Включить логотип	data.folder.includeLogo	boolean	Включен ли логотип компании в сообщения электронной почты.
Цвет фона кнопки	data.folder.email_btnBgColor	string	Цвет фона кнопки действия электронной почты.
Цвет текста кнопки	data.folder.email_btnTxtColor	string	Цвет текста кнопки действия электронной почты.
Логотип электронной почты	data.folder.emailTemplateLogo	string	URL-адрес логотипа, используемый в шаблоне электронной почты.
Идентификатор шаблона электронной почты	data.folder.emailTemplateId	integer	Идентификатор используемого шаблона электронной почты.
Заголовок электронной почты	data.folder.emailHeader	string	Текст заголовка в сообщениях электронной почты уведомлений.
Нижний колонтитул электронной почты	data.folder.emailFooter	string	Текст нижнего колонтитула в сообщениях электронной почты уведомлений.
Очистка запланированного	data.folder.purgeFlag	boolean	Планируется ли очистка конверта.
Дата начала очистки	data.folder.purgeStartDate	string	Дата начала расписания очистки.
Дата окончания очистки	data.folder.purgeEndDate	string	Дата окончания расписания очистки.
Массовый идентификатор	data.folder.bulkId	integer	Идентификатор операции массового отправки, если применимо.
Принудительное применение порядка подписей	data.folder.enforceSignWorkflow	boolean	Должен ли получатель войти в определенный порядок.
Текущий шаг рабочего процесса	data.folder.currentWorkflowStep	integer	Текущий шаг в рабочем процессе подписывания.
Источник транзакций	data.folder.transactionSource	string	Исходная система, инициирующая эту транзакцию.
Возможно изменение	data.folder.editable	boolean	Можно ли изменить конверт.
подписывание In-Person	data.folder.inPersonSignable	boolean	Поддерживает ли конверт подписывание пользователя.
Переопределение напоминаний	data.folder.overrideAccountReminders	boolean	Переопределяются ли параметры напоминания на уровне учетной записи.
Переопределение делегирования	data.folder.overrideAccountRecipientDelegation	boolean	Переопределяются ли параметры делегирования на уровне учетной записи.
Разрешить делегирование	data.folder.allowRecipientsToDelegate	boolean	Может ли получатель делегировать подпись.
Идентификатор	data.folder.envelopeId	integer	Уникальный идентификатор конверта (псевдоним folderId).
Name	data.folder.envelopeName	string	Имя конверта (псевдоним folderName).
Идентификатор инициатора	data.folder.envelopeOriginatorId	integer	Идентификатор пользователя, который был создан конвертом.
Идентификатор компании	data.folder.envelopeCompanyId	integer	Идентификатор компании, принадлежащий конверту.
Date	data.folder.envelopeDate	integer	Дата создания конверта (метка времени Unix в миллисекундах).
Общая дата	data.folder.envelopeSharedDate	integer	Дата совместного использования конверта (метка времени Unix в миллисекундах).
Статус	data.folder.envelopeStatus	string	Текущее состояние конверта.
Идентификаторы контрактов	data.folder.envelopeContractIds	array of integer	Идентификаторы контракта, связанные с этим конвертом.
Разрешения участника	data.folder.envelopePartyPermissions	array of object	Список разрешений получателя (та же структура, что и получатели).
Идентификатор получателя	data.folder.envelopePartyPermissions.partyId	integer	Уникальный идентификатор получателя.
Идентификатор получателя	data.folder.envelopePartyPermissions.partyDetails.partyId	integer
Имя (Первое имя)	data.folder.envelopePartyPermissions.partyDetails.firstName	string
Фамилия	data.folder.envelopePartyPermissions.partyDetails.lastName	string
Адрес электронной почты	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Placeholder	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Address	data.folder.envelopePartyPermissions.partyDetails.address	string
Дата создания	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
Отказ от сообщений электронной почты	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
Уникальный идентификатор	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
Уровень проверки подлинности	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
Дата обновления пароля	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
Состояние пароля	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean
Код набора	data.folder.envelopePartyPermissions.dialingCode	string
Mobile	data.folder.envelopePartyPermissions.mobileNumber	string
Тип подписи	data.folder.envelopePartyPermissions.signerSignatureType	string
Разрешения	data.folder.envelopePartyPermissions.contractPermissions	string
Порядок подписывания	data.folder.envelopePartyPermissions.partySequence	integer
Последовательность рабочих процессов	data.folder.envelopePartyPermissions.workflowSignSequence	integer
Идентификатор конверта	data.folder.envelopePartyPermissions.envelopeId	integer
Идентификатор компании-получателя	data.folder.envelopePartyPermissions.partyCompanyId	integer
Режим общего доступа	data.folder.envelopePartyPermissions.sharingMode	string
URL-адрес подписи получателя	data.folder.envelopePartyPermissions.folderAccessURL	string
Режим безопасности	data.folder.envelopePartyPermissions.securityMode	string
Comments	data.folder.envelopePartyPermissions.extraComments	string
Разрешить изменение имени	data.folder.envelopePartyPermissions.allowNameChange	boolean
Обновлено имя	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
Уровень проверки подлинности подписи	data.folder.envelopePartyPermissions.signerAuthenticationLevel	string
Код доступа	data.folder.envelopePartyPermissions.userDefinedAccessCode	string
Идентификатор подписи	data.folder.envelopePartyPermissions.signatureId	string
Роль	data.folder.envelopePartyPermissions.partyRole	string
Поле компании	data.folder.envelopePartyPermissions.companyFieldValue	string
Поле заголовка	data.folder.envelopePartyPermissions.titleFieldValue	string
Причина подписывания	data.folder.envelopePartyPermissions.reasonSigning	string
Добавлено поле оплаты	data.folder.envelopePartyPermissions.payFieldAdded	boolean
Получатель	data.folder.envelopePartyPermissions.payee	boolean
Повторяющийся платеж	data.folder.envelopePartyPermissions.recurringFieldExist	boolean
Печать и подписание готово	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
Необязательный подписыватель	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
Необязательные подписи	data.folder.envelopePartyPermissions.optionalSigners	array of integer
Paid	data.folder.envelopePartyPermissions.paid	boolean
Уровень проверки подлинности	data.folder.envelopeAuthenticationLevel	string	Уровень проверки подлинности, необходимый для конверта.
Массовая операция единого входа	data.folder.allowSingleSignerInBulk	boolean	Разрешен ли единый вход в массовом режиме.
имя папки File-Based	data.folder.folderNameBasedOnFileNaming	boolean
имя документа File-Based	data.folder.documentNameBasedOnFileNaming	boolean
File-Based имя сертификата	data.folder.certificateNameBasedOnFileNaming	boolean
Именование файлов pre-Exec	data.folder.enableFileNamingBeforeExecution	boolean
Добавлено payee	data.folder.payeeAddedd	boolean
включена Self-Signing	data.folder.selfSignerEnabled	boolean
Нотарий включено	data.folder.notaryEnabled	boolean
Ограниченная видимость	data.folder.limitedVisibilityFlag	boolean
Видимость после знака	data.folder.postSigningVisibility	boolean
Мокрый сигнатур	data.folder.wetSignatureEnabled	boolean
Слияние включено	data.folder.mergeEnabled	boolean

binary

Это базовый тип данных binary.