RSign (предварительная версия)
RSign® — это безопасная, юридическая платформа сигнатуры, которая упрощает рабочие процессы документов. Этот соединитель позволяет пользователям автоматизировать отправку запросов подписи, отслеживать состояние конверта в режиме реального времени и получать завершенные подписанные документы и сертификаты подписи. Она повышает эффективность бизнеса путем оцифровки выполнения документов и обеспечения безопасности, отслеживаемых цифровых транзакций.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Класс | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя. | Поддержка RSign |
| URL | https://rsign.com/contact/questions |
| Адрес электронной почты | support@rpost.com |
| Метаданные соединителя | |
|---|---|
| Publisher | RPost US Inc |
| Publisher | RPost US Inc |
| Веб-сайт | https://rpost.com/ |
| Политика конфиденциальности | https://rpost.com/legal-notices/privacy-notice |
| Категории | Содержимое и файлы; Продуктивность |
Обзор пользовательского соединителя RSign
Имя соединителя: Описание RSign : RSign® — это платформа управления электронными подписями и цифровыми транзакциями для безопасных, юридически обязательных и оптимизированных рабочих процессов документов. Издателя: RPost
1. Возможности соединителя
Соединитель RSign предоставляет доступ к функциям управления электронными подписями и документами, позволяя пользователям интегрировать рабочие процессы RSign® непосредственно в решения Power Platform (Power Automate, Power Apps и Logic Apps).
Ключевые действия
Соединитель в настоящее время поддерживает следующие основные операции:
-
Получение AuthToken: Проверяет подлинность пользователя на основе учетных данных RSign® и извлекает необходимый маркер (
AuthToken) для всех последующих вызовов API. - Отправка конверта с помощью шаблона: Отправляет документ для электронной подписи с помощью предварительно настроенного шаблона RSign®, сопоставляя роли шаблона с определенными получателями.
- Отправка конверта с помощью правила: Отправляет документ для электронной подписи с помощью предварительно настроенного правила RSign®, что позволяет предоставлять документы в виде данных Base64 в тексте запроса.
-
Получение сведений о шаблоне: Извлекает сведения о определенном шаблоне или правиле RSign®, включая определенные документы и роли получателя (
RoleID). - Получение состояния конверта: Извлекает состояние запроса электронной подписи с помощью кода конверта.
- Получение документов конверта: Загружает документы, связанные с кодом конверта (исходные и/или окончательные подписанные документы).
2. Настройка проверки подлинности
Соединитель RSign® использует пользовательскую схему проверки подлинности, требующую успешного Get AuthToken вызова действия перед выполнением любого другого действия.
Действие проверки подлинности (Get AuthToken)
Для этого действия требуются следующие учетные данные, которые должны быть получены из платформы RSign®:
| Имя параметра | Тип | Description | Видимость |
|---|---|---|---|
ReferenceKey |
струна | Ключ ссылки, связанный с учетной записью RPost®. | Это важно |
EmailId |
струна | Адрес электронной почты учетной записи RSign®. | Это важно |
Password |
пароль | Пароль для учетной записи RSign®. | Это важно |
Использование AuthToken
Действие Get AuthToken возвращается AuthToken в тексте ответа. Затем этот маркер необходимо передать в последующих вызовах API ко всем другим поддерживаемым действиям.
Примечание: Срок AuthToken действия (AuthTokenExpires) и должен управляться в логике потока или приложения, чтобы обеспечить использование нового маркера при истечении срока действия существующего.
3. Предварительные требования
Чтобы успешно использовать этот настраиваемый соединитель RSign®, пользователи должны соответствовать следующим требованиям:
- Допустимая лицензия RSign®: У пользователей должна быть активная и допустимая лицензия пользователя RSign®.
-
Доступ к API: Учетная запись RSign®, связанная с предоставленными учетными данными, должна включать функцию доступа к API и платить за нее. Эта функция необходима для создания и успешного
ReferenceKeyиспользования соединителя RSign®.
Если вы не соответствуете этим требованиям или не уверены в текущей настройке учетной записи RSign®, обратитесь к представителю RPost®.
4. Важные заметки для интеграции
Использование шаблонов и правил
-
Код шаблона или код правила: Для обоих
Send Envelopeдействий требуетсяTemplateCode(или код правила), определяющий предварительно настроенный документ и поля подписи в RSign®. -
Сопоставление ролей: При отправке конверта
TemplateRoleRecipientMappingмассив должен быть заполнен. ДляRoleIDкаждого получателя сначала необходимо получить его с помощьюRetrieve Template Informationдействия. Это гарантирует, что получатели правильно сопоставляются с полями подписи, определенными в шаблоне.
Обработка документов
-
Отправка конверта с помощью правила: Для этого действия требуется передать содержимое документа в виде строки в кодировке Base64 (
DocumentBase64Data). -
Получение документов конверта: Документы возвращаются в тексте ответа в виде строк Base64 (
ByteArray). Поток потребления должен декодировать эту строку, чтобы сохранить файл.
Обработка ошибок
Все действия возвращают сведения о состоянии в теле ответа, в том числе:
-
StatusCode(целое число) -
StatusMessage(строка) -
Message(строка)
Пользователи должны реализовать проверку ошибок на StatusCode основе успешного выполнения операции.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Отправка конверта с помощью правила |
Отправляет запрос eSign выбранным получателям с помощью указанного правила RSign. |
| Отправка конверта с помощью шаблона |
Отправляет запрос eSign выбранным получателям с помощью указанного шаблона RSign. |
|
Получение Auth |
Возвращает authToken, который будет использоваться во всех других поддерживаемых действиях RSign. |
| Получение документов конверта |
Извлекает часть документов конверта на основе кода конверта. Он извлекает исходные документы и/или окончательные подписанные документы в зависимости от состояния конверта. |
| Получение сведений о шаблоне |
Извлекает сведения о шаблоне или правиле на основе кода. Среди возвращаемых сведений — имя шаблона, документы и роли, определенные. |
| Получение состояния конверта |
Извлекает состояние конверта на основе кода конверта. Вы можете выбрать подробный или сводный отчет. |
Отправка конверта с помощью правила
Отправляет запрос eSign выбранным получателям с помощью указанного правила RSign.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер проверки подлинности
|
AuthToken | True | string |
AuthToken, полученный из действия Get AuthToken. |
|
TemplateCode
|
TemplateCode | True | string |
Идентификатор используемого правила. |
|
Имя.
|
Name | True | string |
Имя документа. Включите расширение (например, Agreement.docx). |
|
DocumentBase64Data
|
DocumentBase64Data | True | string |
Документ, отправляемый в формате Base64. |
|
Ключ приложения
|
AppKey | string |
Уникальный идентификатор системы с помощью соединителя. Отправьте запрос в службу поддержки RPost®. |
|
|
RoleID
|
RoleID | True | string |
Идентификатор роли получателя. Извлекается из действия "Получение сведений о шаблоне". |
|
RecipientEmail
|
RecipientEmail | True | string |
Адрес электронной почты получателя. |
|
RecipientName
|
RecipientName | True | string |
Имя получателя. |
|
мобильное устройство
|
Mobile | string |
Номер мобильного телефона получателя. Если правило не требует его, оставьте пустым. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код конверта
|
EnvelopeCode | string |
Идентификатор конверта. |
|
Сообщение об изменении прозрачности
|
TransparencyChangedMessage | string |
Сообщение об изменении прозрачности. |
|
Сообщение API на основе языка
|
LanguageBasedApiMessge | string |
Сообщение API на основе языка. |
|
Идентификатор получателя перед заполнением
|
PrefillRecipientId | string |
Идентификатор получателя перед заполнением. |
|
Страница навигации после отправки
|
PostSendingNavigationPage | string |
Веб-сайт, на который получатель будет перенаправлен после завершения подписывания конверта. |
|
Включен новый пользовательский интерфейс signer
|
IsNewSignerUIEnabled | boolean |
Включен новый пользовательский интерфейс signer. |
|
Код состояния
|
StatusCode | integer |
Код состояния ответа. |
|
Сообщение о состоянии
|
StatusMessage | string |
Сообщение о состоянии ответа. |
|
Message
|
Message | string |
Описание состояния ответа. |
|
Идентификатор конверта
|
EnvelopeId | string |
Внутренний идентификатор созданного конверта. |
|
URL-адрес документа для подписи
|
SignDoumentUrl | string |
Глобальный URL-адрес для подписи конверта. |
|
Список получателей
|
RecipientList | array of object |
Сведения о получателях |
|
Имя получателя
|
RecipientList.RecipientName | string |
Имя получателя. |
|
Электронная почта получателя
|
RecipientList.RecipientEmail | string |
Адрес электронной почты получателя. |
|
Заказ
|
RecipientList.Order | integer |
Порядок, в котором получатель должен получить доступ к завершению конверта. |
|
Тип
|
RecipientList.Type | string |
Тип получателя части текущего конверта. Возможные значения: Signer и Prefill. |
|
Режим доставки
|
RecipientList.DeliveryMode | integer |
Указывает канал, через который был отправлен запрос подписи и код доступа получателю. |
|
Код номера
|
RecipientList.DialCode | string |
Номер номера страны, в которой отправлен запрос подписи и код доступа. |
|
Код страны
|
RecipientList.CountryCode | string |
Код страны, в которой отправлен запрос подписи и код доступа. |
|
Номер мобильного устройства
|
RecipientList.Mobile | string |
Номер мобильного телефона получателя. |
|
Мобильный режим
|
RecipientList.MobileMode | integer |
Указывает мобильный канал, через который был отправлен запрос подписи и код доступа получателю. |
|
URL-адрес подписи
|
RecipientList.SigningUrl | string |
URL-адрес, используемый получателем для доступа и подписывания конверта. |
|
Раскрывающийся список набора кода
|
DialCodeDropdownList | string |
Раскрывающийся список набора кода. |
|
Включение сообщения для мобильных устройств
|
EnableMessageToMobile | string |
Включите сообщение на мобильное устройство. |
Отправка конверта с помощью шаблона
Отправляет запрос eSign выбранным получателям с помощью указанного шаблона RSign.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер проверки подлинности
|
AuthToken | True | string |
AuthToken, полученный из действия Get AuthToken. |
|
TemplateCode
|
TemplateCode | True | string |
Идентификатор используемого шаблона. |
|
Ключ приложения
|
AppKey | string |
Уникальный идентификатор системы с помощью соединителя. Отправьте запрос в службу поддержки RPost®. |
|
|
RoleID
|
RoleID | True | string |
Идентификатор роли получателя. Извлекается из действия "Получение сведений о шаблоне". |
|
RecipientEmail
|
RecipientEmail | True | string |
Адрес электронной почты получателя. |
|
RecipientName
|
RecipientName | True | string |
Имя получателя. |
|
мобильное устройство
|
Mobile | string |
Номер мобильного телефона получателя. Если шаблон не требует его, оставьте пустым. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код конверта
|
EnvelopeCode | string |
Идентификатор конверта. |
|
Сообщение об изменении прозрачности
|
TransparencyChangedMessage | string |
Сообщение об изменении прозрачности. |
|
Сообщение API на основе языка
|
LanguageBasedApiMessge | string |
Сообщение API на основе языка. |
|
Идентификатор получателя перед заполнением
|
PrefillRecipientId | string |
Идентификатор получателя перед заполнением. |
|
Страница навигации после отправки
|
PostSendingNavigationPage | string |
Веб-сайт, на который получатель будет перенаправлен после завершения подписывания конверта. |
|
Включен новый пользовательский интерфейс signer
|
IsNewSignerUIEnabled | boolean |
Включен новый пользовательский интерфейс signer. |
|
Код состояния
|
StatusCode | integer |
Код состояния ответа. |
|
Сообщение о состоянии
|
StatusMessage | string |
Сообщение о состоянии ответа. |
|
Message
|
Message | string |
Описание состояния ответа. |
|
Идентификатор конверта
|
EnvelopeId | string |
Внутренний идентификатор созданного конверта. |
|
URL-адрес документа для подписи
|
SignDoumentUrl | string |
Глобальный URL-адрес для подписи конверта. |
|
Список получателей
|
RecipientList | array of object |
Сведения о получателях |
|
Имя получателя
|
RecipientList.RecipientName | string |
Имя получателя части текущего конверта. |
|
Электронная почта получателя
|
RecipientList.RecipientEmail | string |
Адрес электронной почты получателя части текущего конверта. |
|
Заказ
|
RecipientList.Order | integer |
Порядок, в котором получатель должен получить доступ к завершению конверта. |
|
Тип
|
RecipientList.Type | string |
Тип получателя части текущего конверта. Возможные значения: Signer и Prefill. |
|
Режим доставки
|
RecipientList.DeliveryMode | integer |
Указывает канал, через который был отправлен запрос подписи и код доступа получателю. |
|
Код номера
|
RecipientList.DialCode | string |
Номер номера страны, в которой отправлен запрос подписи и код доступа. |
|
Код страны
|
RecipientList.CountryCode | string |
Код страны, в которой отправлен запрос подписи и код доступа. |
|
Номер мобильного устройства
|
RecipientList.Mobile | string |
Номер мобильного телефона получателя. |
|
Мобильный режим
|
RecipientList.MobileMode | integer |
Указывает мобильный канал, через который был отправлен запрос подписи и код доступа получателю. |
|
URL-адрес подписывания
|
RecipientList.SigningUrl | string |
URL-адрес, используемый получателем для доступа и подписывания конверта. |
|
Раскрывающийся список набора кода
|
DialCodeDropdownList | string |
Раскрывающийся список набора кода. |
|
Включение сообщения для мобильных устройств
|
EnableMessageToMobile | string |
Включите сообщение на мобильное устройство. |
Получение AuthToken
Возвращает authToken, который будет использоваться во всех других поддерживаемых действиях RSign.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ReferenceKey
|
ReferenceKey | True | string |
Уникальный идентификатор учетной записи компании. |
|
EmailId
|
EmailId | True | string |
Адрес электронной почты учетной записи RSign. |
|
Пароль
|
Password | True | password |
Пароль учетной записи RSign. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Сообщение проверки подлинности
|
AuthMessage | string |
Сообщение о состоянии ответа. |
|
Маркер проверки подлинности
|
AuthToken | string |
Маркер проверки подлинности, используемый в других действиях RSign. |
|
Обновление маркера
|
RefreshToken | string |
Маркер обновления. |
|
Срок действия маркера обновления истекает
|
RefreshTokenExpires | string |
Дата истечения срока действия текущего маркера обновления. |
|
Срок действия маркера проверки подлинности истекает
|
AuthTokenExpires | string |
Дата истечения срока действия текущего маркера проверки подлинности. |
|
Идентификатор электронной почты
|
EmailId | string |
Электронная почта прошедшего проверку подлинности пользователя. |
|
Идентификатор API
|
ApiId | string |
Идентификатор API. |
Получение документов конверта
Извлекает часть документов конверта на основе кода конверта. Он извлекает исходные документы и/или окончательные подписанные документы в зависимости от состояния конверта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код конверта
|
EnvelopeCode | True | string |
Код извлекаемого конверта. |
|
Маркер проверки подлинности
|
AuthToken | True | string |
AuthToken, полученный из действия Get AuthToken. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Состояние
|
Status | boolean |
Флаг успешного выполнения состояния. |
|
Код состояния
|
StatusCode | integer |
Код состояния ответа. |
|
Message
|
Message | string |
Описание состояния ответа. |
|
Сообщение о состоянии
|
StatusMessage | string |
Сообщение о состоянии ответа. |
|
Код конверта
|
Data.EnvelopeCode | string |
Код конверта, переданный в качестве параметра. |
|
Список документов
|
Data.DocumentList | array of object |
Список документов. |
|
Тип документа
|
Data.DocumentList.DocumentType | string |
Тип вложения. |
|
Имя файла
|
Data.DocumentList.FileName | string |
Имя файла. |
|
Description
|
Data.DocumentList.Description | string |
Описание документа. |
|
Массив байтов
|
Data.DocumentList.ByteArray | string |
Файл в формате Base64. |
|
Дополнительная информация
|
Data.DocumentList.AdditionalInfo | string |
Дополнительные сведения. |
|
Описание вложения
|
Data.DocumentList.AttachmentDescription | string |
Информативное описание содержимого файла. |
|
Чтение меня
|
Data.ReadMe | string |
Текстовый файл в формате Base64, указывающий имя подписанного документа и исходного файла. |
|
Объединенный zip-файл
|
Data.CombinedZip | string |
Zip-файл, содержащий все документы конверта. |
|
Общее число
|
TotalCount | integer |
Общее число. |
|
Существуют ли отправки вложений
|
IsAttachmentUploadsExist | string |
Существуют ли отправки вложений. |
Получение сведений о шаблоне
Извлекает сведения о шаблоне или правиле на основе кода. Среди возвращаемых сведений — имя шаблона, документы и роли, определенные.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код шаблона
|
TemplateCode | True | string |
Код извлекаемого шаблона. |
|
Маркер проверки подлинности
|
AuthToken | True | string |
AuthToken, полученный из действия Get AuthToken. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код состояния
|
StatusCode | integer |
Код состояния ответа. |
|
Сообщение о состоянии
|
StatusMessage | string |
Сообщение о состоянии ответа. |
|
Message
|
Message | string |
Описание состояния ответа. |
|
Идентификатор шаблона
|
TemplateId | string |
Идентификатор шаблона. |
|
Идентификатор шаблона
|
TemplateBasicInfo.TemplateId | string |
Идентификатор шаблона. |
|
Код шаблона
|
TemplateBasicInfo.TemplateCode | integer |
Код шаблона для использования в других действиях. |
|
Электронная почта пользователя
|
TemplateBasicInfo.UserEmail | string |
Электронная почта владельца шаблона. |
|
Имя шаблона
|
TemplateBasicInfo.TemplateName | string |
Имя шаблона. |
|
Описание шаблона
|
TemplateBasicInfo.TemplateDescription | string |
Описание шаблона. |
|
Статический
|
TemplateBasicInfo.IsStatic | string |
Указывает, можно ли изменить шаблон. |
|
Дата окончания срока действия
|
TemplateBasicInfo.ExpiryDate | string |
Дата истечения срока действия шаблона. |
|
Дата создания
|
TemplateBasicInfo.CreatedDate | string |
Дата создания шаблона. |
|
"Дата последнего изменения";
|
TemplateBasicInfo.LastModifiedDate | string |
Дата последнего изменения шаблона. |
|
Тема
|
TemplateBasicInfo.Subject | string |
Тема шаблона электронной почты. |
|
Тело
|
TemplateBasicInfo.Body | string |
Текст шаблона электронной почты. HTML-кодирование. |
|
Имя типа
|
TemplateBasicInfo.TypeName | string |
Тип шаблона (возможные значения: шаблон, правило). |
|
Список документов
|
TemplateBasicInfo.DocumentList | array of object |
Список документов. |
|
Идентификатор документа
|
TemplateBasicInfo.DocumentList.DocumentId | string |
Идентификатор части документа шаблона. |
|
Имя документа
|
TemplateBasicInfo.DocumentList.DocumentName | string |
Имя части документа шаблона. |
|
Заказ
|
TemplateBasicInfo.DocumentList.Order | integer |
Порядок части документа шаблона в списке документов. |
|
Сведения о содержимом документа
|
TemplateBasicInfo.DocumentList.documentContentDetails | array of object |
Сведения о содержимом документа. |
|
Идентификатор элемента управления
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlID | string |
Внутренний идентификатор элемента управления, используемого в документе. |
|
Имя элемента управления
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlName | string |
Имя элемента управления, используемого в документе. |
|
Элемент управления HTML-идентификатор
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlHtmlID | string |
HTML-код элемента управления, используемого в документе. |
|
Имя группы
|
TemplateBasicInfo.DocumentList.documentContentDetails.GroupName | string |
Имя группы, содержащей элемент управления. |
|
Этикетка
|
TemplateBasicInfo.DocumentList.documentContentDetails.Label | string |
Имя элемента управления, отображаемого в документе. |
|
Страница No
|
TemplateBasicInfo.DocumentList.documentContentDetails.PageNo | integer |
Страница в документе, в котором находится элемент управления. |
|
Обязательно
|
TemplateBasicInfo.DocumentList.documentContentDetails.Required | boolean |
Указывает, является ли элемент управления обязательным или нет. |
|
Значение элемента управления
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlValue | string |
Предварительно заполненное значение элемента управления. |
|
Идентификатор роли
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleId | string |
Идентификатор роли, необходимой для заполнения элемента управления. |
|
Имя роли
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleName | string |
Имя роли, необходимой для заполнения элемента управления. |
|
Выбор параметров элемента управления
|
TemplateBasicInfo.DocumentList.documentContentDetails.SelectControlOptions | array of string |
Выберите "Параметры элемента управления". |
|
Список ролей шаблона
|
TemplateBasicInfo.TemplateRoleList | array of object |
Список получателей. |
|
Идентификатор роли
|
TemplateBasicInfo.TemplateRoleList.RoleID | string |
Идентификатор части роли этого шаблона. |
|
Имя роли
|
TemplateBasicInfo.TemplateRoleList.RoleName | string |
Имя части роли этого шаблона. |
|
Заказ
|
TemplateBasicInfo.TemplateRoleList.Order | integer |
Порядок, в котором роль (получатель) должна завершить шаблон. |
|
Электронная почта получателя
|
TemplateBasicInfo.TemplateRoleList.RecipientEmail | string |
Предварительно заполненное сообщение электронной почты получателя части этого шаблона. |
|
Имя получателя
|
TemplateBasicInfo.TemplateRoleList.RecipientName | string |
Предварительно заполненное имя получателя части этого шаблона. |
|
Идентификатор типа получателя
|
TemplateBasicInfo.TemplateRoleList.RecipientTypeID | string |
Внутренний идентификатор типа получателя. |
|
Код получателя
|
TemplateBasicInfo.TemplateRoleList.RecipientID | string |
Идентификатор получателя части этого шаблона. |
|
Тип получателя
|
TemplateBasicInfo.TemplateRoleList.RecipientType | string |
Тип получателя. |
|
Тип подписывателя cc
|
TemplateBasicInfo.TemplateRoleList.CcSignerType | string |
Тип получателя CC. |
|
Сведения о языке и региональных параметрах
|
TemplateBasicInfo.TemplateRoleList.CultureInfo | string |
Это язык службы пользователя на момент создания шаблона или правила. |
|
Режим доставки
|
TemplateBasicInfo.TemplateRoleList.DeliveryMode | integer |
Указывает канал, через который был отправлен запрос подписи и код доступа получателю. |
|
Код номера
|
TemplateBasicInfo.TemplateRoleList.DialCode | string |
Номер номера страны, в которой отправлен запрос подписи и код доступа. |
|
Код страны
|
TemplateBasicInfo.TemplateRoleList.CountryCode | string |
Код страны, в которой отправлен запрос подписи и код доступа. |
|
Номер мобильного устройства
|
TemplateBasicInfo.TemplateRoleList.Mobile | string |
Номер мобильного телефона получателя. |
|
Мобильный режим
|
TemplateBasicInfo.TemplateRoleList.MobileMode | integer |
Указывает мобильный канал, через который был отправлен запрос подписи и код доступа получателю. |
|
Электронная почта
|
TemplateBasicInfo.TemplateRoleList.EmailAddress | string |
Адрес электронной почты получателя. |
|
Включение сообщения для мобильных устройств
|
TemplateBasicInfo.EnableMessageToMobile | boolean |
Включите сообщение на мобильное устройство. |
|
Дата истечения срока действия статического канала
|
TemplateBasicInfo.StaticLinkExpiryDate | string |
Дата истечения срока действия статического канала. |
|
Список шаблонов
|
TemplateList | string |
Список шаблонов. |
Получение состояния конверта
Извлекает состояние конверта на основе кода конверта. Вы можете выбрать подробный или сводный отчет.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер проверки подлинности
|
AuthToken | True | string |
AuthToken, полученный из действия Get AuthToken. |
|
Конверткод
|
EnvelopeCode | True | string |
Код конверта. |
|
DetailOrSummary
|
DetailOrSummary | True | string |
Выберите нужный тип отчета. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Состояние
|
Status | boolean |
Состояние запроса. |
|
Код состояния
|
StatusCode | integer |
Код состояния ответа. |
|
Message
|
Message | string |
Описание состояния ответа. |
|
Сообщение о состоянии
|
StatusMessage | string |
Сообщение о состоянии ответа. |
|
Список данных конверта
|
Data | array of object | |
|
Код конверта
|
Data.EnvelopeCode | string |
Идентификатор конверта. |
|
Идентификатор конверта
|
Data.EnvelopeID | string |
Внутренний идентификатор конверта. |
|
Тема
|
Data.Subject | string |
Тема электронной почты конверта. |
|
Состояние конверта
|
Data.Status | string |
Состояние запрошенного конверта. |
|
IsEnvelopeComplete
|
Data.IsEnvelopeComplete | boolean |
Указывает, завершен ли конверт. |
|
Дата отправки
|
Data.SentDate | string |
Дата отправки конверта. |
|
LastModifiedDate
|
Data.LastModifiedDate | string |
Дата последнего изменения. |
|
SenderName
|
Data.SenderName | string |
Имя отправителя. |
|
SenderEmail
|
Data.SenderEmail | string |
Электронная почта отправителя. |
|
Сведения о получателе
|
Data.RecipientDetails | array of object | |
|
Код получателя
|
Data.RecipientDetails.RecipientID | string |
Идентификатор получателя части текущего конверта. |
|
Идентификатор типа получателя
|
Data.RecipientDetails.RecipientTypeID | string |
Идентификатор типа получателя части текущего конверта. |
|
Тип получателя
|
Data.RecipientDetails.RecipientType | string |
Тип получателя части текущего конверта. Возможные значения: Signer и Prefill. |
|
Имя получателя
|
Data.RecipientDetails.RecipientName | string |
Имя получателя. |
|
Адрес электронной почты
|
Data.RecipientDetails.Email | string |
Адрес электронной почты получателя. |
|
Заказ
|
Data.RecipientDetails.Order | integer |
Порядок, в котором получатель должен получить доступ к завершению конверта. |
|
StatusID
|
Data.RecipientDetails.StatusId | string |
Идентификатор состояния. |
|
Состояние подписи
|
Data.RecipientDetails.SigningStatus | string |
Состояние подписи получателя конверта. |
|
"Дата последнего изменения";
|
Data.RecipientDetails.LastModifiedDate | string |
Дата последнего изменения. |
|
Справочный код
|
Data.ReferenceCode | string |
Справочная часть кода текущего конверта. |
|
Справочные сообщения электронной почты
|
Data.ReferenceEmail | string |
Ссылка на электронную часть текущего конверта. |
|
TotalCount
|
TotalCount | integer |
Общее количество конвертов, соответствующих запрошенным критериям. |
|
IsAttachmentUploadsExist
|
IsAttachmentUploadsExist | string |
Существуют ли отправки вложений. |