Schnell einen Umschlag starten

Parametername

Typ

Erforderlich

Beschreibung

subject

string

true

Umschlagthema

Beispiel: „Offer Letter“

remark

string

false

Umschlagbemerkungen，Längenbeschränkung 1000 Zeichen

object

false

Aktionen, die der Unterzeichner ausführen darf

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;

boolean

false

Ob die unterzeichnende Partei 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 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 wird die Konfiguration "Standard-Benachrichtigungssprache" verwendet

en-US Englisch

zh-CN Vereinfachtes Chinesisch

zh-Hant Traditionelles Chinesisch

ja-JP Japanisch

es-MX Spanisch

pt-PT Portugiesisch
th-TH Thailändisch
id-ID Indonesisch
vi-VN Vietnamesisch
ms-MY Malaiisch
fil-PH Philippinisch
de-DE Deutsch
fr-FR Französisch
ru-RU Russisch
it-IT Italienisch
ko-KR Koreanisch

signFiles

array

true

Sammlung von Informationen zu signierten Dokumenten, die Anzeigereihenfolge entspricht der Reihenfolge, in der die Dokumente hinzugefügt wurden.

fileKey 

string

true

fileKey der Signaturdatei, nur PDF-Format wird unterstützt

attachments

array

false

Sammlung von Briefumschlaganhä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

string

false

userEmail

string

false

E-Mail-Adresse des Unterzeichners

userName

string

true

Name des Unterzeichners, der auf der Unterzeichnungsseite 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, standardmäßig 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 „+“

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, standardmäßig wird die Konfiguration „Standardbenachrichtigungssprache“ verwendet

en-US Englisch

zh-CN Vereinfachtes Chinesisch

zh-Hant Traditionelles Chinesisch

ja-JP Japanisch

es-MX Spanisch

pt-PT Portugiesisch
th-TH Thailändisch
id-ID Indonesisch
vi-VN Vietnamesisch
ms-MY Malaiisch
fil-PH Filipino
de-DE Deutsch
fr-FR Französisch
ru-RU Russisch
it-IT Italienisch
ko-KR Koreanisch

signOrder

int

true

Die Unterschriftsreihenfolge des Unterzeichners, minimal 1. Für ungeordnete Unterschriften kann der gleiche Reihenfolgewert angegeben werden.

anySigner

boolean

false

Ob die Unterschrift von einer beliebigen Person unterstützt wird, standardmäßig false

true-Von derselben signOrder muss nur eine Person unterschreiben

false-Alle Personen mit derselben signOrder müssen unterschreiben

authModes

string

false

Validierungsmethode, standardmäßig noAuth

authConfig

object

false

Einstellungen für die Validierungsmethode

accessCode

object

false

Passwort für die Unterschrift festlegen, wenn authModes=accessCodeerforderlich

accessCode

string

false

Passwortinhalt, nicht case-sensitiv, kann alphanumerische Zeichen enthalten, Längenbeschränkung 45

promptInfo

string

false

Hinweisinformationen zum Zugriffspasswort, darf kein Zugriffspasswort enthalten, Längenbeschränkung 30, wenn authModes=accessCodeist, ist dies erforderlich.  

sms

object

false

SMS-OTP-Verifizierung, wenn authModes=smsist, ist dies erforderlich

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 zur ID-Dokumentenverifizierung, wenn authModes=idVerificationist, ist dies erforderlich

name

string

false

Vollständiger Name des Unterzeichners auf dem Ausweisdokument, maximale Länge 100 Zeichen

emailAuth

object

false

E-Mail-OTP-Verifizierung, wenn authModes=emailAuthist, ist dies erforderlich

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- Authentifizierung mit Singpass

iamsmart- Authentifizierung mit i AM Smart

idNumber

string

false

Zu verifizierende Personalausweisnummer des Unterzeichners

Wenn authApp=singpassist, lautet die Eingaberegel: Großbuchstabe + 7 oder 8 Ziffern + Großbuchstabe

Wenn authApp=iamsmartist, lautet die Eingaberegel:

1. Ein Großbuchstabe (A-Z) oder zwei Großbuchstaben (AA-ZZ) als Beginn der Sequenz;

2. Gefolgt von 6 Ziffern;

3. Abschließend eine Prüfziffer, die eine Zahl (0-9) oder ein Buchstabe (A-Z) sein kann. Beispiel: A888888(A)

whatsappAuth

object

false

WhatsApp OTP-Verifizierung, obligatorisch wenn authModes=whatsappAuth

countryCode

string

false

Internationale Vorwahl des Landes/der Region, ohne das Präfix „+“

number

string

false

Es erfolgt keine Formatprüfung, nur die maximale Länge ist auf 13 Stellen begrenzt

digitalSignature

boolean

false

Ob die digitale Signatur aktiviert ist, Standardwert ist false

true-aktiviert, false-nicht aktiviert

freeFormSign

boolean

false

Ist der Unterzeichner frei, das Siegel anzubringen, Standardwert ist false

Zusätzliche Hinweise:

Wenn freeFormSign auf true gesetzt ist, müssen keine anderen Parameter unter sealInfos übergeben werden. Wenn sie gleichzeitig übergeben werden, hat freeFormSign eine höhere Priorität als sealInfos, und die Parameter unter sealInfos werden nicht wirksam.

【Achtung】Freies Signieren bedeutet, dass die Anzahl und Position der Stempel/Signaturen, die der Unterzeichner ziehen kann, 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, Standardwert ist signature

signature-Signatur-Steuerelement

stamp-Stempel-Steuerelement

sizeRule

string

false

Anzeigemodus für die Signaturfeldgröße

originalSize-Stempelung basierend auf der tatsächlichen Größe der Signatur/des Stempels

targetSize-Benutzerdefinierte Breite und Höhe des Signatur-/Stempelbereichs

Wenn sizeRule, height und width leer sind, wird die Signatur/das Siegel in der tatsächlichen Größe platziert;

Wenn sizeRule leer ist, height und width aber nicht, wird die Signatur/das Siegel in der angegebenen Größe platziert;

Wenn sizeRule nicht leer ist, wird die Signatur/das Siegel in der angegebenen Darstellungsweise platziert.

height

int

false

Höhe des Signatur-Steuerelements, gilt für fieldType=signature/stamp, Einheit ist px, es können nur positive Ganzzahlen übergeben werden, Standard ist auto (d. h. automatische Systemgröße);

Wenn fieldType=signature ist, kann der Bereich von 20-250px eingestellt werden;

Wenn fieldType=stamp ist, kann der Bereich von 30-280px eingestellt werden;

width

int

false

Breite des Signatur-Steuerelements, gilt für fieldType=signature/stamp, Einheit ist px, es können nur positive Ganzzahlen übergeben werden, Standard ist auto (d. h. automatische Systemgröße);

Wenn fieldType=signature ist, kann der Bereich von 20-250px eingestellt werden;

Wenn fieldType=stamp ist, kann der Bereich von 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 zulässig, Standardwert ist false

false - Unterzeichner darf die Position seiner eigenen Signaturfelder nicht anpassen

true - Unterzeichner darf die Position seiner eigenen Signaturfelder anpassen

allowedOptions

array

false

Optionen, die der Unterzeichner genehmigen kann, gelten für fieldType = approval. Standardmäßig ["approve", "decline"]

approve- Zustimmen

decline- Ablehnen

pageNo

string

false

Signaturseitenzahl; 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 „signature“ oder „stamp“ auf die Mittelpunktposition des Stempelbereichs.

fillConfigs

array

false

Füllen Sie die Steuerelementinformationen aus

fieldName

string

false

Steuerelementname, 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

Text-Steuerelement-Attribute

overflowType

int

false

Gilt nur für Text, Standardwert 1

1 - Automatische Schriftgrößenreduzierung

2 - Eingabe beschränken

minFontSize

float

false

Gilt nur für Text, gilt nur für overflowType=1, Standardwert 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, Standardwert 160px

font

int

false

Gilt nur für Text, Schriftart, Standardwert SimSun

1 - SimSun

2 - NSimSun

4 - Heiti

5 - Kaiti

6-Arial

7-Helvetica

9-Times New Roman

10 - Fangsong

11-Georgia

12-Monospace

fontSize

float

false

Gilt nur für Text, Schriftgröße, Standardwert 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, Standardwert Schwarz #000

bold

boolean

false

Gilt nur für Text, ob die Schrift fett gedruckt ist, Standardwert false

true-Fett

false-Nicht fett

italic

boolean

false

Wirkt sich nur auf Text aus, ob kursiv, standardmäßig false

true-Kursiv

false-Nicht kursiv

underline

boolean

false

Wirkt sich nur auf Text aus, ob der Schriftart eine Unterstreichung hinzugefügt wird, standardmäßig false

true-Unterstreichung hinzufügen

false-Keine Unterstreichung hinzufügen

lineThrough

boolean

false

Wirkt sich nur auf Text aus, ob ein Durchstreichungseffekt hinzugefügt wird, standardmäßig false

true-Durchstreichung hinzufügen

false-Keine Durchstreichung hinzufügen

horizontalAlignment

string

false

Wirkt sich nur auf Text aus, horizontale Zentrierung, standardmäßig links

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-Häkchen

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 zum Unterschriftsdatum

movable

boolean

false

Bewegung der Position bei der Unterzeichnung zulassen, 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 durch "-" verbunden, einzelne Seitenzahlen durch ","，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

Signaturdatumsformat, Standardformat ist yyyy-MM-dd

Unterstützte Formate:

yyyy年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy

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

Signaturdokument-FileKey

attachments

array

Sammlung von Briefumschlaganhängen

fileKey

string

Datei fileKey

signerInfos

array

Signaturinformationen

businessId

string

Benutzerdefinierte Geschäftsnummer des Entwicklers, Längenbeschränkung 500

userEmail

string

E-Mail-Adresse des Unterzeichners

userName

string

Name des Unterzeichners

signOrder

int

Signaturreihenfolge des Unterzeichners, Minimum ist 1

accessCode

string

Passwort für den Zugriff auf die Signaturseite