Знак GMO
Соединитель подписей GMO помогает организациям подключаться к соглашениям и автоматизировать подготовку, подписание, выполнение действий и управление соглашениями.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| 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) |
| Контакт | |
|---|---|
| Имя | Глобальный знак GMO |
| URL | https://www.gmosign.com/ |
| Метаданные соединителя | |
|---|---|
| Publisher | GMO GlobalSign Holdings K.K. |
| Website | https://secure.gmosign.com/ |
| Политика конфиденциальности | https://www.gmogshd.com/privacy |
| Категории | Содержимое и файлы; Продуктивность |
Сведения о соединителе GMOSign
GMOSign — это высококлассная служба электронных контрактов.
"Соединитель подписи GMO" помогает организациям подключать и автоматизировать поток контрактов (подготовка, подписывание и управление соглашениями) в разделе "Знак GMO".
Предпосылки
Чтобы использовать этот соединитель, требуется допустимая учетная запись входа GMO с включенным параметром API.
Обратитесь в службу поддержки GMOSign для получения дополнительных сведений, так как необходимое приложение будет отличаться в зависимости от метода использования.
Получение учетных данных
Идентификатор клиента и закрытый ключ API будут учетными данными соединителя.
Чтобы получить учетные данные, обратитесь в службу поддержки GMO Sin и подписать планы API для PowerAutomate.
Начало работы с соединителем
Посетите центр справки GMOSign для сведений о соединителе Power Automate.
Поддерживаемые операции
Запрос подписи с помощью существующего шаблона —> создание запроса подписи с помощью существующего шаблона, доступного в подписке GMO.
Запрос подписи путем отправки новых документов —> создание запроса подписи путем отправки новых документов.
Создание перехватчика конверта —> создание перехватчика для конвертов, запрошенных для получения состояния подписи.
Получение подписанных документов —> получение подписанных документов, доступных в учетной записи подписывания GMO с помощью идентификатора документов.
Известные проблемы и ограничения
По состоянию на данный момент известные проблемы с этим соединителем отсутствуют.
Распространенные ошибки и средства устранения неполадок
Обратитесь к нам за любыми проблемами и их средствами правовой защиты.
Часто задаваемые вопросы
Посетите центр справки GMOSign
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Идентификатор клиента | securestring | Идентификатор клиента | True |
| Секретный ключ | securestring | Секретный ключ API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Запрос подписи конверта |
Запрос подписи конверта. |
| Отправка нового конверта с помощью указанного шаблона |
Отправьте новый конверт с помощью указанного шаблона. |
| Получение документов конверта |
Получение документов конверта. |
| Регистрация документа конверта |
Зарегистрируйте новый документ конверта. |
| Регистрация документа конверта для огромного размера |
Зарегистрируйте новый документ конверта. |
Запрос подписи конверта
Запрос подписи конверта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя конверта
|
envelope_name | True | string | |
|
Имя отправителя
|
sender_name | string | ||
|
Имя записи отправителя
|
sender_post_name | string | ||
|
Отправка почты компиляции
|
is_compilation_mail | integer | ||
|
Отправка веб-перехватчика
|
is_web_hook | integer | ||
|
Отскакивая почта заметки
|
bounced_note_mail | string | ||
|
Код документа
|
document_code | True | string | |
|
Имя документа
|
document_name | True | string | |
|
Начало текстовой точки x
|
fill_text_point_start_x | integer |
Если ввести текст заполнения, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Начало текстовой точки y
|
fill_text_point_start_y | integer |
Если ввести текст заполнения, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Конец текстовой точки x
|
fill_text_point_end_x | integer |
Если ввести текст заполнения, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Конец текстовой точки y
|
fill_text_point_end_y | integer |
Если ввести текст заполнения, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Страница нет
|
page_no | integer |
Если ввести текст заполнения, это необходимо. |
|
|
Размер шрифта
|
font_size | double | ||
|
Заливка текста
|
fill_text | string |
Если ввести текст заполнения, это необходимо. |
|
|
Начало текстовой точки x
|
date_text_point_start_x | integer |
Если ввести текст date, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Начало текстовой точки y
|
date_text_point_start_y | integer |
Если ввести текст date, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Конец текстовой точки x
|
date_text_point_end_x | integer |
Если ввести текст date, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Конец текстовой точки y
|
date_text_point_end_y | integer |
Если ввести текст date, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Страница нет
|
page_no | integer |
Если ввести текст Date, это необходимо. |
|
|
Размер шрифта
|
font_size | double | ||
|
Текст даты
|
date_text | string |
Если ввести текст Date, это необходимо. Необходимо ввести в формате YYYYmmdd. |
|
|
Тип флажка
|
check_box_type | string | ||
|
Флажок "Пуск x"
|
check_box_point_start_x | integer |
Если вы введете флажок, это обязательно и допускаются только целые числа от 0 до 100. |
|
|
Флажок "Точка начала y"
|
check_box_point_start_y | integer |
Если вы введете флажок, это обязательно и допускаются только целые числа от 0 до 100. |
|
|
Флажок end x
|
check_box_point_end_x | integer |
Если вы ввели флажок, это обязательно и разрешены только целые числа от 0 до 100. |
|
|
Конечная точка флажка y
|
check_box_point_end_y | integer |
Если вы ввели флажок, это обязательно и разрешены только целые числа от 0 до 100. |
|
|
Страница нет
|
page_no | integer |
Если ввести флажок, это необходимо. |
|
|
Заказ нет
|
order_no | string |
Если вы вводите список подписыватель дома, это необходимо. |
|
|
Или знак
|
is_or_sign | integer | ||
|
Тип знака
|
sign_type | integer |
Если вы вводите список подписыватель дома, это необходимо. |
|
|
Адрес электронной почты
|
string |
Если вы вводите список подписыватель дома, это необходимо. |
||
|
Комментарий
|
comment | string | ||
|
Код доступа
|
access_code | string |
Если задать sign_type "Тип печати контракта", это необязательно. |
|
|
Изменение подписи
|
is_signer_change | integer |
Если задать sign_type "Тип печати контракта", это необязательно. |
|
|
Вложенный файл
|
is_attached_file | integer |
Он доступен только в том случае, если вы зарегистрировались для параметра "Вложение изображения" и необязательно. |
|
|
Использование проверки формата лицензий драйверов
|
is_drivers_license_format_check_use | integer |
Он доступен и необязателен, только если вы зарегистрировались для параметра "Вложения изображения" и задайте тип подписи "Тип печати контракта". Его нельзя указать для каждого документа. Его нельзя сочетать с изменением signer и если задан тип запроса "Проверка документа, а не отправка". |
|
|
Отправка почты
|
is_send_mail | integer | ||
|
Отправка почты компиляции
|
is_compilation_mail | integer | ||
|
Language
|
language | string |
Если этот параметр не введен, примените языковой набор для исходной учетной записи. |
|
|
Подписыватель нет
|
signer_no | string |
Если ввести список документов конвертов для подписывающей стороны в доме, необходимо ввести тот же текст, что и сообщение электронной почты этого и соответствующего средства подписывания в доме. |
|
|
Код документа
|
document_code | string |
Если ввести список документов конвертов для подписывающей организации в доме, это необходимо. |
|
|
Тип запроса
|
request_type | string |
Если ввести список документов конвертов для подписывающей организации в доме, это необходимо. |
|
|
Присоединенный к документу файл
|
is_document_attached_file | integer | ||
|
Начало точки подписывания x
|
signing_text_point_start_x | integer |
Если вы вводите точки подписывания, это необходимо и допускаются только целые числа от 0 до 100 |
|
|
Начало точки подписывания y
|
signing_text_point_start_y | integer |
Если вы вводите точки подписывания, это необходимо и допускаются только целые числа от 0 до 100 |
|
|
Точка подписывания x
|
signing_text_point_end_x | integer |
Если вы вводите точки подписывания, это необходимо и допускаются только целые числа от 0 до 100 |
|
|
Точка подписывания y
|
signing_text_point_end_y | integer |
Если вы вводите точки подписывания, это необходимо и допускаются только целые числа от 0 до 100 |
|
|
Страница нет
|
page_no | integer |
Если вы вводите точки подписывания, это необходимо |
|
|
Тег
|
tag | string | ||
|
Обязательно
|
is_required | string | ||
|
Начало текстовой точки x
|
free_text_point_start_x | integer |
Если ввести бесплатную текстовую точку, это необходимо и разрешено только целые числа от 0 до 100 |
|
|
Начало текстовой точки y
|
free_text_point_start_y | integer |
Если ввести бесплатную текстовую точку, это необходимо и разрешено только целые числа от 0 до 100 |
|
|
Конец текстовой точки x
|
free_text_point_end_x | integer |
Если ввести бесплатную текстовую точку, это необходимо и разрешено только целые числа от 0 до 100 |
|
|
Конец текстовой точки y
|
free_text_point_end_y | integer |
Если ввести бесплатную текстовую точку, это необходимо и разрешено только целые числа от 0 до 100 |
|
|
Страница нет
|
page_no | integer |
Если ввести бесплатную текстовую точку, это необходимо |
|
|
Размер шрифта
|
font_size | double | ||
|
Текст заполнителя
|
placeholder_text | string | ||
|
Тег
|
tag | string | ||
|
Обязательно
|
is_required | string | ||
|
Начало текстовой точки x
|
date_text_point_start_x | integer |
Если ввести текстовую точку даты, это необходимо, и допускаются только целые числа из 0–100. |
|
|
Начало текстовой точки y
|
date_text_point_start_y | integer |
Если ввести текстовую точку даты, это необходимо, и допускаются только целые числа из 0–100. |
|
|
Конец текстовой точки x
|
date_text_point_end_x | integer |
Если ввести текстовую точку даты, это необходимо, и допускаются только целые числа из 0–100. |
|
|
Конец текстовой точки y
|
date_text_point_end_y | integer |
Если ввести текстовую точку даты, это необходимо, и допускаются только целые числа из 0–100. |
|
|
Страница нет
|
page_no | integer |
Если ввести текстовую точку даты, это необходимо |
|
|
Размер шрифта
|
font_size | double | ||
|
Текст заполнителя
|
placeholder_text | string | ||
|
Тег
|
tag | string | ||
|
Тип флажка
|
check_box_type | string |
Если ввести флажок, это необходимо |
|
|
Флажок "Пуск x"
|
check_box_point_start_x | integer |
Если вы вводите флажок, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Флажок "Точка начала y"
|
check_box_point_start_y | integer |
Если вы вводите флажок, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Флажок end x
|
check_box_point_end_x | integer |
Разрешены только целые числа от 0 до 100 |
|
|
Конечная точка флажка y
|
check_box_point_end_y | integer |
Если вы вводите флажок, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Страница нет
|
page_no | integer |
Если вы вводите флажок, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Заказ нет
|
order_no | string | ||
|
Или знак
|
is_or_sign | integer | ||
|
Тип знака
|
sign_type | integer |
Если ввести список подписывания партнера, это необходимо. |
|
|
Имя подписывющего элемента
|
name | string |
Если ввести список подписывания партнера, это необходимо. |
|
|
Упорядочение имени
|
organize_name | string | ||
|
Адрес электронной почты
|
string |
Ваш адрес электронной почты или номер телефона (возможно, если вы используете параметр отправки SMS) является обязательным. |
||
|
Номер телефона
|
phone_number | string |
Ваш адрес электронной почты или номер телефона (возможно, если вы используете параметр отправки SMS) является обязательным. |
|
|
Дата разрешения телефона
|
phone_permit_date | string | ||
|
attendant_email
|
attendant_email | string |
Если вы задали тип подписи "Подпись в человеке", это необходимо. |
|
|
Комментарий
|
comment | string | ||
|
Код доступа
|
access_code | string |
Если вы задаете тип подписи "Подпись в человеке, тип печати контракта", это можно указать. |
|
|
Изменение подписи
|
is_signer_change | integer | ||
|
Вложенный файл
|
is_attached_file | integer |
Он доступен только в том случае, если вы зарегистрировались для параметра "Вложение изображения". Если в единицах документов существует спецификация, она имеет приоритет. (Если задать тип подписи "Подпись пользователя" и тип запроса "Проверка документа", он считается "1".) |
|
|
Использование проверки формата лицензий драйверов
|
is_drivers_license_format_check_use | integer |
Он доступен и необязателен, только если вы зарегистрировались для параметра "Вложения изображения" и задайте тип подписи "Тип печати контракта". Его нельзя указать для каждого документа. Его нельзя сочетать с изменением signer и если задан тип запроса "Проверка документа, а не отправка". |
|
|
Отправка почты
|
is_send_mail | integer | ||
|
Отправка почты компиляции
|
is_compilation_mail | integer | ||
|
Language
|
language | string |
Если этот параметр не введен, примените языковой набор для исходной учетной записи. |
|
|
Тип оплаты
|
payment_type | integer |
Он доступен только в том случае, если вы зарегистрировались для параметра оплаты и является необязательным. |
|
|
Плата (JPN Yen)
|
amount | string |
Если вы устанавливаете тип оплаты "Каждый раз, регулярно", это необходимо. |
|
|
Description
|
description | string | ||
|
Начало года оплаты
|
subscription_start_year | string |
Если вы устанавливаете тип оплаты "Регулярно", это необходимо. |
|
|
Начало месяца оплаты
|
subscription_start_month | string |
Если вы устанавливаете тип оплаты "Регулярно", это необходимо. |
|
|
День начала оплаты
|
subscription_sale_date | string |
Если вы устанавливаете тип оплаты "Регулярно", это необходимо. |
|
|
Подписыватель нет
|
signer_no | string |
Если ввести список документов для подписывающего партнера, необходимо ввести тот же текст, что и адрес электронной почты или номер телефона, и соответствующий подписыватель партнера. |
|
|
Код документа
|
document_code | string |
Если ввести список документов для подписывания партнера, это необходимо. |
|
|
Тип запроса
|
request_type | string |
Если ввести список документов для подписывания партнера, это необходимо. |
|
|
Присоединенный к документу файл
|
is_document_attached_file | integer | ||
|
Начало точки подписывания x
|
signing_text_point_start_x | integer |
Если вы вводите точки подписывания, это необходимо и допускаются только целые числа от 0 до 100 |
|
|
Начало точки подписывания y
|
signing_text_point_start_y | integer |
Если вы вводите точки подписывания, это необходимо и допускаются только целые числа от 0 до 100 |
|
|
Точка подписывания x
|
signing_text_point_end_x | integer |
Если вы вводите точки подписывания, это необходимо и допускаются только целые числа от 0 до 100 |
|
|
Точка подписывания y
|
signing_text_point_end_y | integer |
Если вы вводите точки подписывания, это необходимо и допускаются только целые числа от 0 до 100 |
|
|
Страница нет
|
page_no | integer |
Если вы вводите точки подписывания, это необходимо |
|
|
Тег
|
tag | string | ||
|
Обязательно
|
is_required | string | ||
|
Начало текстовой точки x
|
free_text_point_start_x | integer |
Если ввести бесплатную текстовую точку, это необходимо и разрешено только целые числа от 0 до 100 |
|
|
Начало текстовой точки y
|
free_text_point_start_y | integer |
Если ввести бесплатную текстовую точку, это необходимо и разрешено только целые числа от 0 до 100 |
|
|
Конец текстовой точки x
|
free_text_point_end_x | integer |
Если ввести бесплатную текстовую точку, это необходимо и разрешено только целые числа от 0 до 100 |
|
|
Конец текстовой точки y
|
free_text_point_end_y | integer |
Если ввести бесплатную текстовую точку, это необходимо и разрешено только целые числа от 0 до 100 |
|
|
Страница нет
|
page_no | integer |
Если ввести бесплатную текстовую точку, это необходимо |
|
|
Размер шрифта
|
font_size | double | ||
|
Текст заполнителя
|
placeholder_text | string | ||
|
Тег
|
tag | string | ||
|
Обязательно
|
is_required | string |
Если ввести текстовую точку даты, это необходимо |
|
|
Начало текстовой точки x
|
date_text_point_start_x | integer |
Если ввести текстовую точку даты, это необходимо, и допускаются только целые числа из 0–100. |
|
|
Начало текстовой точки y
|
date_text_point_start_y | integer |
Если ввести текстовую точку даты, это необходимо, и допускаются только целые числа из 0–100. |
|
|
Конец текстовой точки x
|
date_text_point_end_x | integer |
Если ввести текстовую точку даты, это необходимо, и допускаются только целые числа из 0–100. |
|
|
Конец текстовой точки y
|
date_text_point_end_y | integer |
Если ввести текстовую точку даты, это необходимо, и допускаются только целые числа из 0–100. |
|
|
Страница нет
|
page_no | integer |
Если ввести текстовую точку даты, это необходимо |
|
|
Размер шрифта
|
font_size | double | ||
|
Текст заполнителя
|
placeholder_text | string | ||
|
Тег
|
tag | string | ||
|
Тип флажка
|
check_box_type | string |
Если ввести флажок, это необходимо |
|
|
Флажок "Пуск x"
|
check_box_point_start_x | integer |
Если вы вводите флажок, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Флажок "Точка начала y"
|
check_box_point_start_y | integer |
Если вы вводите флажок, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Флажок end x
|
check_box_point_end_x | integer |
Разрешены только целые числа от 0 до 100 |
|
|
Конечная точка флажка y
|
check_box_point_end_y | integer |
Если вы вводите флажок, это обязательно и разрешено только целые числа от 0 до 100. |
|
|
Страница нет
|
page_no | integer |
Если ввести флажок, это необходимо |
|
|
Идентификатор папки
|
folder_id | integer | ||
|
Заказ нет
|
order_no | integer |
Если вы назначите утверждающего, это необходимо. |
|
|
Имя
|
name | string |
Если вы назначите утверждающего, это необходимо. |
|
|
Имя записи
|
post_name | string | ||
|
Адрес электронной почты
|
string |
Если вы назначите утверждающего, это необходимо. |
||
|
Комментарий рабочего процесса
|
workflow_comment | string | ||
|
Имя
|
name | string |
Если вы назначите получателя, это необходимо. |
|
|
Упорядочение имени
|
organize_name | string | ||
|
Адрес электронной почты
|
string |
Если вы назначите получателя, ваш адрес электронной почты или номер телефона SMS (возможно, если вы используете параметр отправки SMS) является обязательным. |
||
|
Номер телефона
|
phone_number | string |
Если вы назначите получателя, ваш адрес электронной почты или номер телефона SMS (возможно, если вы используете параметр отправки SMS) является обязательным. |
|
|
Дата разрешения телефона
|
phone_permit_date | string | ||
|
Комментарий
|
comment | string | ||
|
Language
|
language | string |
Если этот параметр не введен, примените языковой набор для исходной учетной записи. |
Возвращаемое значение
Отправка нового конверта с помощью указанного шаблона
Отправьте новый конверт с помощью указанного шаблона.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ИД шаблона
|
templateId | True | string |
Идентификатор шаблона |
|
Имя конверта
|
envelope_name | True | string | |
|
Имя отправителя
|
sender_name | string | ||
|
Имя отдела отправителя
|
sender_post_name | string | ||
|
Уведомление о завершении подписи
|
is_compliation_mail | integer |
отправка сообщения электронной почты уведомления о завершении отправителю |
|
|
Триггер
|
is_web_hook | True | integer |
Запуск триггера PowerAutomate при завершении подписи |
|
Назначение уведомления об ошибке отправки электронной почты
|
bounced_note_mail | string | ||
|
порядок утверждения
|
order_no | string | ||
|
Утверждающий
|
name | string | ||
|
Принадлежность утверждающего
|
post_name | string | ||
|
Адрес электронной почты
|
string | |||
|
Комментарий утверждения
|
work_flow_comment | string | ||
|
Тип подписыватель
|
signer_type | True | integer | |
|
Использование шаблона
|
use_template | integer |
Следует ли использовать подписыватель, зарегистрированный в шаблоне |
|
|
Порядок подписывителей
|
order_no | string | ||
|
Тип подписи
|
sign_type | True | integer | |
|
Имя подписывющего элемента
|
name | string | ||
|
Принадлежность подписывателя
|
organize_name | string | ||
|
Адрес электронной почты
|
string | |||
|
Comments
|
comment | string | ||
|
Код доступа
|
access_code | string | ||
|
изменение центра
|
is_signer_change | integer |
Разрешить получателю изменять подписыватель? |
|
|
Присоединенное изображение
|
is_attached_file | integer |
Разрешить подписывшему присоединению изображения знака? |
|
|
Отправка сообщения электронной почты
|
is_send_mail | integer |
Отправка сообщения электронной почты запроса подписи в средство подписи |
|
|
Язык электронной почты
|
language | string | ||
|
Тип оплаты
|
payment_type | integer |
Выбор типа оплаты |
|
|
Плата (JPN Yen)
|
amount | string | ||
|
Description
|
description | string | ||
|
Начало года оплаты
|
subscription_start_year | string | ||
|
Начало месяца оплаты
|
subscription_start_month | string | ||
|
День начала оплаты
|
subscription_start_date | string | ||
|
Приёмник
|
name | string | ||
|
Принадлежность получателя
|
organize_name | string | ||
|
Адрес электронной почты
|
string | |||
|
Кометы
|
comment | string | ||
|
Язык электронной почты
|
language | string | ||
|
Имя элемента слияния
|
name | string | ||
|
Значение элемента слияния
|
value | string |
Возвращаемое значение
- Тело
- SendEnvelopeResponse
Получение документов конверта
Получение документов конверта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
documentId | True | string |
Идентификатор документа |
Возвращаемое значение
- Тело
- GetDocumentsResponse
Регистрация документа конверта
Зарегистрируйте новый документ конверта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Документ
|
document | True | binary |
Файлы, полученные из SharePoint или OneDrive. |
|
Код документа
|
document_code | string | ||
|
Повторное использование флага
|
reuse_flag | integer | ||
|
Замечания
|
remarks | string |
Возвращаемое значение
Регистрация документа конверта для огромного размера
Зарегистрируйте новый документ конверта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Путь к файлу
|
file_path | True | string |
Путь к файлу после имени файла /input/на сервере SFTP. В AWS S3 конфигурация — s3://(имя контейнера)/(имя пользователя)/input/(имя файла)". |
|
Код документа
|
document_code | string | ||
|
Повторное использование флага
|
reuse_flag | integer | ||
|
Замечания
|
remarks | string |
Возвращаемое значение
Триггеры
| При изменении состояния конверта (подключение) |
Активирует новый поток при изменении состояния конверта. |
При изменении состояния конверта (подключение)
Активирует новый поток при изменении состояния конверта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Заголовок подключения
|
name | True | string |
Возвращаемое значение
Определения
WebhookEnvelopeResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Список документов
|
document_list | array of object | |
|
Идентификатор документа
|
document_list.documentId | string | |
|
Имя документа
|
document_list.document_name | string | |
|
Имя конверта
|
envelope_name | string | |
|
Идентификатор транзакции конверта
|
envelope_xid | string |
GetDocumentsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Скачан документ
|
downloadedDocument | byte |
RegisterDocumentResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Состояние
|
status | string |
Состояние ответа |
|
Result
|
result | string |
Результат ответа |
|
Message
|
message | string |
ответное сообщение |
|
DocumentCode
|
document_code | string |
код документа |
RegisterDocumentForHugeSizeResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Состояние
|
status | string |
Состояние ответа |
|
Result
|
result | string |
Результат ответа |
|
Message
|
message | string |
ответное сообщение |
|
DocumentCode
|
document_code | string |
код документа |
RequestSignatureResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Состояние
|
status | string |
Состояние ответа |
|
Result
|
result | string |
Результат ответа |
|
Message
|
message | string |
ответное сообщение |
|
Идентификатор транзакции конверта
|
envelope_xid | string |
envelope_xid |
|
Список документов
|
document_list | array of document |
SendEnvelopeResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор транзакции конверта
|
envelope_xid | string |
Идентификатор транзакции конверта |
|
Состояние конверта
|
envelope_status | string |
Состояние конверта. |
|
Список документов
|
document_list | array of document | |
|
Список подписывания
|
signer_list | array of resSigner |
документ
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя документа
|
document_name | string | |
|
Идентификатор документа
|
control_number | string |
resSigner
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Порядок подписывания
|
order_no | string | |
|
Имя подписывющего элемента
|
name | string | |
|
Принадлежность подписывателя
|
organize_name | string | |
|
Адрес электронной почты
|
string | ||
|
Тель.
|
phone_number | string | |
|
Идентификатор подписывающей оболочки
|
envelope_signer_id | string | |
|
Токен подписывания конверта
|
envelope_sign_token | string | |
|
Состояние подписи
|
sign_status | string |