Демонстрация Docusign (предварительная версия)
Docusign позволяет организациям создавать, фиксировать и управлять ими в течение всего жизненного цикла соглашения. Клиенты могут ускорить доход, уменьшить риск и разблокировать ценность соглашений, которые выполняют свой бизнес. Соединитель Docusign Demo подключается только к демонстрационной среде Docusign, но предлагает те же функции, что и рабочий соединитель DocuSign. Любые соглашения в демонстрационной среде Docusign не являются юридически обязательными.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Стандарт | Все регионы Power Automate за исключением следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: - Azure регионы Китая - Министерство обороны США (DoD) |
| Power Apps | Стандарт | Все регионы Power Apps кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Стандарт | Все регионы Power Automate за исключением следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | docusign |
| URL | https://support.docusign.com |
| Метаданные соединителя | |
|---|---|
| Publisher | DocuSign, Inc. |
| Website | https://www.docusign.com |
| Политика конфиденциальности | https://www.docusign.com/company/privacy-policy |
| Категории | Содержимое и файлы; Продуктивность |
Название
DocuSign помогает организациям подключаться и автоматизировать процесс подготовки, подписывания, выполнения действий и управления соглашениями. Соединитель DocuSign Demo подключается только к демонстрационной среде DocuSign, но предоставляет те же функции, что и обычный соединитель DocuSign. Любые документы в демонстрационной среде DocuSign не являются юридически обязательными. Для всех вариантов использования, отличных от демонстрации, используйте обычный соединитель DocuSign.
Предпосылки
Чтобы использовать триггер Connect в этой интеграции, DocuSign Connect необходимо включить в учетной записи DocuSign. Она не включена по умолчанию. После включения страницу "Параметры подключения" можно получить из веб-приложения администратора DocuSign. С помощью триггера Connect в этой интеграции автоматически регистрируется веб-перехватчик.
Получение учетных данных
Чтобы попробовать соединитель, используйте учетную запись DEMO:
- Перейдите по адресу https://developers.docusign.com/
- Создайте учетную запись песочницы.
Они отличаются от бесплатных пробных версий, которые они никогда не истекают, имеют 90% функций платной учетной записи, и ни один из документов, отправленных через DEMO, не являются юридически обязательными (https://support.docusign.com/en/articles/Free-account-vs-Developer-account).
Документация по соединителю
Подробные сведения о соединителе см. в этой статье. https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
Известные проблемы и ограничения
Для проблем с DocuSign сначала попробуйте эту ссылку: https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center
Инструкции по развертыванию
Используйте инструкции для развертывания этого соединителя в качестве пользовательского соединителя в Microsoft Power Automate и Power Apps.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 250 | 60 секунд |
Действия
| DEPRECATED: добавление получателя в конверт (не рекомендуется) [DEPRECATED] |
Добавьте получателя в конверт (не рекомендуется). |
| DEPRECATED: получение документов из конверта (не рекомендуется) [DEPRECATED] |
Получение документов из конверта (не рекомендуется) |
| DEPRECATED: создание конверта с помощью шаблона (не рекомендуется) [DEPRECATED] |
Создайте новый конверт с помощью указанного шаблона (не рекомендуется). |
| Вход |
Вход |
| Вывод списка документов из конверта |
Вывод списка документов из конверта |
| Вывод списка документов из шаблона |
Вывод списка документов из шаблона |
| Вывод списка конвертов |
Это действие возвращает соответствующие конверты Docusign на основе состояния конверта, диапазона дат, имени получателя, адреса электронной почты получателя, названия конверта, имени документа или значения настраиваемого поля конверта. Выходные данные — это название, описание, идентификатор конверта, имена документов, имена отправителей, состояние конверта, дата отправки и URL-адрес конверта, который можно использовать в качестве ссылки для просмотра конверта в Docusign. |
| Вывод списка получателей из конверта |
Вывод списка получателей из конверта |
| Добавление вкладок для получателя в конверте |
Добавление вкладок для получателя в конверте |
| Добавление документов в конверт |
Добавьте документы в конверт. |
| Добавление напоминаний для конверта |
Добавление напоминаний для конверта |
| Добавление получателя в конверт (версия 2) |
Добавьте получателя в конверт. |
| Добавление типа проверки в получатель |
Добавьте тип проверки в получатель. |
| Запуск рабочего процесса Docusign |
Запуск рабочего процесса Docusign |
| Массовая отправка конверта с помощью шаблона |
Массовая отправка конверта с помощью шаблона |
| Обновление вкладок перед заполнением конверта |
Обновление значений для списка вкладок предварительной заполнения |
| Обновление значений вкладок получателя в конверте |
Обновление значений вкладок получателя в конверте |
| Обновление настраиваемого поля конверта |
Обновление значения для указанного настраиваемого поля конверта |
| Обновление полей формы создания документов из конверта |
Обновление полей формы создания документов из конверта |
| Обновление получателя в конверте |
Обновление получателя в конверте |
| Отправка конверта |
Отправьте существующий конверт. |
| Повторно отправить конверт |
Это действие перенаправляет конверт Docusign или отправляет напоминание получателям, которым необходимо подписать соглашение Docusign на основе предоставленного конверта. |
| Показать номер сборки (только для ссылки. Не включать в поток для выполнения) |
Идентификатор развернутой в настоящее время сборки. |
| Получение вкладок документов из конверта |
Получение вкладок документов из конверта |
| Получение вкладок документов из шаблона |
Получение вкладок документов из шаблона |
| Получение вкладок получателей из конверта |
Получение вкладок получателей из конверта |
| Получение документов из конверта |
Получение документов из конверта |
| Получение настраиваемых полей документа из конверта |
Получение настраиваемых полей документа из конверта |
| Получение полей формы создания документов из конверта |
Получение полей формы создания документов из конверта |
| Получение полей формы создания документов из шаблона (только для массового отправки шаблонов) |
Получение полей формы создания документов из шаблона (только для массового отправки шаблонов) |
| Получение сведений на вкладке "Получатель" |
Возвращает значение вкладки для данного получателя |
| Получение сведений о документе из конверта |
Получение сведений о документе из конверта |
| Получение сведений о настраиваемом поле конверта |
Получение сведений о настраиваемом поле конверта. |
| Получение сведений о получателе из конверта |
Получение сведений о получателе из конверта |
| Получение списка событий аудита |
Получение списка событий аудита |
| Применение шаблона к документам |
Применение шаблона к документам |
| Пустота конверта |
Пустоте конверт. |
| Создание URL-адреса внедренного отправителя |
Создание URL-адреса внедренного отправителя |
| Создание URL-адреса внедренной подписи (версия 2) |
Создание URL-адреса внедренной подписи (версия 2) |
| Создание URL-адреса внедренной подписи [НЕ РЕКОМЕНДУЕТСЯ] |
Создание внедренного URL-адреса подписывания |
| Создание конверта (версия 2) |
Создайте пустой конверт. |
| Создание конверта с помощью составных шаблонов |
Создание конверта с помощью составных шаблонов |
| Создание конверта с помощью шаблона |
Создайте новый конверт с помощью указанного шаблона. |
| Создание конверта с помощью шаблона с получателями |
Создайте новый конверт с помощью указанного шаблона и укажите получателей. |
| Создание конверта с помощью шаблона с получателями и вкладками |
Создание конверта с помощью шаблона с получателями и вкладками |
| Создание списка массовой отправки |
Создание списка массовой отправки |
| Удаление получателя из конверта |
Удаление получателя из конверта |
| Шаблоны списка |
Список шаблонов для определенной учетной записи. |
DEPRECATED: добавление получателя в конверт (не рекомендуется) [DEPRECATED]
Добавьте получателя в конверт (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Счет
|
accountId | True | string |
Идентификатор учетной записи |
|
Конверт
|
envelopeId | True | string |
Идентификатор конверта |
|
Имя подписи
|
AddRecipientToEnvelopeName | True | string |
Имя получателя. |
|
Электронная почта подписывющего средства
|
AddRecipientToEnvelopeEmail | True | string |
Сообщение электронной почты получателя. |
|
Порядок подписывания
|
routingOrder | string |
Порядок подписывания получателя в документе. |
|
|
Role
|
roleName | string |
Роль подписывчика. |
Возвращаемое значение
DEPRECATED: получение документов из конверта (не рекомендуется) [DEPRECATED]
Получение документов из конверта (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Счет
|
accountId | True | string |
Идентификатор учетной записи |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Сертификат завершения
|
certificate | True | boolean |
Если задано значение false, сертификат подписи конверта удаляется из скачивания. |
Возвращаемое значение
- response
- GetDocumentsResponse
DEPRECATED: создание конверта с помощью шаблона (не рекомендуется) [DEPRECATED]
Создайте новый конверт с помощью указанного шаблона (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
ИД шаблона
|
templateId | True | string |
Введите или выберите идентификатор шаблона. |
|
Состояние конверта
|
status | True | string |
Состояние конверта |
|
Настраиваемые поля
|
accountCustomFields | True | dynamic |
Получите настраиваемые поля на уровне учетной записи. |
Возвращаемое значение
Вход
Вывод списка документов из конверта
Вывод списка документов из конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
Возвращаемое значение
Вывод списка документов из шаблона
Вывод списка документов из шаблона
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
ИД шаблона
|
templateId | True | string |
Введите или выберите идентификатор шаблона. |
Возвращаемое значение
Вывод списка конвертов
Это действие возвращает соответствующие конверты Docusign на основе состояния конверта, диапазона дат, имени получателя, адреса электронной почты получателя, названия конверта, имени документа или значения настраиваемого поля конверта. Выходные данные — это название, описание, идентификатор конверта, имена документов, имена отправителей, состояние конверта, дата отправки и URL-адрес конверта, который можно использовать в качестве ссылки для просмотра конверта в Docusign.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Имя получателя
|
recipientName | string |
В этом действии перечислены конверты на основе имени получателя |
|
|
Электронная почта получателя
|
recipientEmailId | string |
Фильтрует конверты по электронной почте получателя |
|
|
Тема конверта
|
envelopeTitle | string |
Фильтрует конверты по теме конверта |
|
|
Имя настраиваемого поля
|
customFieldName | string |
В этом действии перечислены конверты на основе имени настраиваемых полей. |
|
|
Значение настраиваемого поля
|
customFieldValue | string |
Фильтры по значению настраиваемого поля |
|
|
Поиск слова
|
search_text | string |
Введите одно ключевое слово, чтобы найти совпадения в темах конверта, получателях и настраиваемых полях. |
|
|
Состояние конверта
|
envelopeStatus | string |
Это действие перечисляет конверты на основе состояния конверта |
|
|
Folder
|
folder_ids | string |
Фильтрует конверты по выбранной папке |
|
|
Заказ по
|
order_by | string |
Сортировка конвертов в выбранном порядке |
|
|
Возврат конвертов
|
top | integer |
Укажите количество возвращаемых конвертов (по умолчанию — 10; максимальное значение — 1000). |
|
|
Пропуск конвертов
|
skip | integer |
Укажите количество конвертов, которые нужно пропустить с начала |
|
|
Начальная дата
|
from_date | date-time |
Введите дату начала в формате UTC: 2017-05-02T01:44z |
|
|
Дата окончания
|
to_date | date-time |
Введите дату окончания в формате UTC: 2017-05-02T01:44z. |
Возвращаемое значение
Вывод списка получателей из конверта
Вывод списка получателей из конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
Возвращаемое значение
Добавление вкладок для получателя в конверте
Добавление вкладок для получателя в конверте
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Идентификатор получателя
|
recipientId | True | string |
Введите идентификатор получателя. |
|
Тип табуляции
|
tabType | True | string |
Тип табуляции |
|
сведения о вкладке
|
tabDetails | True | dynamic |
Сведения о выбранной вкладке привязки. |
Возвращаемое значение
Добавление документов в конверт
Добавьте документы в конверт.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Документ Base64 *
|
documentBase64 | True | string |
Base64 содержимого документа |
|
Тип документа *
|
fileExtension | True | string |
pdf, docx и т. д. |
|
Имя документа *
|
name | True | string |
Имя документа |
|
Преобразование полей PDF
|
transformPdfFields | string |
Неправда |
|
|
Назначение вкладок получателю
|
assignTabsToRecipientId | string |
Идентификатор получателя |
Возвращаемое значение
- Тело
- AddDocumentsResponse
Добавление напоминаний для конверта
Добавление напоминаний для конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Напоминание включено
|
reminderEnabled | True | boolean |
Если задано значение false, напоминания отключены. Значение по умолчанию — false. |
|
Задержка напоминания
|
reminderDelay | True | string |
Добавьте количество дней, после которого получатель получает сообщение электронной почты с напоминанием. |
|
Частота напоминаний
|
reminderFrequency | True | string |
Добавьте количество дней между письмами напоминания. |
|
Срок действия после окончания срока действия
|
expireAfter | string |
Добавьте количество дней до истечения срока действия. |
Возвращаемое значение
- Тело
- AddRemindersResponse
Добавление получателя в конверт (версия 2)
Добавьте получателя в конверт.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Тип получателя
|
recipientType | True | string |
Введите или выберите тип получателя. |
|
Идентификатор пользователя клиента
|
clientUserId | string |
Идентификатор пользователя клиента для встроенного входа |
|
|
Идентификатор получателя
|
recipientId | string |
Введите идентификатор получателя. |
|
|
URL-адрес запуска внедренного получателя
|
embeddedRecipientStartURL | string |
Строка URL-адреса, предоставляемая отправителем для перенаправления внедренного получателя. |
|
|
Порядок подписывания
|
routingOrder | string |
Порядок подписывания получателя. |
|
|
Язык уведомлений по электронной почте
|
emailNotificationLanguage | string |
Язык для уведомления электронной почты. |
|
|
Тема уведомления по электронной почте
|
emailNotificationSubject | string |
Тема уведомления по электронной почте. |
|
|
Текст уведомления по электронной почте
|
emailNotificationBody | string |
Текст уведомления по электронной почте. |
|
|
Замечание
|
note | string |
Настраиваемая заметка для получателя. |
|
|
Имя роли
|
roleName | string |
Имя роли, связанное с получателем. |
|
|
Код страны SMS
|
countryCode | string |
Для SMS-уведомлений код страны без знака +. |
|
|
SMS-номер телефона
|
phoneNumber | string |
Требуется сообщение электронной почты или SMS-телефон подписывающего устройства. Исключите код страны для номера телефона. |
|
|
Группа подписывания
|
signingGroupId | string |
Группа подписывания |
|
|
Тип подписи
|
signatureType | string |
Типы подписи на основе стандартов DocuSign (SBS). |
|
|
Рабочий процесс проверки
|
workflowId | string |
Рабочие процессы IDV с типами подписей пера должны быть выбраны здесь. |
|
|
сведения о выбранном типе получателя
|
additionalRecipientParams | dynamic |
Сведения о выбранном типе получателя. |
Возвращаемое значение
- Тело
- Signer
Добавление типа проверки в получатель
Добавьте тип проверки в получатель.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Идентификатор получателя
|
recipientId | True | string |
Введите идентификатор получателя. |
|
Тип получателя
|
recipientType | True | string |
Введите или выберите тип получателя. |
|
Тип проверки
|
verificationType | True | string |
Тип проверки |
|
Дополнительные данные получателя
|
additionalRecipientData | dynamic |
Дополнительные данные получателя. |
Запуск рабочего процесса Docusign
Запуск рабочего процесса Docusign
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
workflow
|
workflowId | True | string |
Введите идентификатор рабочего процесса или выберите имя рабочего процесса в раскрывающемся списке |
|
Имя экземпляра
|
instanceName | True | string |
Имя экземпляра рабочего процесса |
|
variable
|
variable | dynamic |
Возвращаемое значение
TriggerMaestroFlowResponse
- response
- object
Массовая отправка конверта с помощью шаблона
Массовая отправка конверта с помощью шаблона
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
GUID списка массовой отправки
|
bulkSendListId | True | string |
GUID списка массовой отправки |
|
ИД шаблона
|
envelopeOrTemplateId | True | string |
Введите идентификатор шаблона или выберите шаблон из раскрывающегося списка |
Возвращаемое значение
- Тело
- BulkSendListGuid
Обновление вкладок перед заполнением конверта
Обновление значений для списка вкладок предварительной заполнения
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Идентификатор документа
|
documentId | True | string |
Введите идентификатор документа. |
|
Тип
|
tabType | string |
Тип |
|
|
Идентификатор
|
tabId | string |
Идентификатор |
|
|
Ценность
|
value | string |
Ценность |
Обновление значений вкладок получателя в конверте
Обновление значений вкладок получателя в конверте
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Идентификатор получателя
|
recipientId | True | string |
Введите идентификатор получателя. |
|
Тип
|
tabType | string |
Тип табуляции |
|
|
Идентификатор
|
tabId | string |
Идентификатор |
|
|
Ценность
|
value | string |
Ценность |
Обновление настраиваемого поля конверта
Обновление значения для указанного настраиваемого поля конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
ИД поля
|
fieldId | True | string |
Идентификатор настраиваемого поля |
|
Тип поля
|
fieldType | True | string |
Настраиваемый тип поля |
|
Имя
|
name | True | string |
Имя настраиваемого поля |
|
Ценность
|
value | True | string |
Значение настраиваемого поля |
Возвращаемое значение
Обновление полей формы создания документов из конверта
Обновление полей формы создания документов из конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
GUID документа
|
documentGuid | True | string |
GUID документа |
|
Тип
|
fieldType | string |
Выберите тип поля создания документов для обновления |
|
|
Имя
|
name | string |
Введите имя поля или имя столбца таблицы |
|
|
Ценность
|
value | string |
Введите данные поля |
|
|
Этикетка
|
label | string |
Требуется для строки таблицы. Введите метку поля docgen. |
|
|
: имя таблицы
|
tableName | string |
Требуется для строки таблицы. Введите имя таблицы. |
|
|
:Строка таблицы
|
rowNumber | string |
Требуется для строки таблицы. Введите номер строки |
Обновление получателя в конверте
Обновление получателя в конверте
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Идентификатор получателя
|
recipientId | True | string |
Введите идентификатор получателя. |
|
Тип подписи
|
signatureType | string |
Типы подписи на основе стандартов DocuSign (SBS). |
|
|
Тип получателя
|
recipientType | True | string |
Тип получателя |
|
Идентификатор пользователя клиента
|
clientUserId | string |
Идентификатор пользователя клиента для встроенного входа |
|
|
URL-адрес запуска внедренного получателя
|
embeddedRecipientStartURL | string |
Строка URL-адреса, предоставляемая отправителем для перенаправления внедренного получателя. |
|
|
Порядок подписывания
|
routingOrder | string |
Порядок подписывания получателя. |
|
|
Язык уведомлений по электронной почте
|
emailNotificationLanguage | string |
Язык для уведомления электронной почты. |
|
|
Тема уведомления по электронной почте
|
emailNotificationSubject | string |
Тема уведомления по электронной почте. |
|
|
Текст уведомления по электронной почте
|
emailNotificationBody | string |
Текст уведомления по электронной почте. |
|
|
Замечание
|
note | string |
Настраиваемая заметка для получателя. |
|
|
Имя роли
|
roleName | string |
Имя роли, связанное с получателем. |
|
|
Код страны SMS
|
countryCode | string |
Для SMS-уведомлений код страны без знака +. |
|
|
SMS-номер телефона
|
phoneNumber | string |
Требуется сообщение электронной почты или SMS-телефон подписывающего устройства. Исключите код страны для номера телефона. |
|
|
Группа подписывания
|
signingGroupId | string |
Группа подписывания |
|
|
сведения о выбранном типе получателя
|
additionalRecipientParams | dynamic |
Сведения о выбранном типе получателя. |
Возвращаемое значение
- Тело
- Signer
Отправка конверта
Отправьте существующий конверт.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
Возвращаемое значение
- response
- object
Повторно отправить конверт
Это действие перенаправляет конверт Docusign или отправляет напоминание получателям, которым необходимо подписать соглашение Docusign на основе предоставленного конверта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
Возвращаемое значение
- response
- object
Показать номер сборки (только для ссылки. Не включать в поток для выполнения)
Идентификатор развернутой в настоящее время сборки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер сборки
|
buildNumber | dynamic |
Возвращаемое значение
- response
- object
Получение вкладок документов из конверта
Получение вкладок документов из конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Идентификатор документа
|
documentId | True | string |
Введите идентификатор документа. |
Возвращаемое значение
- Тело
- ListTabsResponse
Получение вкладок документов из шаблона
Получение вкладок документов из шаблона
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
ИД шаблона
|
templateId | True | string |
Введите или выберите идентификатор шаблона. |
|
Идентификатор документа
|
documentId | True | string |
Введите идентификатор документа. |
Возвращаемое значение
- Тело
- ListTabsResponse
Получение вкладок получателей из конверта
Получение вкладок получателей из конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Идентификатор получателя
|
recipientId | True | string |
Введите идентификатор получателя. |
Возвращаемое значение
Получение документов из конверта
Получение документов из конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Формат вывода
|
documentId | True | string |
Введите string(document ID), чтобы получить один документ или выбрать формат. |
|
Язык завершения сертификата (необязательно)
|
language | string |
Выбрать язык |
Возвращаемое значение
- response
- GetDocumentsResponse
Получение настраиваемых полей документа из конверта
Получение настраиваемых полей документа из конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Идентификатор документа
|
documentId | True | string |
Введите идентификатор документа. |
Возвращаемое значение
Получение полей формы создания документов из конверта
Получение полей формы создания документов из конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
Возвращаемое значение
Получение полей формы создания документов из шаблона (только для массового отправки шаблонов)
Получение полей формы создания документов из шаблона (только для массового отправки шаблонов)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
ИД шаблона
|
templateId | True | string |
Введите или выберите идентификатор шаблона. |
Возвращаемое значение
Поля формы создания документов из шаблона
- Поля шаблона DocGen
- object
Получение сведений на вкладке "Получатель"
Возвращает значение вкладки для данного получателя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Идентификатор получателя
|
recipientId | True | string |
Введите идентификатор получателя. |
|
Метка табуляции
|
tabLabel | True | string |
Метка табуляции |
Возвращаемое значение
- Тело
- Tab
Получение сведений о документе из конверта
Получение сведений о документе из конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Имя документа
|
documentName | True | string |
Имя файла с расширением |
Возвращаемое значение
- Тело
- EnvelopeDocument
Получение сведений о настраиваемом поле конверта
Получение сведений о настраиваемом поле конверта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Имя настраиваемого поля
|
fieldName | True | string |
Имя настраиваемого поля |
Возвращаемое значение
Получение сведений о получателе из конверта
Получение сведений о получателе из конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Электронная почта получателя
|
recipientEmail | string |
Электронная почта получателя |
|
|
Код области
|
areaCode | string |
Код области получателя |
|
|
Номер телефона
|
phoneNumber | string |
Номер телефона получателя |
|
|
Идентификатор получателя
|
recipientId | string |
Введите идентификатор получателя. |
Возвращаемое значение
- Тело
- Signer
Получение списка событий аудита
Получение списка событий аудита
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
Возвращаемое значение
- response
- object
Применение шаблона к документам
Применение шаблона к документам
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
ИД шаблона
|
templateId | True | string |
Введите или выберите идентификатор шаблона. |
|
Сохранение получателя шаблона
|
preserve_template_recipient | string |
Неправда |
|
|
Идентификатор документа
|
documentId | True | string |
Идентификатор документа |
|
Начальная страница документа
|
documentStartPage | True | string |
Начальная страница документа |
|
Конечная страница документа
|
documentEndPage | True | string |
Конечная страница документа |
Пустота конверта
Пустоте конверт.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Причина void
|
voidedReason | True | string |
Непустимая причина |
Возвращаемое значение
- response
- object
Создание URL-адреса внедренного отправителя
Создание URL-адреса внедренного отправителя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Открыть в
|
openIn | True | string |
Открыть в |
|
URL-адрес возврата
|
returnUrl | True | string |
URL-адрес возврата |
|
Дополнительный добавленный URL-адрес
|
additionalURL | dynamic |
Дополнительный добавленный URL-адрес. |
Возвращаемое значение
Создание URL-адреса внедренной подписи (версия 2)
Создание URL-адреса внедренной подписи (версия 2)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Это пользователь, который входит в систему?
|
isInPersonSigner | True | string |
Да/нет |
|
Метод проверки подлинности
|
authenticationMethod | True | string |
Метод проверки подлинности |
|
URL-адрес возврата
|
returnUrl | True | string |
URL-адрес возврата |
|
Дополнительный добавленный URL-адрес
|
additionalURL | True | dynamic |
Дополнительный добавленный URL-адрес. |
Возвращаемое значение
Создание URL-адреса внедренной подписи [НЕ РЕКОМЕНДУЕТСЯ]
Создание внедренного URL-адреса подписывания
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Имя подписи
|
signerName | True | string |
Имя подписи |
|
Электронная почта подписывющего средства
|
signerEmail | True | string |
Электронная почта подписывющего средства |
|
Идентификатор пользователя клиента
|
clientUserId | string |
Требуется, если пользователь не входит в систему. Оставьте пустым для пользователей подписывющих лиц |
|
|
Метод проверки подлинности
|
authenticationMethod | True | string |
Метод проверки подлинности |
|
URL-адрес возврата
|
returnUrl | True | string |
URL-адрес возврата |
|
Дополнительный добавленный URL-адрес
|
additionalURL | dynamic |
Дополнительный добавленный URL-адрес. |
Возвращаемое значение
Создание конверта (версия 2)
Создайте пустой конверт.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Тема сообщения электронной почты
|
emailSubject | True | string |
Тема сообщения электронной почты. |
|
body
|
body | dynamic |
Текст электронной почты и настраиваемые поля учетной записи. |
Возвращаемое значение
Создание конверта с помощью составных шаблонов
Создание конверта с помощью составных шаблонов
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Тема сообщения электронной почты
|
emailSubject | True | string |
Тема сообщения электронной почты. |
|
Тело сообщения электронной почты
|
emailBody | string |
Текст сообщения электронной почты. |
|
|
Состояние конверта
|
status | True | string |
Состояние конверта |
|
Слияние ролей и удаление пустых получателей
|
merge_roles_on_draft | string |
Слияние ролей и удаление пустых получателей |
|
|
body
|
body | dynamic |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор конверта
|
envelopeId | string |
Идентификатор конверта. |
|
Состояние
|
status | string |
Состояние конверта. |
|
Время даты состояния
|
statusDateTime | string |
Дата и время установки состояния. |
|
URI
|
uri | string |
Универсальный код ресурса (URI) для конверта в DocuSign. |
Создание конверта с помощью шаблона
Создайте новый конверт с помощью указанного шаблона.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
ИД шаблона
|
templateId | True | string |
Введите или выберите идентификатор шаблона. |
|
Состояние конверта
|
status | True | string |
Состояние конверта |
Возвращаемое значение
Создание конверта с помощью шаблона с получателями
Создайте новый конверт с помощью указанного шаблона и укажите получателей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Состояние конверта
|
status | True | string |
Состояние конверта |
|
ИД шаблона
|
templateId | True | string |
Введите или выберите идентификатор шаблона. |
|
Подписыватели
|
signers | dynamic |
Подписыватели документа. |
|
|
Тема сообщения электронной почты
|
emailSubject | string |
Тема сообщения электронной почты |
|
|
Тело сообщения электронной почты
|
emailBody | string |
Тело сообщения электронной почты |
Возвращаемое значение
Создание конверта с помощью шаблона с получателями и вкладками
Создание конверта с помощью шаблона с получателями и вкладками
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
ИД шаблона
|
templateId | True | string |
Введите или выберите идентификатор шаблона. |
|
Получатели
|
recipients | dynamic |
Подписыватели документа. |
|
|
Слияние ролей и удаление пустых получателей
|
merge_roles_on_draft | string |
Слияние ролей и удаление пустых получателей |
|
|
Тема сообщения электронной почты
|
emailSubject | string |
Тема сообщения электронной почты |
Возвращаемое значение
Создание списка массовой отправки
Создание списка массовой отправки
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Имя списка массового отправки
|
name | True | string |
Имя списка массового отправки |
|
CSV-файл
|
csv | string |
Отправка CSV-файла |
|
|
Поля создания документов
|
rawOutput | object |
Поля создания документов |
Возвращаемое значение
- Тело
- BulkSendListGuid
Удаление получателя из конверта
Удаление получателя из конверта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
|
Folder
|
folderId | True | string |
Идентификатор папки |
|
Идентификатор конверта
|
envelopeId | True | string |
Введите идентификатор конверта. |
|
Идентификатор получателя
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
Идентификатор получателя |
Возвращаемое значение
Шаблоны списка
Список шаблонов для определенной учетной записи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите или выберите идентификатор учетной записи. |
Возвращаемое значение
Триггеры
| DEPRECATED: при изменении состояния конверта (Connect) (V2) (не рекомендуется) [DEPRECATED] |
Активирует новый поток при изменении состояния конверта (не рекомендуется). |
| DEPRECATED: при изменении состояния конверта (Подключение) (не рекомендуется) [DEPRECATED] |
Активирует новый поток при изменении состояния конверта (не рекомендуется). |
| При возникновении события Docusign Connect (уровень организации) |
Активирует новый поток при изменении состояния конверта. |
| При возникновении события Docusign Connect (уровень учетной записи) |
Активирует новый поток при изменении состояния конверта. |
DEPRECATED: при изменении состояния конверта (Connect) (V2) (не рекомендуется) [DEPRECATED]
Активирует новый поток при изменении состояния конверта (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Счет
|
accountId | True | string |
Идентификатор учетной записи |
|
Имя подключения
|
name | True | string | |
|
Событие конверта
|
envelopeEvents | True | string |
Возвращаемое значение
DEPRECATED: при изменении состояния конверта (Подключение) (не рекомендуется) [DEPRECATED]
Активирует новый поток при изменении состояния конверта (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Счет
|
accountId | True | string |
Идентификатор учетной записи |
|
Имя подключения
|
name | True | string | |
|
Событие конверта
|
envelopeEvents | True | string |
Возвращаемое значение
При возникновении события Docusign Connect (уровень организации)
Активирует новый поток при изменении состояния конверта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
organizationId | True | string |
Введите или выберите идентификатор организации. |
|
Имя конфигурации подключения
|
name | True | string |
Присвойте конфигурации Connect (например, "События конверта"). |
|
События триггера
|
events | True | array of string |
Выберите событие. Чтобы включить другое событие, нажмите кнопку "Добавить новый элемент". |
Возвращаемое значение
При возникновении события Docusign Connect (уровень учетной записи)
Активирует новый поток при изменении состояния конверта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ID счета
|
accountId | True | string |
Введите идентификатор учетной записи или выберите учетную запись в раскрывающемся списке. |
|
Имя конфигурации подключения
|
name | True | string |
Присвойте конфигурации Connect (например, "События конверта"). |
|
События триггера
|
events | True | array of string |
Выберите событие. Чтобы включить другое событие, нажмите кнопку "Добавить новый элемент". |
Возвращаемое значение
Определения
WebhookEnvelopeResponseV2
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Настраиваемые поля конверта
|
data.envelopeSummary.customFields | object |
Пары "ключ-значение", представляющие настраиваемые поля для этого конверта (где ключ — имя поля, а значение — значение поля). |
|
Созданный конверт Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Идентификатор конверта
|
data.envelopeSummary.envelopeId | string | |
|
Конверт отправлен Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Состояние конверта
|
data.envelopeSummary.status | string | |
|
Тема электронной почты
|
data.envelopeSummary.emailSubject | string | |
|
конвертDocuments
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
Идентификатор документа
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Guid документа
|
data.envelopeSummary.envelopeDocuments.documentGuid | string | |
|
Имя документа
|
data.envelopeSummary.envelopeDocuments.documentName | string | |
|
Имя отправителя
|
data.envelopeSummary.sender.userName | string | |
|
Идентификатор пользователя отправителя
|
data.envelopeSummary.sender.userId | string | |
|
Идентификатор учетной записи отправителя
|
data.envelopeSummary.sender.accountId | string | |
|
Адрес электронной почты отправителя
|
data.envelopeSummary.sender.email | string | |
|
подписыватели
|
data.envelopeSummary.recipients.signers | array of object | |
|
Вкладки
|
data.envelopeSummary.recipients.signers.tabs | object |
Пары "ключ-значение", представляющие вкладки для этого получателя (где ключ — имя поля, а значение — значение поля). |
|
Электронная почта получателя
|
data.envelopeSummary.recipients.signers.email | string | |
|
Идентификатор получателя
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Порядок маршрутизации
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Отправленный получатель Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Состояние получателя
|
data.envelopeSummary.recipients.signers.status | string |
Состояние получателя. |
|
Тип получателя
|
data.envelopeSummary.recipients.signers.recipientType | string |
Тип получателя. |
|
Тип проверки
|
data.envelopeSummary.recipients.signers.verificationType | string |
Тип проверки. |
|
Имя получателя
|
data.envelopeSummary.recipients.signers.name | string |
Имя получателя. |
WebhookOrganizationResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор организации
|
data.organizationId | string |
Идентификатор организации. |
|
Настраиваемые поля конверта
|
data.envelopeSummary.customFields | object |
Пары "ключ-значение", представляющие настраиваемые поля для этого конверта (где ключ — имя поля, а значение — значение поля). |
|
Созданный конверт Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Идентификатор конверта
|
data.envelopeSummary.envelopeId | string | |
|
Конверт отправлен Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Состояние конверта
|
data.envelopeSummary.status | string | |
|
Тема электронной почты
|
data.envelopeSummary.emailSubject | string | |
|
конвертDocuments
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
Идентификатор документа
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Guid документа
|
data.envelopeSummary.envelopeDocuments.documentGuid | string | |
|
Имя документа
|
data.envelopeSummary.envelopeDocuments.documentName | string | |
|
Имя отправителя
|
data.envelopeSummary.sender.userName | string | |
|
Идентификатор пользователя отправителя
|
data.envelopeSummary.sender.userId | string | |
|
Идентификатор учетной записи отправителя
|
data.envelopeSummary.sender.accountId | string | |
|
Адрес электронной почты отправителя
|
data.envelopeSummary.sender.email | string | |
|
подписыватели
|
data.envelopeSummary.recipients.signers | array of object | |
|
Вкладки
|
data.envelopeSummary.recipients.signers.tabs | object |
Пары "ключ-значение", представляющие вкладки для этого получателя (где ключ — имя поля, а значение — значение поля). |
|
Электронная почта получателя
|
data.envelopeSummary.recipients.signers.email | string | |
|
Идентификатор получателя
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Порядок маршрутизации
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Отправленный получатель Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Состояние получателя
|
data.envelopeSummary.recipients.signers.status | string |
Состояние получателя. |
|
Тип получателя
|
data.envelopeSummary.recipients.signers.recipientType | string |
Тип получателя. |
|
Тип проверки
|
data.envelopeSummary.recipients.signers.verificationType | string |
Тип проверки. |
|
Имя получателя
|
data.envelopeSummary.recipients.signers.name | string |
Имя получателя. |
WebhookEnvelopeResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Настраиваемые поля конверта
|
customFields | object |
Пары "ключ-значение", представляющие настраиваемые поля для этого конверта (где ключ — имя поля, а значение — значение поля). |
|
Созданный конверт Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Адрес электронной почты отправителя
|
DocuSignEnvelopeInformation.EnvelopeStatus.Email | string | |
|
Идентификатор конверта
|
DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID | string | |
|
IP-адрес отправителя
|
DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress | string | |
|
Конверт отправлен Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Sent | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Состояние конверта
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
Тема
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
Имя отправителя
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
RecipientStatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
Вкладки
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
Пары "ключ-значение", представляющие вкладки для этого получателя (где ключ — имя поля, а значение — значение поля). |
|
Причина отклонения
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
Электронная почта получателя
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email | string | |
|
Идентификатор получателя
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId | string | |
|
Порядок маршрутизации
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder | string | |
|
Отправленный получатель Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent | date-time |
гггг-ММ-ддTHH:мм:ss.fffZ |
|
Состояние получателя
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
Состояние получателя. |
|
Тип получателя
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type | string |
Тип получателя. |
|
Имя получателя
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName | string |
Имя получателя. |
|
Часовой пояс
|
DocuSignEnvelopeInformation.TimeZone | string | |
|
Смещение часового пояса
|
DocuSignEnvelopeInformation.TimeZoneOffset | string |
GetDocumentsResponse
- Содержимое файла
- binary
AddRemindersResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Включено напоминание
|
reminderEnabled | string |
Включено напоминание |
FilteredEnvelopes
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Название
|
title | string |
Название конверта |
|
Description
|
description | string |
Описание действия конверта |
|
Идентификатор конверта
|
envelopeId | string |
Идентификатор конверта |
|
Documents
|
documents | string |
Список имен документов |
|
Имена получателей
|
recipients | string |
Список имен получателей |
|
Имя отправителя
|
sender | string |
Имя отправителя |
|
Состояние
|
status | string |
Состояние конверта |
|
Дата состояния
|
statusDate | string |
Последнее обновление состояния действия |
|
Дата отправки
|
dateSent | date-time |
Дата отправки конверта |
|
URL
|
url | string |
URL-адрес конверта |
EmbeddedSenderResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Внедренный URL-адрес отправителя
|
url | string |
URL-адрес внедренного представления отправителя. |
EmbeddedSigningResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL
|
url | string |
URL-адрес внедренного представления подписывания. |
FilteredEnvelopeListResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отфильтрованные конверты
|
value | array of FilteredEnvelopes |
Отфильтрованные конверты |
|
Дополнительные результаты конверта
|
hasMoreResults | boolean |
Показывает, превышает ли конверты указанное число в поле "Возвращаемые конверты" |
CreateEnvelopeResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор конверта
|
envelopeId | string |
Идентификатор конверта. |
|
Идентификатор шаблона
|
templateId | string |
Идентификатор шаблона. |
|
Состояние
|
status | string |
Состояние конверта. |
|
Время даты состояния
|
statusDateTime | string |
Дата и время установки состояния. |
|
URI
|
uri | string |
Универсальный код ресурса (URI) для конверта в DocuSign. |
ListRecipientsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор конверта
|
envelopeId | string | |
|
Подписыватели
|
signers | array of Signer |
Подписыватели |
вкладка
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя вкладки
|
name | string |
Имя вкладки. |
|
Тип вкладки
|
tabType | string |
Тип вкладки. |
|
Подпись вкладки
|
tabLabel | string |
Метка вкладки. |
|
Значение вкладки
|
value | string |
Значение вкладки. |
|
ИД вкладки
|
tabId | string |
Идентификатор вкладки. |
|
Идентификатор документа
|
documentId | string |
Идентификатор документа. |
|
Идентификатор получателя
|
recipientId | string |
Идентификатор получателя. |
|
Предварительная заполнение
|
prefill | boolean |
Указывает, является ли вкладка типом предварительной заполнения. |
|
Выбрано
|
selected | string |
Если вкладки установлен, указывает, выбрана ли вкладка. |
RecipientTabsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Вкладка "Получатель":
|
recipientTabs | array of Tab |
Вкладка "Получатель" |
Подписавшее лицо
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Порядок подписывания
|
routingOrder | string |
Порядок подписывания получателя в документе. |
|
Role
|
roleName | string |
Роль подписывчика. |
|
Идентификатор получателя
|
recipientId | string |
Идентификатор получателя. |
|
Имя
|
name | string |
Имя получателя. |
|
Адрес электронной почты
|
string |
Сообщение электронной почты получателя. |
|
|
Тип получателя
|
recipientType | string |
Тип получателя. |
|
Тип проверки
|
verificationType | string |
Тип проверки. |
|
GUID получателя
|
recipientIdGuid | string |
GUID получателя. |
GetLoginAccountsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Учетные записи входа
|
loginAccounts | array of LoginAccount |
Учетные записи входа |
LoginAccount
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
name | string |
Имя учетной записи. |
|
Guid идентификатора учетной записи
|
accountIdGuid | string |
GUID учетной записи. |
ListTabsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Вкладки
|
tabs | array of Tab |
Вкладки |
ListEnvelopeDocumentFieldsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Настраиваемое поле
|
envelopeDocumentFields | array of EnvelopeDocumentField |
Настраиваемые поля документа |
DocGenFormFieldsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Поля Docgen
|
docgenFields | array of DocGenFormField |
Поля Docgen |
DocGenFormField
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор документа
|
documentId | string |
Идентификатор документа. |
|
Этикетка
|
label | string |
Ярлык. |
|
Тип
|
type | string |
Тип. |
|
Имя
|
name | string |
Имя. |
|
Ценность
|
value | string |
Ценность. |
ListTemplatesResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Шаблоны конвертов
|
envelopeTemplates | array of EnvelopeTemplate |
Доступные шаблоны конвертов. |
КонвертTemplate
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор шаблона
|
templateId | string |
Идентификатор шаблона. |
|
Имя
|
name | string |
Имя шаблона. |
BulkSendListGuid
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Guid списка массовой отправки
|
listId | string |
Guid списка массовой отправки |
КонвертCustomFieldResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ИД поля
|
fieldId | string |
Идентификатор настраиваемого поля конверта. |
|
Тип поля
|
fieldType | string |
Тип настраиваемого поля конверта. |
|
Имя
|
name | string |
Имя настраиваемого поля конверта. |
|
Ценность
|
value | string |
Значение настраиваемого поля конверта. |
UpdateEnvelopeCustomFieldResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ИД поля
|
fieldId | string |
Идентификатор настраиваемого поля конверта. |
|
Тип поля
|
fieldType | string |
Тип настраиваемого поля конверта. |
|
Имя
|
name | string |
Имя настраиваемого поля конверта. |
|
Ценность
|
value | string |
Значение настраиваемого поля конверта. |
ListDocumentsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Конверт документов
|
envelopeDocuments | array of EnvelopeDocument |
Документы, прикрепленные к конверту. |
ListTemplateDocumentsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Документы шаблона
|
templateDocuments | array of EnvelopeDocument |
Документы, присоединенные к шаблону. |
AddDocumentsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор конверта
|
envelopeId | string |
Идентификатор конверта. |
|
Конверт документов
|
envelopeDocuments | array of EnvelopeDocument |
Документы, прикрепленные к конверту. |
AddRecipientTabsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Вкладки получателей
|
recipientTabs | array of RecipientTab |
Вкладки, добавленные получателю. |
КонвертDocument
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
name | string |
Имя документа. |
|
Идентификатор документа
|
documentId | string |
Идентификатор документа. |
|
Guid документа
|
documentIdGuid | string |
Guid документа. |
RecipientTab
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ИД вкладки
|
tabId | string |
Идентификатор вкладки. |
|
Тип вкладки
|
tabType | string |
Тип вкладки. |
КонвертDocumentField
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
name | string |
Имя настраиваемого поля. |
|
Ценность
|
value | string |
Значение настраиваемого поля. |
DeclineReasonWithoutType
объект
Это тип «объект».