Просмотр деталей шаблона конверта

GET /esignglobal/v1/envelopeTemplates/envelopeTemplateDetail

Описание интерфейса

Запрос подробных атрибутов «шаблона конверта», предварительно настроенного на клиентской стороне (включает структуру файла, роли участников и идентификаторы всех предустановленных элементов управления Key).

Параметры запроса

Имя параметра

Тип

Обязательный

Описание

envelopeTemplateId

string

true

ID шаблона конверта

queryComponents

boolean

false

Необходимо ли запрашивать информацию об элементах управления, по умолчанию false

true — да

false — нет

Пример запроса

 {
 	"envelopeTemplateId":"dc4be9641a3145bea97809018d7a9180",
 	"queryComponents":true
 }

Параметры ответа

Имя параметра					Тип	Описание
code					int	Код операции: 0 означает успешное выполнение, любое другое значение указывает на ошибку.
message					string	Информация об операции Пожалуйста, определяйте статус ошибки по code, не следует полагаться на совпадение message, так как message может быть изменён.
data					object	Данные операции
	envelopeTemplateId				string	Идентификатор шаблона конверта
	envelopeTemplateName				string	Название шаблона процесса
	envelopeTemplateStatus				int	Статус активности шаблона процесса 1 — Включено 0 — Отключено
	digitalSignature				boolean	Включить цифровую подпись true — Включено false — Выключено
	signFiles				array	Информация о файле
		documentId			string	Идентификатор файла
		fileName			string	Название файла
	participants				array	Участник
		participantId			string	ID участника
		participantSetMode			string	Требования к участию (способ указания участника) presetSigner-указывается при использовании шаблона (определяется пользователем шаблона) dedicateSigner-фиксированный участник (жестко задан в шаблоне, не подлежит изменению) sender-инициатор
		participantInfos			object	Участник-физическое лицо
			userEmail		string	Электронная почта подписанта
			phoneNumber		object	Номер телефона, по умолчанию пустое значение Обязательный параметр при необходимости отправки SMS-уведомлений, необходимо передать countryCode и number
				countryCode	string	Международный код страны или региона, знак «+» указывать не нужно
				number	string	Проверка формата отсутствует, максимальная длина ограничена 13 символами
			userName		string	Имя физического лица
			deliveryMethod		string	Способ уведомления auto-при указании userEmail отправляется уведомление по электронной почте, при указании phoneNumber — SMS-уведомление none-не отправлять уведомления email-отправлять уведомления по электронной почте sms-отправлять SMS-уведомления WhatsApp-отправлять уведомления через WhatsApp
			customizeSettings		object	пользовательские настройки
				customizeMessage	string	персональное сообщение максимум 1000 символов
				notificationLanguage	string	язык уведомлений, по умолчанию английский en-US английский zh-CN упрощённый китайский zh-Hant традиционный китайский ja японский es-MX испанский pt-PT португальский th-TH тайский язык id-ID индонезийский язык vi-VN вьетнамский язык ms-MY малайский язык fil-PH филиппинский язык de-DE немецкий язык fr-FR французский язык ru-RU русский язык it-IT итальянский язык ko-KR корейский язык
		signOrder			int	Порядок подписания 1-255, допускается повторение для разных участников
		willingnessAuthModes			string	Способ подтверждения намерения подписанта, разделяйте английской запятой noAuth-без проверки accessCode-проверка по паролю подписания sms-SMS OTP проверка idVerification-проверка удостоверения личности emailAuth-проверка OTP по электронной почте digitalId-электронная верификация личности whatsappAuth-проверка OTP через WhatsApp
			accessCode		object	Настройка пароля подписи, обязательно при authModes=accessCode
				accessCode	string	Значение пароля, регистр не учитывается, может содержать буквы и цифры, ограничение длины 45
				promptInfo	string	Подсказка для пароля доступа, не должна содержать сам пароль, ограничение длины 30, обязательно при authModes=1.
			sms		object	Проверка SMS OTP, обязательно при authModes=sms
				countryCode	string	Международный код страны или региона, символ «+» указывать не нужно
				number	string	Проверка формата не выполняется, максимальная длина ограничена 13 символами
			idVerification		object	Настройки проверки удостоверения личности, обязательно при authModes=idVerification
				name	string	Полное имя в документе, удостоверяющем личность подписанта, максимальная длина 100 символов
			emailAuth		object	Проверка OTP по электронной почте, обязательно при authModes=emailAuth
				authEmail	string	Адрес электронной почты для верификации подписанта
			digitalId		array	Электронная аутентификация, обязательно при authModes=digitalId
				authApp	string	Приложение для электронной аутентификации singpass — аутентификация с помощью Singpass iamsmart — аутентификация с помощью IAM Smart
				idNumber	string	Номер удостоверения личности подписанта, подлежащий проверке
			whatsappAuth		object	Проверка OTP через WhatsApp, обязательно при authModes=whatsappAuth
				countryCode	string	Международный код страны или региона, символ "+" указывать не нужно
				number	string	Проверка формата не выполняется, максимальная длина — 13 символов
		components			object	Информация об элементе управления
	copiers				array	Настройка получателя копии
		copierId			string	ID участника
		editable			boolean	Разрешить изменение при инициировании
		CCInfos			object	Информация о получателе копии
			userEmail		string	Электронная почта
			userName		string	Имя физического лица
			customizeSettings		object	Пользовательская конфигурация
				notificationSettings	object	Пользовательская конфигурация уведомлений
				notificationLanguage	string	Язык уведомлений, по умолчанию английский en-US Английский zh-CN Упрощенный китайский zh-Hant Традиционный китайский ja Японский ES-MX Испанский
	attachments				array	Информация о вложении
		editable			boolean	Разрешить изменение при создании
		fileKey			string	filekey вложения
		fileName			string	Название вложения
		downloadUrl			string	Ссылка для скачивания PDF-черновика документа, действительна в течение 60 минут.
components					array	Список элементов управления
	documentId				string	Ключ файла элемента управления
	componentId				string	Идентификатор элемента управления
	componentKey				string	Ключ элемента управления (идентификатор, задаваемый пользователем при настройке шаблона документа)
	componentName				string	Название элемента управления
	componentType				string	Тип элемента управления 1, Текст 2, Число 3, Дата 6, Область стандартной подписи 8, Многострочный текст 9, Чекбокс 10, Радиокнопка 11, Изображение 14, Выпадающий список 15, Флажок 20，Область для штампа 21, Зона утверждения 22, Дата подписания 23, Электронная почта 100, Китайский юань
	componentDefaultValue				string	Значение по умолчанию элемента управления
	componentPosition				object	Положение элемента управления
		componentPositionX			float	Горизонтальная координата положения элемента управления
		componentPositionY			float	Вертикальная координата положения элемента управления
		componentPageNum			int	Номер страницы расположения элемента управления
	componentSize				object	Размеры элемента управления
		componentWidth			int	Ширина элемента управления (расстояние между левой и правой границами прямоугольника, в пикселях)
		componentHeight			int	Высота элемента управления (расстояние между верхней и нижней границами прямоугольника, в пикселях)
	componentTextFormat				object	Стиль шрифта элемента управления
		font			int	Шрифт заполнения, по умолчанию 1, 1-Сун, 2-Новый Сун, 4-Хэйти, 5-Кайти
		fontSize			float	Размер шрифта заполнения, по умолчанию 12-小四 42-初号 36-小初 26-一号 24-小一 22-二号 19-小二 16-三号 15-小三 14-四号 12-小四 10.5-五号 9-小五
		textColor			string	Цвет шрифта, по умолчанию #000000 черный
		bold			boolean	Жирный шрифт, по умолчанию false true-Да false-Нет
		italic			boolean	Курсив, по умолчанию false true-Да false-Нет
		horizontalAlignment			string	Горизонтальное выравнивание, по умолчанию 1-по левому краю LEFT-по левому краю CENTER-по центру RIGHT-по правому краю
		verticalAlignment			string	Вертикальное выравнивание, по умолчанию 1-по верхнему краю (для многострочного текста) TOP-по верхнему краю MIDDLE-по центру BOTTOM-по нижнему краю
		textLineSpacing			float	Межстрочный интервал, по умолчанию 1.0, допускается только одна цифра после запятой, максимальное значение 2.0 (для многострочного текста)
	required				boolean	Обязательное поле true - обязательное false - необязательное
	componentMaxLength				string	Максимальная длина заполнения элемента управления (количество китайских символов)
	componentSpecialAttribute				object	Специфические свойства элемента управления
		numberFormat			string	Формат числа (числовой элемент управления) Целое число: 0 Один знак после запятой: 0.0 Два знака после запятой: 0.00
		dateFormat			string	Формат даты (элемент управления датой)
		imageType			string	Тип изображения (элемент управления изображением) IDCard_widthwise удостоверение личности горизонтальное сохранение пропорций IDCard_longitudinal удостоверение личности вертикальное сохранение пропорций other прочее без сохранения пропорций
		options			array	Варианты (выпадающий список, радиокнопка, флажок)
			optionOrder		int	Порядок вариантов
			optionContent		string	Текст опции
			selected		boolean	Выбрано по умолчанию
			optionPositionX		float	Координата X дочернего элемента относительно рамки родительского контрола
			optionPositionY		float	Координата Y дочернего элемента относительно рамки родительского контрола
			optionWidth		float	Ширина дочернего элемента
			optionHeight		float	Высота дочернего элемента
	signField				object	Свойства стандартной зоны подписи и печати
		fieldStyle			int32	Стиль зоны подписи и печати 1-Зона подписи и печати на одной странице 2-Зона подписи и печати на стыке страниц
		sizeRule			int	Размеры печати 1-Нанесение печати по фактическим размерам 2-Пользовательские размеры (адаптируются под ширину и высоту зоны подписания)
		movable			boolean	true-Можно перемещать при подписании false-Нельзя перемещать при подписании
	stampField				object	Свойства области печати
		fieldStyle			int	Оформление области подписи 1-Область подписи на одной странице 2-Область подписи на стыке страниц
		sizeRule			int	Размеры печати 1-Наносить печать согласно фактическим размерам 2-Пользовательские размеры (адаптируются по ширине и высоте области подписи)
		movable			boolean	true-Можно перемещать при подписании false-Нельзя перемещать при подписании
	signDateField				object	Параметры даты подписания
		dateFormat			string	Формат даты: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	approvalField				object	Параметры области согласования
		allowedOptions			array	Опции, разрешающие подписанту выполнять согласование, применяется при fieldType=approval. По умолчанию ["approve", "decline"] approve-Согласовать decline-отказ

Пример ответа

{
  "code": "0",
  "data": {
    "envelopeTemplateName": "test",
    "signFiles": [
      {
        "fileDownloadUrl": "https://******",
        "fileName": "***.pdf",
        "documentId": "$eac****-d6f8-4b6b-bafe-******$3328404894"
      }
    ],
    "attachments": [],
    "digitalSignature": false,
    "envelopeTemplateStatus": 1,
    "independentComponents": [],
    "envelopeCategoryId": null,
    "envelopeTemplateId": "dc4be9641a3145bea97809018d7a9180",
    "participants": [
      {
        "participantFlag": "",
        "idVerification": null,
        "components": [
          {
            "componentType": "10",
            "componentId": "556b60f7bd324428908b41f3bbec8c54",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 485.42538,
              "componentPositionX": 35.96627,
              "componentPageNum": "1"
            },
            "componentSpecialAttribute": {
              "options": [
                {
                  "optionContent": "***",
                  "optionHeight": 32.923893,
                  "optionOrder": 0,
                  "optionPositionY": 85.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项二",
                  "optionHeight": 15.0,
                  "optionOrder": 1,
                  "optionPositionY": 60.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项三",
                  "optionHeight": 15.0,
                  "optionOrder": 2,
                  "optionPositionY": 35.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项四",
                  "optionHeight": 15.0,
                  "optionOrder": 3,
                  "optionPositionY": 10.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                }
              ],
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 128,
              "componentWidth": 144
            },
            "signDateField": null,
            "required": true,
            "stampField": null,
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "单选1",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          },
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "****",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "42750b92c7a***05134dd5342",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "presetSigner",
        "emailAuth": null
      },
      {
        "participantFlag": "***",
        "idVerification": null,
        "components": [
          {
            "componentType": "20",
            "componentId": "7c401b43cdc94b61a7813aa58ac82bbf",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 327.15793,
              "componentPositionX": 109.17395,
              "componentPageNum": "2"
            },
            "componentSpecialAttribute": {
              "options": null,
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 150,
              "componentWidth": 150
            },
            "signDateField": null,
            "required": true,
            "stampField": {
              "movable": false,
              "sizeRule": 1,
              "fieldStyle": 1
            },
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "图章区",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          }
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "***",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "b055dfce00c5******40cdabb23822ea4",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "dedicateSigner",
        "emailAuth": null
      }
    ],
    "copiers": []
  },
  "message": "SUCCESS"
}