Быстро создать конверт

POST /esignglobal/v1/envelope/createAndStart

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

Быстрый запуск конверта, включающий создание конверта, добавление документов для подписи, добавление подписантов и т. д.

Поддержка автоматического запуска：После успешного вызова интерфейса конверт успешно создается и запускается, и в это время конверт автоматически начинает циркулировать.
Поддержка автоматического завершения：После того, как все подписавшие стороны завершат подписание, конверт автоматически закрывается.

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

Название параметра					Тип	Обязательно	Описание
subject					string	true	Тема конверта Пример: «Offer Letter»
remark					string	false	Примечания к конверту，Ограничение длины 1000 символов
signerSettings					object	false	Действия, разрешенные для подписывающего лица
	allowTransfer				boolean	false	Разрешено ли подписывающему лицу передавать этот конверт другим лицам для подписания, по умолчанию false true - разрешает подписывающему лицу в конверте иметь право передавать конверт другим лицам; false - не разрешает подписывающему лицу в конверте иметь право передавать конверт другим лицам;
	allowModifyName				boolean	false	Разрешено ли подписывающей стороне изменять имя, действует только для подписи шаблона, по умолчанию false true - разрешить подписывающему лицу изменить имя false - не разрешать подписывающему лицу изменять имя
expireAfterSeconds					long	false	Время истечения срока действия конверта, через сколько секунд истекает срок действия конверта Диапазон истечения срока действия: 86 400 секунд (1 день) ~ 7 776 000 секунд (90 дней)
redirectUrl					string	false	Должен быть действительным https-адресом
callBackUrl					string	false	Адрес обратного вызова (длина 500), должен соответствовать адресу протокола https.
sendLaterAfterSeconds					long	false	Поддержка отложенной отправки пользователем, в секундах Поддерживаемый диапазон времени: 3600 секунд (1 час) ~ 259200 секунд (30 дней)
CCInfos					array	false	Коллекция информации о получателях копий
	userEmail				string	false	Адрес электронной почты получателя копии
	userName				string	false	Имя получателя копии, которое будет отображаться на странице подписи и в конверте. 【Внимание】: Не должно содержать следующие 9 специальных символов: / \ : * " < > \| ？и все эмодзи
	customizeSettings				object	false	Пользовательская конфигурация
		notificationSettings			object	false	Пользовательская конфигурация уведомлений
			notificationLanguage		string	false	Язык уведомлений, по умолчанию берется конфигурация «Язык уведомлений по умолчанию» en-US Английский zh-CN Упрощенный китайский zh-Hant Традиционный китайский ja-JP Японский es-MX Испанский pt-PT Португальский th-TH Тайский id-ID Индонезийский vi-VN Вьетнамский ms-MY Малайский fil-PH Филиппинский de-DE Немецкий fr-FR Французский ru-RU Русский it-IT Итальянский ko-KR Корейский
signFiles					array	true	Коллекция информации о подписанных файлах, порядок отображения соответствует порядку добавления файлов.
	fileKey				string	true	FileKey подписанного файла, поддерживается только формат PDF
attachments					array	false	Коллекция вложений конверта, порядок отображения соответствует порядку добавления файлов.
	fileKey				string	false	FileKey файла
signerInfos					array	true	Коллекция информации о подписантах
	businessId				string	false	Определяемый разработчиком номер бизнес-операции, ограничение по длине 500
	deliveryMethods				string	false	Способ уведомления, по умолчанию auto auto- При передаче userEmail отправляется уведомление по электронной почте, при передаче phoneNumber отправляется SMS-уведомление none- Не отправлять уведомления email- Отправить уведомление по электронной почте sms- Отправить SMS-уведомление WhatsApp- Отправить уведомление WhatsApp
	userEmail				string	false	Адрес электронной почты подписавшего
	userName				string	true	Имя подписавшего, используется для отображения имени подписавшего на странице подписи и в конверте. 【Примечание】Не может содержать следующие 9 специальных символов: / \ : * " < > \| ？и все смайлики emoji
	phoneNumber				object	false	Номер телефона, по умолчанию пустой Обязательный параметр при необходимости отправки SMS-уведомлений, необходимо передать countryCode и number
		countryCode			string	false	Международный код страны/региона, не нужно передавать “+”
		number			string	false	Нет проверки формата, только ограничение максимальной длины в 13 символов
	customizeSettings				object	false	Пользовательская конфигурация
		notificationSettings			object	false	Пользовательская конфигурация класса уведомлений
			customizeMessage		string	false	Эксклюзивное уведомление о сообщении, ограничение в 200 символов
			notificationLanguage		string	false	Язык уведомлений, по умолчанию берется конфигурация «Язык уведомлений по умолчанию» en-US Английский zh-CN Упрощенный китайский zh-Hant Традиционный китайский ja-JP Японский 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	true	Порядок подписи подписантов, минимум 1. Для неупорядоченной подписи можно указать одинаковое значение порядка.
	anySigner				boolean	false	Поддерживается ли подпись любого из участников, по умолчанию false true-Для одного и того же signOrder достаточно подписи только одного человека false-Все участники одного и того же signOrder должны подписать
	authModes				string	false	Метод проверки, по умолчанию noAuth noAuth-Не проверять accessCode-Использовать проверку пароля подписи sms-SMS OTP проверка idVerification-Проверка удостоверения личности emailAuth-Email OTP проверка digitalId-Электронная идентификационная проверка whatsappAuth-WhatsApp OTP проверка
	authConfig				object	false	Настройки метода проверки
		accessCode			object	false	Настройка пароля подписи, когда authModes=accessCodeобязательно для заполнения
			accessCode		string	false	Содержимое пароля, без учета регистра, может содержать буквы и цифры, ограничение длины 45
			promptInfo		string	false	Подсказка для пароля доступа, не может содержать пароль доступа, ограничение длины 30, когда authModes=accessCodeобязательно для заполнения.
		sms			object	false	SMS OTP проверка, когда authModes=smsобязательно для заполнения
			countryCode		string	false	Международный код страны/региона, не нужно передавать «+»
			number		string	false	Формат не проверяется, только ограничение максимальной длины в 13 символов
		idVerification			object	false	Настройки проверки удостоверения личности, когда authModes=idVerificationобязательно для заполнения
			name		string	false	Полное имя подписавшего лица, указанное в удостоверении личности, максимальная длина 100 символов
		emailAuth			object	false	Email OTP проверка, когда authModes=emailAuthобязательно для заполнения
			authEmail		string	false	Адрес электронной почты для проверки личности подписавшего лица
		digitalId			array	false	Электронная идентификация, обязательна, когда authModes=digitalId
			authApp		string	false	Приложение, используемое для электронной идентификации singpass- Аутентификация с помощью Singpass iamsmart- Аутентификация с помощью i AM Smart
			idNumber		string	false	Номер удостоверения личности подписанта, ожидающего проверки Когда authApp=singpassтогда правило ввода: заглавная буква + 7 или 8 цифр + заглавная буква Когда authApp=iamsmartтогда правило ввода: 1. Одна заглавная буква (A-Z) или две заглавные буквы (AA-ZZ) в качестве начала последовательности; 2. Затем 6 цифр; 3. И, наконец, контрольная цифра, которая может быть цифрой (0-9) или буквой (A-Z). Пример: A888888(A)
		whatsappAuth			object	false	WhatsApp OTP-верификация, обязательна, когда authModes=whatsappAuth
			countryCode		string	false	Международный код страны/региона, не нужно передавать «+»
			number		string	false	Проверка формата не производится, только ограничение максимальной длины в 13 символов
	digitalSignature				boolean	false	Включить ли цифровую подпись, по умолчанию false true-включить, false-не включать
	freeFormSign				boolean	false	Подписант подписывает свободно, значение по умолчанию - false Дополнительные примечания: Когда выбрано значение freeFormSign равным true, другие параметры в sealInfos не нужно передавать. Если они передаются одновременно, freeFormSign имеет приоритет над sealInfos, и параметры в sealInfos не вступят в силу. 【Внимание】Свободная подпись означает, что нет ограничений на количество и положение печатей/подписей, которые может перетащить подписант.
	sealInfos				array	false	Информация о задаче подписи
		fileKey			string	true	FileKey файла подписи
		signConfigs			array	false	Информация о местоположении элемента управления. Для выполнения электронной подписи необходимо указать информацию о местоположении элемента управления.
			fieldType		string	false	Тип элемента управления, по умолчанию - signature signature- Элемент управления подписью stamp- Элемент управления печатью approval- Элемент управления утверждением
			sizeRule		string	false	Способ отображения размера области подписи originalSize- Проставлять печать в соответствии с фактическим размером подписи/печати targetSize- Пользовательская ширина/высота области подписи/печати Когда sizeRule, height и width пусты, штамп ставится в соответствии с фактическим размером подписи/печати; Когда sizeRule пуст, а height и width не пусты, штамп ставится в соответствии с указанным размером; Когда sizeRule не пуст, штамп ставится в соответствии с указанным способом отображения.
			height		int	false	Высота элемента управления подписи, применяется для fieldType signature/stamp, единица измерения px, поддерживаются только положительные целые числа, по умолчанию auto (то есть автоматический размер системы); Когда fieldType=signature, можно установить диапазон 20-250px; Когда fieldType=stamp, можно установить диапазон 30-280px;
			width		int	false	Ширина элемента управления подписи, применяется для fieldType signature/stamp, единица измерения px, поддерживаются только положительные целые числа, по умолчанию auto (то есть автоматический размер системы); Когда fieldType=signature, можно установить диапазон 20-250px; Когда fieldType=stamp, можно установить диапазон 30-280px;
			signatureOptions		string	false	Параметры элемента управления подписи. Применяется только для fieldType signature Доступные параметры: template: шаблон подписи handDrawn: нарисованная от руки подпись upload: локальная загрузка изображения подписи Можно выбрать несколько вариантов, разделенных ",", по умолчанию выбраны все
			movable		boolean	false	Разрешить перемещение местоположения при подписании, по умолчанию false false - не разрешать подписывающему лицу регулировать положение своих элементов управления подписью true - разрешить подписывающему лицу регулировать положение своих элементов управления подписью
			allowedOptions		array	false	Параметры, разрешенные для утверждения подписывающим лицом, применимы к fieldType как approval. По умолчанию ["approve", "decline"] approve- Согласен decline- Отклонить
			pageNo		string	false	Страницы для подписи; последовательные страницы соединяются знаком "-", отдельные страницы разделяются знаком "," Пример: 1-3,6-10
			posX		float	false	Координата по оси x 【Внимание】Если fieldType имеет значение signature, то положение координат относится к области подписиНижний левый угол； Если fieldType имеет значение stamp, то положение координат относится к области печатиЦентральная точкаПоложение С 3 февраля 2026 года для fieldType signature или stamp положение координат относится к положению центральной точки области печати.
			posY		float	false	Координата оси Y 【Внимание】Если fieldType имеет значение signature, то координатное положение относится к области подписиНижний левый угол； Если fieldType имеет значение stamp, то координатное положение относится к области штампаЦентральная точкаПоложение С 3 февраля 2026 года, если fieldType имеет значение signature или stamp, его координатное положение относится к положению центральной точки области штампа.
		fillConfigs			array	false	Заполните информацию об элементе управления
			fieldName		string	false	Имя элемента управления, ограничение по количеству символов 128
			required		boolean	false	Обязательно ли для заполнения, по умолчанию обязательно true-обязательно false-необязательно
			fieldType		string	false	Тип элемента управления: 1-однострочный текст 15-флажок
			textField		object	false	Свойства текстового элемента управления
				overflowType	int	false	Действует только для text, по умолчанию 1 1 - автоматическое уменьшение размера шрифта 2 - ограничение ввода
				minFontSize	float	false	Действует только для text, только для overflowType=1, по умолчанию 8 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
				width	int	false	Ширина элемента управления, по умолчанию 160px
				font	int	false	Действует только для text, шрифт, по умолчанию 宋体 1 - 宋体 2 - 新宋体 4 - 黑体 5 - 楷体 6-Arial 7-Helvetica 9-Times New Roman 10 - 仿宋 11-Georgia 12-Monospace
				fontSize	float	false	Действует только для text, размер шрифта, по умолчанию 12 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
				textColor	string	false	Действует только для text, шестнадцатеричный цвет, по умолчанию черный #000
				bold	boolean	false	Действует только для text, шрифт полужирный, по умолчанию false true - полужирный false - не полужирный
				italic	boolean	false	Действует только на text, курсив или нет, по умолчанию false true - курсив false - не курсив
				underline	boolean	false	Действует только на text, добавлять ли подчеркивание к шрифту, по умолчанию false true - добавить подчеркивание false - не добавлять подчеркивание
				lineThrough	boolean	false	Действует только на text, добавлять ли зачеркивание, по умолчанию false true - добавить зачеркивание false - не добавлять зачеркивание
				horizontalAlignment	string	false	Действует только на text, формат выравнивания по горизонтали, по умолчанию left LEFT - прижать к левому краю CENTER - по центру RIGHT - прижать к правому краю
			tickBoxField		object	false	Свойства флажка
				tickOptions	array	false	Действительно только для tickBox, по умолчанию 1 1 - Галочка 2 - Крестик
			posX		float	false	X-координата положения элемента управления
			posY		float	false	Y-координата положения элемента управления
			pageNo		string	false	Номер страницы, на которой находится элемент управления
		signDateConfigs			array	false	Информация о местоположении даты подписи
			movable		boolean	false	Разрешить перемещение местоположения при подписании, по умолчанию false false - не разрешать подписывающему лицу регулировать положение своих элементов управления подписью true - разрешить подписывающему лицу регулировать положение своих элементов управления подписью
			pageNo		string	false	Страницы для подписи; последовательные страницы соединяются знаком "-", отдельные страницы разделяются знаком ","，Пример: 1-3, 6-10; Если страницы не последовательные, разделите их с помощью ",".
			posX		float	false	Смещение по оси x, левый нижний угол страницы является началом координат
			posY		float	false	Смещение по оси y, нижний левый угол страницы является началом координат
			signDateFormat		string	false	Формат даты подписания, формат по умолчанию: yyyy-MM-dd Поддерживаемые форматы: yyyy год MM месяц dd день yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MM dd yyyy dd MM yyyy

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

{
    "subject": "员工入职合约",
    "remark": "这是描述",
    "expireAfterSeconds": 86400,
    "redirectUrl": "https://app-sml.esignglobal.com/home/main/esign/contract/list/inbox",
    "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
    "signerInfos": [
      {
        "userEmail": "sender_user@tsign.cn",
        "userName": "sender_user_name",
        "phoneNumber": {
        	"countryCode": "86",
        	"number": "158****9242"
        }
        "signOrder": 1,
        "authModes": "sms",
        "authConfig": {
            "sms": {
                "countryCode": "86",
                "number": "158****9242"
            }
        },
        "sealInfos": [
        {
            "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
            "signConfigs": [
              {
                "fieldType": "stamp",
                "pageNo": "1,3-5",
                "posX": 100.22222,
                "posY": 100.11111
              }
              "fillConfigs": [
              {
                "fieldId": "df0dd777bc774a2ba3fec4d108de242d",
                "fieldKey": "必填单行文本自动缩小字号最小字号Arial",
                "pageNo": "1",
                "posX": "88.70021",
                "posY": 745.409,
                "fieldType": "1",
                "required": true,
                "textField": {
                    "overflowType": "1",
                    "minFontSize": 8,
                    "font": "6",
                    "fontSize": "12",
                    "textColor": "#54ACD2",
                    "bold": false,
                    "italic": true,
                    "lineThrough": false,
                    "horizontalAlignment": "RIGHT"
                }
              },
              {
                  "fieldId": "888b899853544c49bd819d9f6d1e52cf",
                  "fieldKey": "必填勾选控件不限制选中样式不显示边框",
                  "pageNo": "3",
                  "posX": 451.77127,
                  "posY": 429.07626,
                  "fieldType": "15",
                  "required": true,
                  "tickBoxField": {
                      "tickOptions": [1,2],
                      "showBorder": false
                  }
                }
              ]
            ],
            "signDateConfigs":[
              {
                "pageNo":"1",
                "posX": 100.22,
                "posY": 100,
                "signDateFormat": "dd MMM yyyy"
              }
            ]
        }
      ]
    }
  ]
}

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

Название параметра		Тип	Описание
envelopeId		string	ID конверта
CCInfos		array	Коллекция информации о получателях копий
	userEmail	string	Адрес электронной почты получателя копии
	userName	string	Имя получателя копии
signFiles		array	Коллекция информации о файлах для подписи
	fileKey	string	fileKey файла для подписи
attachments		array	Коллекция вложений конверта
	fileKey	string	Файл fileKey
signerInfos		array	Информация о подписи
	businessId	string	Пользовательский бизнес-номер разработчика, ограничение длины 500
	userEmail	string	Адрес электронной почты подписавшего
	userName	string	Имя подписавшего
	signUrl	string	URL-адрес ссылки для подписи
	signOrder	int	Порядок подписи подписавшего, минимум 1
	accessCode	string	Пароль доступа к странице подписи

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

{
  "code": "0",
    "data": {
    "signerInfos": [
      {
        "accessCode": "123456",
        "userEmail": "sender_user@tsign.cn",
        "signUrl": "http://app-test.esignglobal-inc.com/home/main/sign/start/base/dosign?envelopeId=4cd738a60225445f9d5f3afec468a639&signature=eyJhbGciOiJIUzI1NiIsInppcCI6IkRFRiJ9.eNqqVkrOzytJrShRsqpWSs0rS83JL0gNSSzO9kxRslJKtjC1MDKxTDVIMzA0SU4xSTIwNjAxSDRNTTVKMTIxTFOqrQUAAAD__w.YMBA5X9O8Ylk7x2rma-s1WxGwo2cjqy-O9CCQopzw88&tenantToken=AA0DDgQ0Y2Q3MzhhNjAyMjU0NDVmOWQ1ZjNhZmVjNDY4YTYzuQ4GNGNkNzM4YTYwMjI1NDQ1ZjlkNWYzYWZlYzQ2OGE2M7kOCjRjZDczOGE2MDIyNTQ0NWY5ZDVmM2FmZWM0NjhhNjO5AIBjNDIwMzg1ZDMyYzU0MGE4YTk1ZTE3ZTNkZmZjMDNm4g%3D%3D",
        "userName": "sender_user_name",
        "signOrder": "1"
      }
    ],
      "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
      "envelopeId": "4cd738a60225445f9d5f3afec468a639"
  },
  "message": "success"
}