Schnell einen Umschlag starten

POST /esignglobal/v1/envelope/createAndStart

Schnittstellenbeschreibung

Schnelles Initiieren von Umschlägen, einschließlich der Funktionen zum Erstellen von Umschlägen, Hinzufügen von zu unterzeichnenden Dokumenten und Hinzufügen von Unterzeichnern.

Unterstützt automatisches Starten：Nach erfolgreichem Aufruf der Schnittstelle wird der Umschlag erfolgreich erstellt und gestartet, und der Umschlag beginnt automatisch zu zirkulieren.
Unterstützt automatisches Beenden：Nachdem alle Unterzeichner die Unterzeichnung abgeschlossen haben, wird der Umschlag automatisch beendet.

Anfrageparameter

Parametername					Typ	Erforderlich	Beschreibung
subject					string	true	Umschlagthema Beispiel: „Offer Letter“
remark					string	false	Umschlagbemerkung，Längenbeschränkung 1000 Zeichen
signerSettings					object	false	Erlaubte Aktionen für den Unterzeichner
	allowTransfer				boolean	false	Ob der Unterzeichner diesen Umschlag an andere zur Unterzeichnung weiterleiten darf, Standardwert ist false true - Der Unterzeichner im Umschlag hat das Recht, den Umschlag an andere weiterzuleiten; false - Der Unterzeichner im Umschlag hat nicht das Recht, den Umschlag an andere weiterzuleiten;
	allowModifyName				boolean	false	Ob der Unterzeichner den Namen ändern darf, gilt nur für die Vorlagensignatur, Standardwert ist false true - Der Unterzeichner darf den Namen ändern false - Der Unterzeichner darf den Namen nicht ändern
expireAfterSeconds					long	false	Ablaufzeit des Umschlags, nach wie vielen Sekunden der Umschlag abläuft Ablaufbereich: 86.400 Sekunden (1 Tag) ~ 7.776.000 Sekunden (90 Tage)
redirectUrl					string	false	Muss eine gültige HTTPS-Adresse sein
callBackUrl					string	false	Callback-Adresse (Länge 500), muss der Adresse des HTTPS-Protokolls entsprechen.
sendLaterAfterSeconds					long	false	Unterstützt verzögertes Senden durch den Benutzer, in Sekunden Unterstützter Zeitbereich: 3600 Sekunden (1 Stunde) ~ 259200 Sekunden (30 Tage)
CCInfos					array	false	Sammlung von Informationen über CC-Empfänger
	userEmail				string	false	E-Mail-Adresse des CC-Empfängers
	userName				string	false	Name des CC-Empfängers, der auf der Signaturseite und dem Umschlag angezeigt wird. 【Hinweis】: Darf nicht die folgenden 9 Sonderzeichen enthalten: / \ : * " < > \| ？ sowie alle Emoji-Ausdrücke
	customizeSettings				object	false	Benutzerdefinierte Konfiguration
		notificationSettings			object	false	Benutzerdefinierte Konfiguration für Benachrichtigungen
			notificationLanguage		string	false	Benachrichtigungssprache, standardmäßig Englisch en-US Englisch zh-CN Vereinfachtes Chinesisch zh-Hant Traditionelles Chinesisch ja-JP Japanisch ES-MX Spanisch
signFiles					array	true	Sammlung von Informationen zu signierten Dokumenten, die Anzeigereihenfolge entspricht der Reihenfolge, in der die Dateien hinzugefügt wurden.
	fileKey				string	true	Signaturdatei-FileKey, unterstützt nur das PDF-Format
attachments					array	false	Sammlung von Umschlaganhängen, die Anzeigereihenfolge entspricht der Reihenfolge, in der die Dateien hinzugefügt wurden.
	fileKey				string	false	Datei-FileKey
signerInfos					array	true	Sammlung von Informationen zu Unterzeichnern
	businessId				string	false	Vom Entwickler definierte Geschäftsnummer, Längenbeschränkung 500
	deliveryMethods				string	false	Benachrichtigungsmethode, Standardwert ist auto auto- Sendet eine E-Mail-Benachrichtigung, wenn userEmail übergeben wird, und eine SMS-Benachrichtigung, wenn phoneNumber übergeben wird none- Keine Benachrichtigung senden email- E-Mail-Benachrichtigung senden sms- SMS-Benachrichtigung senden WhatsApp- WhatsApp-Benachrichtigung senden
	userEmail				string	true	E-Mail-Adresse des Unterzeichners
	userName				string	true	Name des Unterzeichners, der auf der Signaturseite und im Umschlag zur externen Anzeige des Namens des Unterzeichners verwendet wird. 【Hinweis】Darf nicht die folgenden 9 Sonderzeichen enthalten: / \ : * " < > \| ？ sowie alle Emoji-Ausdrücke
	phoneNumber				object	false	Telefonnummer, Standardwert ist leer Ist ein Pflichtparameter, wenn eine SMS-Benachrichtigung erforderlich ist. Sowohl countryCode als auch number müssen übergeben werden
		countryCode			string	false	Internationale Vorwahl des Landes/der Region, ohne das Präfix „+“
		number			string	false	Keine Formatprüfung, nur die maximale Länge ist auf 13 Stellen begrenzt
	customizeSettings				object	false	Benutzerdefinierte Konfiguration
		notificationSettings			object	false	Benutzerdefinierte Konfiguration für Benachrichtigungen
			customizeMessage		string	false	Exklusive Nachrichtbenachrichtigung, Zeichenbeschränkung 200
			notificationLanguage		string	false	Benachrichtigungssprache, Standard ist Englisch en-US Englisch zh-CN Vereinfachtes Chinesisch zh-Hant Traditionelles Chinesisch ja Japanisch ES-MX Spanisch
	signOrder				int	true	Unterschriftsreihenfolge des Unterzeichners, Minimum ist 1. Für ungeordnete Unterschriften kann der gleiche Reihenfolgewert angegeben werden.
	anySigner				boolean	false	Ob die Unterschrift von einer beliebigen Person unterstützt wird, Standard ist false true-Es muss nur eine Person mit derselben signOrder unterschreiben false-Alle Personen mit derselben signOrder müssen unterschreiben
	authModes				string	false	Validierungsmethode, Standard ist noAuth noAuth-Nicht validieren accessCode-Verifizierung mit Unterschriftspasswort sms-SMS OTP-Verifizierung idVerification-ID-Dokumentenverifizierung emailAuth-E-Mail-OTP-Verifizierung digitalId-Elektronische Identitätsprüfung
	authConfig				object	false	Einstellungen für Verifizierungsmethoden
		accessCode			object	false	Passwort-Einstellungen für die Signatur, erforderlich wenn authModes=accessCodeist
			accessCode		string	false	Passwortinhalt, Groß- und Kleinschreibung wird nicht beachtet, kann alphanumerische Zeichen enthalten, Längenbeschränkung 45
			promptInfo		string	false	Hinweisinformationen zum Zugriffspasswort, darf kein Zugriffspasswort enthalten, Längenbeschränkung 30, erforderlich wenn authModes=1 ist.
		sms			object	false	SMS OTP-Überprüfung, erforderlich wenn authModes=smsist
			countryCode		string	false	Internationale Vorwahl des Landes/der Region, ohne das Präfix „+“
			number		string	false	Keine Formatprüfung, nur die maximale Länge von 13 Stellen ist begrenzt
		idVerification			object	false	Einstellungen für die ID-Dokumentenverifizierung, erforderlich wenn authModes=idVerificationist
			name		string	false	Vollständiger Name auf dem Ausweisdokument des Unterzeichners, maximale Länge 100 Zeichen
		emailAuth			object	false	E-Mail-OTP-Validierung, wenn authModes=emailAuthist, ist dies ein Pflichtfeld
			authEmail		string	false	E-Mail-Adresse zur Identitätsprüfung des Unterzeichners
		digitalId			array	false	Elektronische Identitätsprüfung, erforderlich wenn authModes=digitalId
			authApp		string	false	Für die elektronische Identitätsprüfung verwendete APP singpass - Verwenden Sie Singpass zur Authentifizierung
			idNumber		string	false	Zu verifizierende Ausweisnummer des Unterzeichners
	digitalSignature				boolean	false	Ob die digitale Signatur aktiviert werden soll, Standardwert ist false true - aktivieren, false - nicht aktivieren
	freeFormSign				boolean	false	Ob der Unterzeichner frei stempeln darf, Standardwert false Zusätzliche Hinweise: Wenn freeFormSign auf true gesetzt ist, müssen die anderen Parameter unter sealInfos nicht übergeben werden. Wenn sie gleichzeitig übergeben werden, hat freeFormSign Vorrang vor sealInfos, und die Parameter unter sealInfos werden nicht wirksam. [Achtung]Freies Stempeln bedeutet, dass die Anzahl und Position der vom Unterzeichner einfügbaren Stempel/Signaturen nicht begrenzt ist
	sealInfos				array	false	Informationen zur Signaturaufgabe
		fileKey			string	true	Signaturdatei fileKey
		signConfigs			array	false	Informationen zur Steuerelementposition. Die Positionsinformationen des Steuerelements müssen angegeben werden, um eine elektronische Signatur durchführen zu können.
			fieldType		string	false	Steuerelementtyp, standardmäßig Signatur signature- Signatur-Steuerelement stamp- Stempel-Steuerelement approval- Genehmigungs-Steuerelement
			sizeRule		string	false	Anzeigemodus für die Signaturflächengröße originalSize- Stempelung basierend auf der tatsächlichen Größe der Signatur/des Stempels targetSize- Benutzerdefinierte Breite und Höhe der Signatur-/Stempelfläche Wenn sizeRule, height und width alle leer sind, erfolgt die Stempelung basierend auf der tatsächlichen Größe der Signatur/des Stempels; Wenn sizeRule leer ist, height und width aber nicht leer sind, erfolgt die Stempelung basierend auf der angegebenen Größe; Wenn sizeRule nicht leer ist, erfolgt die Stempelung basierend auf dem angegebenen Anzeigemodus.
			height		int	false	Höhe des Signatur-Steuerelements, gilt für fieldType=signature/stamp, Einheit ist px, nur positive Ganzzahlen werden unterstützt, Standard ist auto (d. h. automatische Systemgröße); Wenn fieldType=signature ist, kann der Bereich auf 20-250px eingestellt werden; Wenn fieldType=stamp ist, kann der Bereich auf 30-280px eingestellt werden;
			width		int	false	Breite des Signatur-Steuerelements, gilt für fieldType=signature/stamp, Einheit ist px, es werden nur positive Ganzzahlen unterstützt, Standard ist auto (d. h. automatische Systemgröße); Wenn fieldType=signature ist, kann der Bereich auf 20-250px eingestellt werden; Wenn fieldType=stamp ist, kann der Bereich auf 30-280px eingestellt werden;
			signatureOptions		string	false	Optionen für das Signatur-Steuerelement. Gilt nur für fieldType=signature Mögliche Parameter: template: Vorlagensignatur handDrawn: Handgezeichnete Signatur upload: Lokales Hochladen eines Signaturbildes Mehrfachauswahl möglich, getrennt durch ",", Standard ist alles ausgewählt
			movable		boolean	false	Bewegung der Position beim Signieren zulassen, Standard ist false false - Dem Unterzeichner ist es nicht gestattet, die Position seiner eigenen Signatur-Steuerelemente anzupassen true - Dem Unterzeichner ist es gestattet, die Position seiner eigenen Signatur-Steuerelemente anzupassen
			allowedOptions		array	false	Optionen, die der Unterzeichner genehmigen darf, gelten für fieldType=approval. Standardmäßig ist ["approve", "decline"] approve- Zustimmen decline-Ablehnen
			pageNo		string	false	Signaturseitenzahlen; fortlaufende Seitenzahlen werden mit "-" verbunden, einzelne Seitenzahlen mit "," Beispiel: 1-3,6-10
			posX		float	false	X-Achsenkoordinate 【Hinweis】Wenn fieldType „signature“ ist, bezieht sich die Koordinatenposition auf den SignaturbereichUnten links； Wenn fieldType „stamp“ ist, bezieht sich die Koordinatenposition auf den StempelbereichMittelpunktPosition Ab dem 3. Februar 2026 bezieht sich die Koordinatenposition für fieldType „signature“ oder „stamp“ auf die Mittelpunktposition des Stempelbereichs.
			posY		float	false	Y-Achsenkoordinate 【Hinweis】Wenn fieldType „signature“ ist, bezieht sich die Koordinatenposition auf den SignaturbereichUnten links； Wenn fieldType „stamp“ ist, bezieht sich die Koordinatenposition auf den StempelbereichMittelpunktPosition Ab dem 3. Februar 2026 bezieht sich die Koordinatenposition für fieldType mit dem Wert signature oder stamp auf die Position des Mittelpunkts des Stempelbereichs.
		fillConfigs			array	false	Füllen Sie die Steuerelementinformationen aus
			fieldName		string	false	Name des Steuerelements, Zeichenanzahl auf 128 begrenzt
			required		boolean	false	Ist dies ein Pflichtfeld? Standardmäßig ist dies ein Pflichtfeld true - Pflichtfeld false - Kein Pflichtfeld
			fieldType		string	false	Steuerelementtyp: 1 - Einzeiliger Text 15 - Kontrollkästchen
			textField		object	false	Attribute des Textsteuerelements
				overflowType	int	false	Gilt nur für Text, Standardwert ist 1 1 - Automatische Schriftgrößenreduzierung 2 - Eingabe beschränken
				minFontSize	float	false	Gilt nur für Text, gilt nur für overflowType=1, Standardwert ist 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	Steuerelementbreite, Standard 160px
				font	int	false	Gilt nur für Text, Schriftart, Standard 宋体 (chinesische Standardschrift) 1-宋体 (chinesische Standardschrift) 2-新宋体 (chinesische Standardschrift) 4-黑体 (chinesische Standardschrift) 5-楷体 (chinesische Standardschrift) 6-Arial 7-Helvetica 9-Times New Roman 10-仿宋 (chinesische Standardschrift) 11-Georgia 12-Monospace
				fontSize	float	false	Gilt nur für Text, Schriftgröße, Standard 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	Gilt nur für Text, Hexadezimalfarbe, Standard Schwarz #000
				bold	boolean	false	Gilt nur für Text, ob die Schrift fett ist, Standard false true-fett false-nicht fett
				italic	boolean	false	Gilt nur für Text, ob kursiv, Standard false true-kursiv false-nicht kursiv
				underline	boolean	false	Gilt nur für Text, ob die Schriftart unterstrichen werden soll, Standardwert ist false true - Unterstreichen false - Nicht unterstreichen
				lineThrough	boolean	false	Gilt nur für Text, ob ein Durchstreichen hinzugefügt werden soll, Standardwert ist false true - Durchstreichen hinzufügen false - Kein Durchstreichen hinzufügen
				horizontalAlignment	string	false	Gilt nur für Text, horizontale Zentrierung, Standardwert ist left LEFT - Linksbündig CENTER - Zentriert RIGHT - Rechtsbündig
			tickBoxField		object	false	Kontrollkästchen-Attribute
				tickOptions	array	false	Gilt nur für tickBox, Standardwert ist 1 1 - Haken 2 - Kreuz
			posX		float	false	X-Koordinate der Steuerelementposition
			posY		float	false	Y-Koordinate der Steuerelementposition
			pageNo		string	false	Seitenzahl, auf der sich das Steuerelement befindet
		signDateConfigs			array	false	Positionsinformationen des Unterschriftsdatums
			movable		boolean	false	Bewegung der Position während der Unterzeichnung zulässig, Standardwert ist false false - Unterzeichner darf die Position seiner eigenen Unterschriftssteuerelemente nicht anpassen true - Unterzeichner darf die Position seiner eigenen Unterschriftssteuerelemente anpassen
			pageNo		string	false	Unterschriftsseitenzahl; fortlaufende Seitenzahlen werden mit "-" verbunden, einzelne Seitenzahlen mit ","，Beispiel: 1-3, 6-10; Bei Nicht-Kontinuität mit "," trennen.
			posX		float	false	X-Achsen-Offset, die linke untere Ecke der Seite ist der Koordinatenursprung
			posY		float	false	Y-Achsen-Offset, die linke untere Ecke der Seite ist der Koordinatenursprung
			signDateFormat		string	false	Unterschriftsdatumsformat, Standardformat ist yyyy-MM-dd Unterstützt die Angabe des Formats: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MM dd yyyy dd MM yyyy

Beispielanfrage

{
    "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"
              }
            ]
        }
      ]
    }
  ]
}

Antwortparameter

Parametername		Typ	Beschreibung
envelopeId		string	Umschlag-ID
CCInfos		array	Sammlung von Informationen zu CC-Empfängern
	userEmail	string	E-Mail-Adresse des CC-Empfängers
	userName	string	Name des CC-Empfängers
signFiles		array	Sammlung von Informationen zu signierten Dokumenten
	fileKey	string	fileKey der signierten Datei
attachments		array	Sammlung von Umschlaganhängen
	fileKey	string	Datei-fileKey
signerInfos		array	Signaturinformationen
	businessId	string	Vom Entwickler definierte benutzerdefinierte Geschäftsnummer, Längenbeschränkung 500
	userEmail	string	E-Mail-Adresse des Unterzeichners
	userName	string	Name des Unterzeichners
	signUrl	string	Signatur-Link-Adresse
	signOrder	int	Signaturreihenfolge des Unterzeichners, Minimum ist 1
	accessCode	string	Passwort für den Zugriff auf die Signaturseite

Beispielantwort

{
  "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"
}