DocuSign
Отправка документов для электронной подписи через DocuSign
DocuSign — это ведущая в мире платформа для электронной подписи, позволяющая компаниям отправлять, подписывать и управлять соглашениями в цифровом формате. С помощью мощного REST API электронной подписи DocuSign поддерживает полный жизненный цикл документа от создания до завершения.
С интеграцией DocuSign в AACFlow вы можете:
- Отправлять конверты: Создавать и отправлять документы для электронной подписи с пользовательскими получателями и полями для подписи
- Использовать шаблоны: Отправлять конверты из предварительно настроенных шаблонов DocuSign с назначением ролей
- Отслеживать статус: Получать детали конверта, включая прогресс подписания, временные метки и статус получателей
- Списывать конверты: Искать и фильтровать конверты по диапазону дат, статусу и тексту
- Загружать документы: Получать подписанные документы в виде файлов с кодировкой base64
- Управлять получателями: Просматривать детали подписывающих и CC-получателей, а также статус подписания
- Аннулировать конверты: Отменять конверты в процессе выполнения с указанием причины
В AACFlow интеграция с DocuSign позволяет вашим агентам автоматизировать рабочие процессы документов от начала до конца. Агенты могут генерировать соглашения, отправлять их на подпись, отслеживать завершение и получать подписанные копии — обеспечивая управление контрактами, адаптацию сотрудников, закрытие сделок и процессы соответствия требованиям.
Создавайте и отправляйте конверты для электронной подписи, используйте шаблоны, проверяйте статус подписания, загружайте подписанные документы и управляйте получателями с помощью DocuSign.
Создать и отправить конверт DocuSign с документом для электронной подписи
| Параметр | Тип | Обязательный | Описание |
|---|
emailSubject | string | Да | Тема письма для конверта |
emailBody | string | Нет | Текст сообщения письма |
signerEmail | string | Да | Адрес электронной почты подписывающего |
signerName | string | Да | Полное имя подписывающего |
ccEmail | string | Нет | Адрес электронной почты получателя копии (CC) |
ccName | string | Нет | Полное имя получателя копии (CC) |
file | file | Нет | Файл документа для отправки на подпись |
status | string | Нет | Статус конверта: "sent" для немедленной отправки, "created" для черновика (по умолчанию: "sent") |
| Параметр | Тип | Описание |
|---|
envelopeId | string | Созданный ID конверта |
status | string | Статус конверта |
statusDateTime | string | Дата и время изменения статуса |
uri | string | URI конверта |
Создать и отправить конверт DocuSign с использованием предварительно созданного шаблона
| Параметр | Тип | Обязательный | Описание |
|---|
templateId | string | Да | ID шаблона DocuSign для использования |
emailSubject | string | Нет | Переопределение темы письма (использует значение по умолчанию из шаблона, если не установлено) |
emailBody | string | Нет | Переопределение текста сообщения письма |
templateRoles | string | Да | JSON массив ролей шаблона, например [{"roleName":"Signer","name":"John","email":"john@example.com"}] |
status | string | Нет | Статус конверта: "sent" для немедленной отправки, "created" для черновика (по умолчанию: "sent") |
| Параметр | Тип | Описание |
|---|
envelopeId | string | Созданный ID конверта |
status | string | Статус конверта |
statusDateTime | string | Дата и время изменения статуса |
uri | string | URI конверта |
Получить детали и статус конверта DocuSign
| Параметр | Тип | Обязательный | Описание |
|---|
envelopeId | string | Да | ID конверта для получения |
| Параметр | Тип | Описание |
|---|
envelopeId | string | ID конверта |
status | string | Статус конверта (created, sent, delivered, completed, declined, voided) |
emailSubject | string | Тема письма |
sentDateTime | string | Когда конверт был отправлен |
completedDateTime | string | Когда все получатели завершили подписание |
createdDateTime | string | Когда конверт был создан |
statusChangedDateTime | string | Когда статус последний раз изменялся |
voidedReason | string | Причина аннулирования конверта |
signerCount | number | Количество подписывающих |
documentCount | number | Количество документов |
Список конвертов из вашей учетной записи DocuSign с опциональными фильтрами
| Параметр | Тип | Обязательный | Описание |
|---|
fromDate | string | Нет | Фильтр начальной даты (ISO 8601). По умолчанию: 30 дней назад |
toDate | string | Нет | Фильтр конечной даты (ISO 8601) |
envelopeStatus | string | Нет | Фильтр по статусу: created, sent, delivered, completed, declined, voided |
searchText | string | Нет | Текст для поиска и фильтрации конвертов |
count | string | Нет | Максимальное количество конвертов для возврата (по умолчанию: 25) |
| Параметр | Тип | Описание |
|---|
envelopes | array | Массив конвертов DocuSign |
↳ envelopeId | string | Уникальный идентификатор конверта |
↳ status | string | Статус конверта (created, sent, delivered, completed, declined, voided) |
↳ emailSubject | string | Тема письма |
↳ sentDateTime | string | Дата и время ISO 8601, когда конверт был отправлен |
↳ completedDateTime | string | Дата и время ISO 8601, когда конверт был завершен |
↳ createdDateTime | string | Дата и время ISO 8601, когда конверт был создан |
↳ statusChangedDateTime | string | Дата и время ISO 8601 последнего изменения статуса |
totalSetSize | number | Общее количество соответствующих конвертов |
resultSetSize | number | Количество конвертов, возвращенных в этом ответе |
Аннулировать (отменить) отправленный конверт DocuSign, который еще не был завершен
| Параметр | Тип | Обязательный | Описание |
|---|
envelopeId | string | Да | ID конверта для аннулирования |
voidedReason | string | Да | Причина аннулирования конверта |
| Параметр | Тип | Описание |
|---|
envelopeId | string | Аннулированный ID конверта |
status | string | Статус конверта (voided) |
Загрузить подписанный документ из завершенного конверта DocuSign
| Параметр | Тип | Обязательный | Описание |
|---|
envelopeId | string | Да | ID конверта, содержащего документ |
documentId | string | Нет | Конкретный ID документа для загрузки, или "combined" для всех объединенных документов (по умолчанию: "combined") |
| Параметр | Тип | Описание |
|---|
base64Content | string | Содержимое документа в кодировке base64 |
mimeType | string | MIME-тип документа |
fileName | string | Исходное имя файла |
Список доступных шаблонов в вашей учетной записи DocuSign
| Параметр | Тип | Обязательный | Описание |
|---|
searchText | string | Нет | Текст для поиска и фильтрации шаблонов по имени |
count | string | Нет | Максимальное количество шаблонов для возврата |
| Параметр | Тип | Описание |
|---|
templates | array | Массив шаблонов DocuSign |
↳ templateId | string | Идентификатор шаблона |
↳ name | string | Имя шаблона |
↳ description | string | Описание шаблона |
↳ shared | boolean | Является ли шаблон общим |
↳ created | string | Дата создания в формате ISO 8601 |
↳ lastModified | string | Дата последнего изменения в формате ISO 8601 |
totalSetSize | number | Общее количество соответствующих шаблонов |
resultSetSize | number | Количество шаблонов, возвращенных в этом ответе |
Получить детали статуса получателей для конверта DocuSign
| Параметр | Тип | Обязательный | Описание |
|---|
envelopeId | string | Да | ID конверта для получения получателей |
| Параметр | Тип | Описание |
|---|
signers | array | Массив получателей DocuSign |
↳ recipientId | string | Идентификатор получателя |
↳ name | string | Имя получателя |
↳ email | string | Адрес электронной почты получателя |
↳ status | string | Статус подписания получателя (sent, delivered, completed, declined) |
↳ signedDateTime | string | Дата и время ISO 8601, когда получатель подписал |
↳ deliveredDateTime | string | Дата и время ISO 8601, когда было доставлено получателю |
carbonCopies | array | Массив получателей копий (CC) |
↳ recipientId | string | ID получателя |
↳ name | string | Имя получателя |
↳ email | string | Электронная почта получателя |
↳ status | string | Статус получателя |
