Docusign

Docusign позволяет организациям создавать, фиксировать и управлять ими в течение всего жизненного цикла соглашения. Клиенты могут ускорить доход, уменьшить риск и разблокировать ценность соглашений, которые выполняют свой бизнес.

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

Услуга	Class	Регионы
Copilot Studio	Стандарт	Все регионы Power Automate , кроме следующих:      — Облако Китая, управляемое 21Vianet
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Стандарт	Все регионы Power Apps , кроме следующих:      — Облако Китая, управляемое 21Vianet
Power Automate	Стандарт	Все регионы Power Automate , кроме следующих:      — Облако Китая, управляемое 21Vianet

Контакт
Имя	docusign
URL	https://support.docusign.com

Метаданные соединителя
Publisher	DocuSign, Inc.
Веб-сайт	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 секунд

Действия

Copilot для продаж: получение ключевых продаж	Это действие позволяет получить дополнительные аналитические сведения о продажах, которые будут отображаться в ключевой карточке с информацией о продажах C4S в боковой панели Outlook. Действие повышает существующие навыки copilot для продаж
Copilot для продаж: получение сводки по электронной почте	Это действие получает дополнительные аналитические сведения о продажах, которые будут отображаться в сводке по электронной почте C4S в сводке outlook. Действие улучшает существующие навыки помощника в области продаж.
Copilot для продаж: список конвертов	Copilot для продаж: конверты списка возвращают информацию о соглашениях Docusign, таких как название, документы, получатели, состояние соглашения, имя отправителя и URL-адрес соглашения. Подключаемый модуль может обрабатывать такие запросы, как показать мне все мои соглашения, которые мне нужно подписать или что такое состояние контракта заказа на продажу.
Copilot: Вывод списка конвертов	Это действие возвращает соответствующие конверты Docusign на основе состояния конверта, диапазона дат, имени получателя, адреса электронной почты получателя, названия конверта, имени документа или значения настраиваемого поля конверта. Выходные данные — это название, описание, идентификатор конверта, имена документов, имена отправителей, состояние конверта, дата отправки и URL-адрес конверта, который можно использовать в качестве ссылки для просмотра конверта в Docusign.
Copilot: получение связанных действий	Это действие получает дополнительные сведения о продажах, связанные с записью CRM, которые будут отображаться в сводной карточке записи C4S. Действие улучшает существующие навыки помощника в области продаж.
Copilot: Получение связанных записей	Это действие получает записи, связанные с записью CRM. Действие улучшает существующие навыки Copilot для продаж.
DEPRECATED: создание конверта с помощью шаблона с получателями	Создайте новый конверт с помощью указанного шаблона и укажите получателей.
Вход	Вход
Вывод списка документов из конверта	Вывод списка документов из конверта
Вывод списка документов из шаблона	Вывод списка документов из шаблона
Вывод списка конвертов	Это действие возвращает соответствующие конверты Docusign на основе состояния конверта, диапазона дат, имени получателя, адреса электронной почты получателя, названия конверта, имени документа или значения настраиваемого поля конверта. Выходные данные — это название, описание, идентификатор конверта, имена документов, имена отправителей, состояние конверта, дата отправки и URL-адрес конверта, который можно использовать в качестве ссылки для просмотра конверта в Docusign.
Вывод списка получателей из конверта	Вывод списка получателей из конверта
Добавление вкладок для получателя в конверте	Добавление вкладок для получателя в конверте
Добавление документов в конверт	Добавьте документы в конверт.
Добавление напоминаний для конверта	Добавление напоминаний для конверта
Добавление получателя в конверт (версия 2)	Добавьте получателя в конверт.
Добавление типа проверки в получатель	Добавьте тип проверки в получатель.
Запуск рабочего процесса Docusign Maestro	Запуск рабочего процесса Docusign Maestro
Массовая отправка конверта с помощью шаблона	Массовая отправка конверта с помощью шаблона
НЕ РЕКОМЕНДУЕТСЯ: создание конверта с помощью шаблона	Создайте новый конверт с помощью указанного шаблона.
НЕРЕКОМЕНДУЕМЫЙ: добавление получателя в конверт	Добавьте получателя в конверт.
НЕРЕКОМЕНДУЕМЫЙ: получение документов из конверта	Получение документов из конверта
Обновление вкладок перед заполнением конверта	Обновление значений для списка вкладок предварительной заполнения
Обновление значений вкладок получателя в конверте	Обновление значений вкладок получателя в конверте
Обновление настраиваемого поля конверта	Обновление значения для указанного настраиваемого поля конверта
Обновление полей формы создания документов из конверта	Обновление полей формы создания документов из конверта
Обновление получателя в конверте	Обновление получателя в конверте
Отправка конверта	Отправьте существующий конверт.
Повторно отправить конверт	Это действие перенаправляет конверт Docusign или отправляет напоминание получателям, которым необходимо подписать соглашение Docusign на основе предоставленного конверта.
Показать номер сборки (только для ссылки. Не включать в поток для выполнения)	Идентификатор развернутой в настоящее время сборки.
Получение вкладок документов из конверта	Получение вкладок документов из конверта
Получение вкладок документов из шаблона	Получение вкладок документов из шаблона
Получение вкладок получателей из конверта	Получение вкладок получателей из конверта
Получение документов из конверта	Получение документов из конверта
Получение настраиваемых полей документа из конверта	Получение настраиваемых полей документа из конверта
Получение полей формы создания документов из конверта	Получение полей формы создания документов из конверта
Получение сведений на вкладке "Получатель"	Возвращает значение вкладки для данного получателя
Получение сведений о документе из конверта	Получение сведений о документе из конверта
Получение сведений о настраиваемом поле из конверта	Получение сведений о настраиваемом поле из конверта
Получение сведений о получателе из конверта	Получение сведений о получателе из конверта
Получение списка событий аудита	Получение списка событий аудита
Применение шаблона к документам	Применение шаблона к документам
Пустота конверта	Пустоте конверт.
Создание URL-адреса внедренного отправителя	Создание URL-адреса внедренного отправителя
Создание URL-адреса внедренной подписи (версия 2)	Создание URL-адреса внедренной подписи (версия 2)
Создание URL-адреса внедренной подписи [НЕ РЕКОМЕНДУЕТСЯ]	Создание внедренного URL-адреса подписывания
Создание конверта	Создайте пустой конверт.
Создание конверта с помощью составных шаблонов	Создание конверта с помощью составных шаблонов
Создание конверта с помощью шаблона	Создайте новый конверт с помощью указанного шаблона.
Создание конверта с помощью шаблона с получателями и вкладками	Создание конверта с помощью шаблона с получателями и вкладками
Создание списка массовой отправки	Создание списка массовой отправки
Удаление получателя из конверта	Удаление получателя из конверта
Шаблоны списка	Список шаблонов для определенной учетной записи.

Copilot для продаж: получение ключевых продаж

ID операции:

scp-get-key-sales

Это действие позволяет получить дополнительные аналитические сведения о продажах, которые будут отображаться в ключевой карточке с информацией о продажах C4S в боковой панели Outlook. Действие повышает существующие навыки copilot для продаж

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип записи	recordType	True	string	Этот вход определяет тип записи в CRM, для которого запрашиваются ключевые сведения о продажах.
Идентификатор записи	recordId	True	string	Эти входные данные предоставляют уникальный идентификатор записи CRM, для которой запрашивается информация о ключевых продажах.
Начальная дата	startDateTime		date-time	Введите дату начала в формате: 2017-05-02T01:44Z
Верх	top		integer	Эти входные данные указывают количество основных моментов продаж для извлечения.
Пропустить	skip		integer	Эти входные данные указывают на количество элементов, которые следует пропустить при получении основных данных о продажах.
Тип CRM	crmType		string	Этот вход указывает тип CRM, в котором существует запись CRM, для которой запрашивается ключевая информация о продажах.
URL-адрес организации CRM	crmOrgUrl		string	Этот вход указывает URL-адрес среды CRM, в которой существует запись CRM, для которой запрашивается информация о ключевых продажах.

Возвращает

Тело

KeySalesResponse

Copilot для продаж: получение сводки по электронной почте

ID операции:

scp-get-email-summary

Это действие получает дополнительные аналитические сведения о продажах, которые будут отображаться в сводке по электронной почте C4S в сводке outlook. Действие улучшает существующие навыки помощника в области продаж.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип записи	recordType		string	Этот вход определяет тип записи в CRM, связанный с сводной электронной почтой.
Идентификатор записи	recordId		string	Эти входные данные предоставляют уникальный идентификатор записи CRM, связанной с сводной электронной почтой.
Тип CRM	crmType		string	Этот вход указывает тип CRM, в котором существует запись, связанная с сводной электронной почтой.
URL-адрес организации CRM	crmOrgUrl		string	Этот вход указывает URL-адрес среды CRM, в которой существует запись, связанная с сводной электронной почтой.
Разделенные запятыми адреса электронной почты	emailContacts	True	string	Эти входные данные указывают на список всех соответствующих сообщений участника в текущем потоке электронной почты.
Верх	top		integer	Эти входные данные указывают число аналитик, которые необходимо получить.
Пропустить	skip		integer	Эти входные данные указывают на количество элементов, пропускаемых при получении аналитических сведений.

Возвращает

Тело

EmailSummaryResponse

Copilot для продаж: список конвертов

ID операции:

SalesCopilotListEnvelopes

Copilot для продаж: конверты списка возвращают информацию о соглашениях Docusign, таких как название, документы, получатели, состояние соглашения, имя отправителя и URL-адрес соглашения. Подключаемый модуль может обрабатывать такие запросы, как показать мне все мои соглашения, которые мне нужно подписать или что такое состояние контракта заказа на продажу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя получателя	recipientName		string	В этом действии перечислены конверты на основе имени получателя
EmailId получателя	recipientEmailId		string	В этом действии перечислены конверты на основе идентификатора электронной почты получателя
Тема конверта	envelopeTitle		string	В этом действии перечислены конверты на основе темы электронной почты конверта
Имя настраиваемого поля	customFieldName		string	В этом действии перечислены конверты на основе имени настраиваемых полей.
Значение настраиваемого поля	customFieldValue		string	Это действие перечисляет конверты на основе значения настраиваемых полей
Состояние конверта	envelopeStatus		string	Это действие перечисляет конверты на основе состояния конверта
Folder	folder_ids		string	Это действие перечисляет конверты на основе различных состояний конверта
Заказ по	order_by		string	Это действие упорядочивает конверты на основе определенного свойства
Верх	top		integer	Верхние конверты, возвращаемые
Пропустить	skip		integer	Конверты для пропуска
Начальная дата	startDateTime		date-time	Введите дату начала в формате: 2017-05-02T01:44Z
Дата окончания	endDateTime		date-time	Введите дату окончания в формате: 2017-05-02T01:44Z

Возвращает

Тело

FilteredSalesCopilotEnvelopeListResponse

Copilot: Вывод списка конвертов

ID операции:

ListEnvelopes

Это действие возвращает соответствующие конверты Docusign на основе состояния конверта, диапазона дат, имени получателя, адреса электронной почты получателя, названия конверта, имени документа или значения настраиваемого поля конверта. Выходные данные — это название, описание, идентификатор конверта, имена документов, имена отправителей, состояние конверта, дата отправки и URL-адрес конверта, который можно использовать в качестве ссылки для просмотра конверта в Docusign.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя получателя	recipientName		string	В этом действии перечислены конверты на основе имени получателя
EmailId получателя	recipientEmailId		string	В этом действии перечислены конверты на основе идентификатора электронной почты получателя
Тема конверта	envelopeTitle		string	В этом действии перечислены конверты на основе темы электронной почты конверта
Имя настраиваемого поля	customFieldName		string	В этом действии перечислены конверты на основе имени настраиваемых полей.
Значение настраиваемого поля	customFieldValue		string	Это действие перечисляет конверты на основе значения настраиваемых полей
Состояние конверта	envelopeStatus		string	Это действие перечисляет конверты на основе состояния конверта
Folder	folder_ids		string	Это действие перечисляет конверты на основе различных состояний конверта
Заказ по	order_by		string	Это действие упорядочивает конверты на основе определенного свойства
Верх	top		integer	Верхние конверты, возвращаемые
Пропустить	skip		integer	Конверты для пропуска
Начальная дата	from_date		date-time	Введите "" при отсутствии значения, предоставленного пользователем. Введите дату начала в шаблоне или формате: 2017-05-02T01:44Z.
Дата окончания	to_date		date-time	Введите "" при отсутствии значения, предоставленного пользователем. Введите дату окончания в шаблоне или формате: 2017-05-02T01:44Z.

Возвращает

Тело

FilteredEnvelopeListResponse

Copilot: получение связанных действий

ID операции:

scp-get-related-activities

Это действие получает дополнительные сведения о продажах, связанные с записью CRM, которые будут отображаться в сводной карточке записи C4S. Действие улучшает существующие навыки помощника в области продаж.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип записи	recordType	True	string	Эти входные данные указывают тип сущности или объекта в CRM, для которого запрашивается аналитика.
Идентификатор записи	recordId	True	string	Эти входные данные указывают уникальный идентификатор записи CRM, для которой запрашивается аналитика.
Начальная дата	startDateTime		date-time	Эти входные данные указывают дату и время начала запрошенной аналитики.
Дата окончания	endDateTime		date-time	Эти входные данные указывают дату и время окончания запрошенной аналитики.
Верх	top		integer	Эти входные данные указывают число аналитик, которые необходимо получить.
Пропустить	skip		integer	Эти входные данные указывают число аналитик, которые необходимо пропустить.
Тип CRM	crmType		string	Эти входные данные указывают тип среды CRM, в которой существует запись CRM, для которой запрашивается аналитика о продажах.
URL-адрес организации CRM	crmOrgUrl		string	Эти входные данные указывают URL-адрес среды CRM, в которой существует запись CRM, для которой запрашивается аналитика о продажах.

Возвращает

Тело

ActivityListResponseEnvelope

Copilot: Получение связанных записей

ID операции:

scp-get-related-records

Это действие получает записи, связанные с записью CRM. Действие улучшает существующие навыки Copilot для продаж.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип записи	recordType	True	string	Этот вход определяет тип записи в CRM, для которого запрашиваются связанные записи.
Идентификатор записи	recordId	True	string	Эти входные данные предоставляют уникальный идентификатор записи CRM, для которой запрашиваются связанные записи.
Начальная дата	startDateTime		date-time	Введите дату начала в формате: 2017-05-02T01:44Z
Верх	top		integer	Эти входные данные указывают количество связанных записей для получения.
Пропустить	skip		integer	Этот вход указывает количество записей, которые следует пропустить при получении связанных записей.
Тип CRM	crmType		string	Эти входные данные указывают на тип связанных записей CRM, из которых извлекаются связанные записи.
URL-адрес организации CRM	crmOrgUrl		string	Эти входные данные указывают URL-адрес среды CRM, из которых извлекаются связанные записи.

Возвращает

Тело

DocumentRecordListResponseEnvelope

DEPRECATED: создание конверта с помощью шаблона с получателями

ID операции:

SendEnvelope

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Состояние конверта	status	True	string	Состояние конверта
Template	templateId	True	string	Идентификатор шаблона
Подписыватели	signers		dynamic	Подписыватели документа.
Тема сообщения электронной почты	emailSubject		string	Тема сообщения электронной почты
Тело сообщения электронной почты	emailBody		string	Тело сообщения электронной почты

Возвращает

Тело

CreateEnvelopeResponse

Вход

ID операции:

GetLoginAccounts

Вход

Возвращает

Тело

GetLoginAccountsResponse

Вывод списка документов из конверта

ID операции:

ListEnvelopeDocuments

Вывод списка документов из конверта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта

Возвращает

Тело

ListDocumentsResponse

Вывод списка документов из шаблона

ID операции:

ListTemplateDocuments

Вывод списка документов из шаблона

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Template	templateId	True	string	Идентификатор шаблона

Возвращает

Тело

ListTemplateDocumentsResponse

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

ID операции:

SearchListEnvelopes

Это действие возвращает соответствующие конверты Docusign на основе состояния конверта, диапазона дат, имени получателя, адреса электронной почты получателя, названия конверта, имени документа или значения настраиваемого поля конверта. Выходные данные — это название, описание, идентификатор конверта, имена документов, имена отправителей, состояние конверта, дата отправки и URL-адрес конверта, который можно использовать в качестве ссылки для просмотра конверта в Docusign.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	ID счета
Имя получателя	recipientName		string	В этом действии перечислены конверты на основе имени получателя
Электронная почта получателя	recipientEmailId		string	Фильтрует конверты по электронной почте получателя
Тема конверта	envelopeTitle		string	Фильтрует конверты по теме конверта
Имя настраиваемого поля	customFieldName		string	В этом действии перечислены конверты на основе имени настраиваемых полей.
Значение настраиваемого поля	customFieldValue		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.

Возвращает

Тело

FilteredEnvelopeListResponse

Вывод списка получателей из конверта

ID операции:

GetRecipientStatus

Вывод списка получателей из конверта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Folder	folderId	True	string	Идентификатор папки
Конверт	envelopeId	True	string	Идентификатор конверта

Возвращает

Тело

ListRecipientsResponse

Добавление вкладок для получателя в конверте

ID операции:

AddRecipientTabs

Добавление вкладок для получателя в конверте

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Recipient	recipientId	True	string	Идентификатор получателя
Тип табуляции	tabType	True	string	Тип табуляции
сведения о вкладке	tabDetails	True	dynamic	Сведения о выбранной вкладке привязки.

Возвращает

Тело

AddRecipientTabsResponse

Добавление документов в конверт

ID операции:

AddDocumentsToEnvelope

Добавьте документы в конверт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	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 операции:

AddReminders

Добавление напоминаний для конверта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Напоминание включено	reminderEnabled	True	boolean	Если задано значение false, напоминания отключены. Значение по умолчанию — false.
Задержка напоминания	reminderDelay	True	string	Добавьте количество дней, после которого получатель получает сообщение электронной почты с напоминанием.
Частота напоминаний	reminderFrequency	True	string	Добавьте количество дней между письмами напоминания.
Срок действия после окончания срока действия	expireAfter		string	Добавьте количество дней до истечения срока действия.

Возвращает

Тело

AddRemindersResponse

Добавление получателя в конверт (версия 2)

ID операции:

AddRecipientToEnvelopeV2

Добавьте получателя в конверт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Тип получателя	recipientType	True	string	Тип получателя
Идентификатор пользователя клиента	clientUserId		string	Идентификатор пользователя клиента для встроенного входа
URL-адрес запуска внедренного получателя	embeddedRecipientStartURL		string	Строка URL-адреса, предоставляемая отправителем для перенаправления внедренного получателя.
Порядок подписывания	routingOrder		string	Порядок подписывания получателя.
Язык уведомлений по электронной почте	emailNotificationLanguage		string	Язык для уведомления электронной почты.
Тема уведомления по электронной почте	emailNotificationSubject		string	Тема уведомления по электронной почте.
Текст уведомления по электронной почте	emailNotificationBody		string	Текст уведомления по электронной почте.
Замечание	note		string	Настраиваемая заметка для получателя.
Имя роли	roleName		string	Имя роли, связанное с получателем.
Код страны SMS	countryCode		integer	Для SMS-уведомлений код страны без знака +.
SMS-номер телефона	phoneNumber		integer	Требуется сообщение электронной почты или SMS-телефон подписывающего устройства. Исключите код страны для номера телефона.
Группа подписывания	signingGroupId		string	Группа подписывания
Тип подписи	signatureType		string	Типы подписи на основе стандартов DocuSign (SBS).
Рабочий процесс проверки	workflowId		string	Рабочие процессы IDV с типами подписей пера должны быть выбраны здесь.
сведения о выбранном типе получателя	additionalRecipientParams		dynamic	Сведения о выбранном типе получателя.

Возвращает

Тело

Signer

Добавление типа проверки в получатель

ID операции:

AddVerificationToRecipient

Добавьте тип проверки в получатель.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Идентификатор получателя	recipientId	True	string	Идентификатор получателя
Тип получателя	recipientType	True	string	Тип получателя
Тип проверки	verificationType	True	string	Тип проверки
Дополнительные данные получателя	additionalRecipientData		dynamic	Дополнительные данные получателя.

Запуск рабочего процесса Docusign Maestro

ID операции:

TriggerMaestroFlow

Запуск рабочего процесса Docusign Maestro

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	ID счета
workflow	workflowId	True	string	Введите идентификатор рабочего процесса или выберите имя рабочего процесса в раскрывающемся списке
Имя экземпляра	instanceName	True	string	Имя экземпляра рабочего процесса Maestro
variable	variable		dynamic

Возвращает

TriggerMaestroFlowResponse

response

object

Массовая отправка конверта с помощью шаблона

ID операции:

BulkSend

Массовая отправка конверта с помощью шаблона

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	ID счета
GUID списка массовой отправки	bulkSendListId	True	string	GUID списка массовой отправки
ИД шаблона	envelopeOrTemplateId	True	string	Введите идентификатор шаблона или выберите шаблон из раскрывающегося списка

Возвращает

Тело

BulkSendListGuid

НЕ РЕКОМЕНДУЕТСЯ: создание конверта с помощью шаблона

ID операции:

CreateEnvelopeFromTemplate

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Template	templateId	True	string	Идентификатор шаблона
Состояние конверта	status	True	string	Состояние конверта
Настраиваемые поля	accountCustomFields	True	dynamic	Получите настраиваемые поля на уровне учетной записи.

Возвращает

Тело

CreateEnvelopeResponse

НЕРЕКОМЕНДУЕМЫЙ: добавление получателя в конверт

ID операции:

AddRecipientToEnvelope

Добавьте получателя в конверт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Имя подписи	AddRecipientToEnvelopeName	True	string	Имя получателя.
Электронная почта подписывющего средства	AddRecipientToEnvelopeEmail	True	string	Сообщение электронной почты получателя.
Порядок подписывания	routingOrder		string	Порядок подписывания получателя в документе.
Role	roleName		string	Роль подписывчика.

Возвращает

Тело

ListRecipientsResponse

НЕРЕКОМЕНДУЕМЫЙ: получение документов из конверта

ID операции:

GetDocuments

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Сертификат завершения	certificate	True	boolean	Если задано значение false, сертификат подписи конверта удаляется из скачивания.

Возвращает

response

GetDocumentsResponse

Обновление вкладок перед заполнением конверта

ID операции:

UpdateEnvelopePrefillTabs

Обновление значений для списка вкладок предварительной заполнения

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Идентификатор документа	documentId	True	string	Идентификатор документа
Тип	tabType		string	Тип
Идентификатор	tabId		string	Идентификатор
Ценность	value		string	Ценность

Обновление значений вкладок получателя в конверте

ID операции:

UpdateRecipientTabsValues

Обновление значений вкладок получателя в конверте

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Recipient	recipientId	True	string	Идентификатор получателя
Тип	tabType		string	Тип табуляции
Идентификатор	tabId		string	Идентификатор
Ценность	value		string	Ценность

Обновление настраиваемого поля конверта

ID операции:

UpdateEnvelopeCustomField

Обновление значения для указанного настраиваемого поля конверта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
ИД поля	fieldId	True	string	Идентификатор настраиваемого поля
Тип поля	fieldType	True	string	Настраиваемый тип поля
Имя	name	True	string	Имя настраиваемого поля
Ценность	value	True	string	Значение настраиваемого поля

Возвращает

Тело

UpdateEnvelopeCustomFieldResponse

Обновление полей формы создания документов из конверта

ID операции:

UpdateDocgenFormFields

Обновление полей формы создания документов из конверта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	ID счета
Конверт	envelopeId	True	string	Идентификатор конверта
GUID документа	documentGuid	True	string	GUID документа
Тип	fieldType		string	Выберите тип поля создания документов для обновления
Имя	name		string	Введите имя поля или имя столбца таблицы
Ценность	value		string	Введите данные поля
: имя таблицы	tableName		string	Требуется для строки таблицы. Введите имя таблицы.
:Строка таблицы	rowNumber		string	Требуется для строки таблицы. Введите номер строки

Обновление получателя в конверте

ID операции:

UpdateEnvelopeRecipient

Обновление получателя в конверте

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	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		integer	Для SMS-уведомлений код страны без знака +.
SMS-номер телефона	phoneNumber		integer	Требуется сообщение электронной почты или SMS-телефон подписывающего устройства. Исключите код страны для номера телефона.
Группа подписывания	signingGroupId		string	Группа подписывания
сведения о выбранном типе получателя	additionalRecipientParams		dynamic	Сведения о выбранном типе получателя.

Возвращает

Тело

Signer

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

ID операции:

SendDraftEnvelope

Отправьте существующий конверт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта

Возвращает

response

object

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

ID операции:

ResendEnvelope

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

Параметры

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

Возвращает

response

object

Показать номер сборки (только для ссылки. Не включать в поток для выполнения)

ID операции:

BuildNumber

Идентификатор развернутой в настоящее время сборки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Номер сборки	buildNumber		dynamic

Возвращает

response

object

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

ID операции:

GetEnvelopeDocumentTabs

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Идентификатор документа	documentId	True	string	Идентификатор документа

Возвращает

Тело

ListTabsResponse

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

ID операции:

GetTemplateDocumentTabs

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Template	templateId	True	string	Идентификатор шаблона
Идентификатор документа	documentId	True	string	Идентификатор документа

Возвращает

Тело

ListTabsResponse

Получение вкладок получателей из конверта

ID операции:

GetEnvelopeRecipientTabs

Получение вкладок получателей из конверта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Идентификатор получателя	recipientId	True	string	Идентификатор получателя

Возвращает

Тело

RecipientTabsResponse

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

ID операции:

GetDocumentsV2

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Формат вывода	documentId	True	string	Укажите определенный идентификатор документа или используйте выходной формат из раскрывающегося списка

Возвращает

response

GetDocumentsResponse

Получение настраиваемых полей документа из конверта

ID операции:

GetEnvelopeDocumentFields

Получение настраиваемых полей документа из конверта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Идентификатор документа	documentId	True	string	Идентификатор документа

Возвращает

Тело

ListEnvelopeDocumentFieldsResponse

Получение полей формы создания документов из конверта

ID операции:

GetDocgenFormFields

Получение полей формы создания документов из конверта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта

Возвращает

Тело

DocGenFormFieldsResponse

Получение сведений на вкладке "Получатель"

ID операции:

GetTabInfo

Возвращает значение вкладки для данного получателя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Идентификатор получателя	recipientId	True	string	Идентификатор получателя
Метка табуляции	tabLabel	True	string	Метка табуляции

Возвращает

Тело

Tab

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

ID операции:

GetEnvelopeDocumentInfo

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Имя документа	documentName	True	string	Имя файла с расширением

Возвращает

Тело

EnvelopeDocument

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

ID операции:

GetEnvelopeCustomField

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Имя настраиваемого поля	fieldName	True	string	Имя настраиваемого поля

Возвращает

Тело

EnvelopeCustomFieldResponse

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

ID операции:

GetRecipientFields

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Электронная почта получателя	recipientEmail		string	Электронная почта получателя
Код области	areaCode		string	Код области получателя
Номер телефона	phoneNumber		string	Номер телефона получателя
Идентификатор получателя	recipientId		string	Идентификатор recipinet

Возвращает

Тело

Signer

Получение списка событий аудита

ID операции:

GetAuditEvents

Получение списка событий аудита

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта

Возвращает

response

object

Применение шаблона к документам

ID операции:

ApplyTemplatesToDocuments

Применение шаблона к документам

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	ID счета
Идентификатор конверта	envelopeId	True	string	Идентификатор конверта
Template	templateId	True	string	Template
Сохранение получателя шаблона	preserve_template_recipient		string	Неправда
Идентификатор документа	documentId	True	string	Идентификатор документа
Начальная страница документа	documentStartPage	True	string	Начальная страница документа
Конечная страница документа	documentEndPage	True	string	Конечная страница документа

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

ID операции:

VoidEnvelope

Пустоте конверт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Причина void	voidedReason	True	string	Непустимая причина

Возвращает

response

object

Создание URL-адреса внедренного отправителя

ID операции:

GenerateEmbeddedSenderURL

Создание URL-адреса внедренного отправителя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Конверт	envelopeId	True	string	Идентификатор конверта
Открыть в	openIn	True	string	Открыть в
URL-адрес возврата	returnUrl	True	string	URL-адрес возврата
Дополнительный добавленный URL-адрес	additionalURL		dynamic	Дополнительный добавленный URL-адрес.

Возвращает

Тело

EmbeddedSenderResponse

Создание URL-адреса внедренной подписи (версия 2)

ID операции:

GenerateEmbeddedSigningURLV2

Создание URL-адреса внедренной подписи (версия 2)

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	ID счета
Конверт	envelopeId	True	string	Идентификатор конверта
Это пользователь, который входит в систему?	isInPersonSigner	True	string	Да/нет
Метод проверки подлинности	authenticationMethod	True	string	Метод проверки подлинности
URL-адрес возврата	returnUrl	True	string	URL-адрес возврата
Дополнительный добавленный URL-адрес	additionalURL	True	dynamic	Дополнительный добавленный URL-адрес.

Возвращает

Тело

EmbeddedSigningResponse

Создание URL-адреса внедренной подписи [НЕ РЕКОМЕНДУЕТСЯ]

ID операции:

GenerateEmbeddedSigningURL

Создание внедренного URL-адреса подписывания

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	ID счета
Конверт	envelopeId	True	string	Идентификатор конверта
Имя подписи	signerName	True	string	Имя подписи
Электронная почта подписывющего средства	signerEmail	True	string	Электронная почта подписывющего средства
Идентификатор пользователя клиента	clientUserId		string	Требуется, если пользователь не входит в систему. Оставьте пустым для пользователей подписывющих лиц
Метод проверки подлинности	authenticationMethod	True	string	Метод проверки подлинности
URL-адрес возврата	returnUrl	True	string	URL-адрес возврата
Дополнительный добавленный URL-адрес	additionalURL		dynamic	Дополнительный добавленный URL-адрес.

Возвращает

Тело

EmbeddedSigningResponse

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

ID операции:

CreateBlankEnvelope

Создайте пустой конверт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Тема сообщения электронной почты	emailSubject	True	string	Тема сообщения электронной почты.
Тело сообщения электронной почты	emailBody		string	Текст сообщения электронной почты.
Настраиваемые поля	accountCustomFields		dynamic	Получите настраиваемые поля на уровне учетной записи.

Возвращает

Тело

CreateEnvelopeResponse

Создание конверта с помощью составных шаблонов

ID операции:

CompositeTemplates

Создание конверта с помощью составных шаблонов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Тема сообщения электронной почты	emailSubject	True	string	Тема сообщения электронной почты.
Тело сообщения электронной почты	emailBody		string	Текст сообщения электронной почты.
Состояние конверта	status	True	string	Состояние конверта
body	body		dynamic

Возвращает

Имя	Путь	Тип	Описание
Идентификатор конверта	envelopeId	string	Идентификатор конверта.
Состояние	status	string	Состояние конверта.
Время даты состояния	statusDateTime	string	Дата и время установки состояния.
URI	uri	string	Универсальный код ресурса (URI) для конверта в DocuSign.

Создание конверта с помощью шаблона

ID операции:

CreateEnvelopeFromTemplateNoRecipients

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Template	templateId	True	string	Идентификатор шаблона
Состояние конверта	status	True	string	Состояние конверта

Возвращает

Тело

CreateEnvelopeResponse

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

ID операции:

SendEnvelopeWithRecipientFields

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	ID счета
Template	templateId	True	string	ИД шаблона
Получатели	recipients		dynamic	Подписыватели документа.
Тема сообщения электронной почты	emailSubject		string	Тема сообщения электронной почты

Возвращает

Тело

CreateEnvelopeResponse

Создание списка массовой отправки

ID операции:

CreateBulkSendList

Создание списка массовой отправки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	ID счета
Имя списка массового отправки	name	True	string	Имя списка массового отправки
CSV-файл	csv		string	Отправка CSV-файла

Возвращает

Тело

BulkSendListGuid

Удаление получателя из конверта

ID операции:

RemoveRecipientFromEnvelope

Удаление получателя из конверта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Folder	folderId	True	string	Идентификатор папки
Конверт	envelopeId	True	string	Идентификатор конверта
Recipient	RemoveRecipientFromEnvelopeRecipientId	True	string	Идентификатор получателя

Возвращает

Тело

ListRecipientsResponse

Шаблоны списка

ID операции:

GetEnvelopeTemplates

Список шаблонов для определенной учетной записи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи

Возвращает

Тело

ListTemplatesResponse

Триггеры

НЕ РЕКОМЕНДУЕТСЯ: при изменении состояния конверта (Подключение)	Активирует новый поток при изменении состояния конверта.
НЕ РЕКОМЕНДУЕТСЯ: при изменении состояния конверта (Подключение) (версия 2)	Активирует новый поток при изменении состояния конверта.
При изменении состояния конверта (Подключение) (V3)	Активирует новый поток при изменении состояния конверта.

НЕ РЕКОМЕНДУЕТСЯ: при изменении состояния конверта (Подключение)

ID операции:

CreateHookEnvelope

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Имя подключения	name	True	string
Событие конверта	envelopeEvents	True	string

Возвращает

Тело

WebhookEnvelopeResponse

НЕ РЕКОМЕНДУЕТСЯ: при изменении состояния конверта (Подключение) (версия 2)

ID операции:

CreateHookEnvelopeV2

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Имя подключения	name	True	string
Событие конверта	envelopeEvents	True	string

Возвращает

Тело

WebhookEnvelopeResponseV2

При изменении состояния конверта (Подключение) (V3)

ID операции:

CreateHookEnvelopeV3

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Счет	accountId	True	string	Идентификатор учетной записи
Имя подключения	name	True	string
Событие конверта	envelopeEvents	True	string

Возвращает

Тело

WebhookEnvelopeResponseV2

Определения

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
Имя отправителя	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-адрес конверта

SalesCopilotFilteredEnvelopes

Имя	Путь	Тип	Описание
Название	title	string	Название конверта
Подзаголовок	subTitle	string	SubTitle конверта
URL	url	string	URL-адрес конверта
Дополнительные свойства	additionalPropertiesForSalesEnvelope.additionalPropertiesForSalesEnvelope	string	Дополнительные свойства

Activity

Имя	Путь	Тип	Описание
Название	title	string	Эти выходные данные указывают заголовок действия в карточке цитирования.
Description	description	string	Эти выходные данные указывают описание аналитики.
DateTime	dateTime	date-time	Эти выходные данные указывают время, связанное с аналитическим представлением.
URL	url	string	Эти выходные данные указывают URL-адрес для открытия аналитики.
Дополнительные свойства	additionalProperties.additionalProperties	string	Дополнительные свойства действия

EmailSummary

Имя	Путь	Тип	Описание
Название	Title	string	Эти выходные данные указывают название раздела партнера и должны содержать только имя партнера.
описание	Description	string	В этом выходных данных указывается текст, который вы хотите включить в сводку по электронной почте.

KeySales

Имя	Путь	Тип	Описание
Название	Title	string	В этом выводе указывается заголовок карточки цитирования для обозрения.
описание	description	string	Эти выходные данные указывают на текст аналитических сведений, которые будут включены в ключевые сведения о продажах.
URL-адрес конверта	url	string	Эти выходные данные указывают URL-адрес для получения дополнительных сведений.
Время, связанное с аналитическим представлением	dateTime	string	Эти выходные данные указывают время, связанное с аналитическим представлением.
Дополнительные свойства	additionalProperties.additionalProperties	string	Эти результаты отображают дополнительные свойства в виде пар "имя-значение" каждого связанного вывода, возвращаемого действием.

DocumentRecord

Имя	Путь	Тип	Описание
Идентификатор записи	recordId	string	Этот вывод однозначно определяет каждую связанную запись, возвращаемую действием.
Отображаемое имя типа записи	recordTypeDisplayName	string	Это выходные данные указывают отображаемое имя типа записи каждого связанного записи, возвращаемой действием.
Отображаемое имя типа записи в множественном числе	recordTypePluralDisplayName	string	В этом выходных данных указывается отображаемое имя множественного числа типа записи каждого связанного записи, возвращаемой действием.
Тип записи	recordType	string	Это выходные данные указывают тип каждой связанной записи, возвращаемой действием.
Заголовок записи	recordTitle	string	Это выходные данные указывают заголовок каждой связанной записи, возвращаемой действием.
URL-адрес конверта	url	string	В этом выходных данных указывается URL-адрес каждой связанной записи, возвращаемой действием.
Дополнительные свойства	additionalProperties.additionalProperties	string	В этом выходных данных указываются дополнительные свойства в виде пар "имя-значение" каждой связанной записи, возвращаемой действием.

EmbeddedSenderResponse

Имя	Путь	Тип	Описание
Внедренный URL-адрес отправителя	url	string	URL-адрес внедренного представления отправителя.

EmbeddedSigningResponse

Имя	Путь	Тип	Описание
URL	url	string	URL-адрес внедренного представления подписывания.

FilteredEnvelopeListResponse

Имя	Путь	Тип	Описание
Отфильтрованные конверты	value	array of FilteredEnvelopes	Отфильтрованные конверты
Дополнительные результаты конверта	hasMoreResults	boolean	Показывает, превышает ли конверты указанное число в поле "Возвращаемые конверты"

FilteredSalesCopilotEnvelopeListResponse

Имя	Путь	Тип	Описание
Отфильтрованные конверты	value	array of SalesCopilotFilteredEnvelopes	Отфильтрованные конверты
естьЕщеРезультаты	hasMoreResults	boolean

ActivityListResponseEnvelope

Имя	Путь	Тип	Описание
Связанные действия	value	array of Activity	Связанные активации
естьЕщеРезультаты	hasMoreResults	boolean

EmailSummaryResponse

Имя	Путь	Тип	Описание
Сводка по электронной почте	value	array of EmailSummary	Ключевые продажи
естьЕщеРезультаты	hasMoreResults	boolean

KeySalesResponse

Имя	Путь	Тип	Описание
Ключевые продажи	value	array of KeySales	Ключевые продажи
естьЕщеРезультаты	hasMoreResults	boolean

DocumentRecordListResponseEnvelope

Имя	Путь	Тип	Описание
Связанные записи	value	array of DocumentRecord	Связанные записи
естьЕщеРезультаты	hasMoreResults	boolean

CreateEnvelopeResponse

Имя	Путь	Тип	Описание
Идентификатор конверта	envelopeId	string	Идентификатор конверта.
Идентификатор шаблона	templateId	string	Идентификатор шаблона.
Состояние	status	string	Состояние конверта.
Время даты состояния	statusDateTime	string	Дата и время установки состояния.
URI	uri	string	Универсальный код ресурса (URI) для конверта в DocuSign.

ListRecipientsResponse

Имя	Путь	Тип	Описание
Подписыватели	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	Имя получателя.
Адрес электронной почты	email	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

Причина отклонения

объект

Это тип object.

Использование этого коннектора

• Упрощение процессов подписывания и подключения к документам