Avvia rapidamente una busta

Nome parametro

Tipo

Obbligatorio

Descrizione

subject

string

true

Oggetto della busta

Esempio: “Offer Letter”

remark

string

false

Note sulla busta，Lunghezza massima 1000 caratteri

object

false

Operazioni consentite al firmatario

boolean

false

Indica se il firmatario può inoltrare la busta a qualcun altro per la firma, il valore predefinito è false

true - Consente al firmatario nella busta di avere il potere di inoltrare la busta ad altri;

false - Non consente al firmatario nella busta di avere il potere di inoltrare la busta ad altri;

boolean

false

Indica se il firmatario può modificare il nome, valido solo per la firma del modello, il valore predefinito è false

true - Consente al firmatario di modificare il nome

false - Non consente al firmatario di modificare il nome

expireAfterSeconds

long

false

Tempo di scadenza della busta, dopo quanti secondi la busta scade

Intervallo di scadenza: 86.400 secondi (1 giorno) ~ 7.776.000 secondi (90 giorni)

redirectUrl

string

false

Deve essere un indirizzo https valido

callBackUrl

string

false

Indirizzo di callback (lunghezza 500), deve essere conforme all'indirizzo del protocollo https.

sendLaterAfterSeconds

long

false

Supporta l'invio ritardato da parte dell'utente, in secondi

Intervallo di tempo supportato: 3600 secondi (1 ora) ~ 259200 secondi (30 giorni)

CCInfos

array

false

Raccolta di informazioni sui destinatari in copia conoscenza

userEmail

string

false

Indirizzo email del destinatario in copia conoscenza

userName

string

false

Nome del destinatario in copia conoscenza, utilizzato per visualizzare esternamente il nome del destinatario in copia conoscenza nella pagina di firma e nella busta.

【Attenzione】: Non può contenere i seguenti 9 caratteri speciali: / \ : * " < > | ？ e tutte le emoji

customizeSettings

object

false

Configurazione personalizzata

notificationSettings

object

false

Configurazione personalizzata per notifiche

notificationLanguage

string

false

Lingua di notifica, per impostazione predefinita viene utilizzata la configurazione "Lingua di notifica predefinita"

en-US Inglese

zh-CN Cinese semplificato

zh-Hant Cinese tradizionale

ja-JP Giapponese

es-MX Spagnolo

pt-PT Portoghese
th-TH Thailandese
id-ID Indonesiano
vi-VN Vietnamita
ms-MY Malese
fil-PH Filippino
de-DE Tedesco
fr-FR Francese
ru-RU Russo
it-IT Italiano
ko-KR Coreano

signFiles

array

true

Raccolta di informazioni sui documenti firmati, l'ordine di visualizzazione è l'ordine in cui i documenti sono stati aggiunti.

fileKey 

string

true

fileKey del documento firmato, supporta solo il formato PDF

attachments

array

false

Raccolta di allegati della busta, l'ordine di visualizzazione è l'ordine in cui i documenti sono stati aggiunti.

fileKey 

string

false

fileKey del file

signerInfos

array

true

Raccolta di informazioni sui firmatari

businessId

string

false

Numero di pratica personalizzato dallo sviluppatore, limite di lunghezza 500

string

false

userEmail

string

false

Indirizzo email del firmatario

userName

string

true

Nome del firmatario, utilizzato per visualizzare esternamente il nome del firmatario nella pagina di firma e nella busta.

【Nota】Non può contenere i seguenti 9 caratteri speciali: / \ : * " < > | ？e tutte le emoji

phoneNumber

object

false

Numero di telefono, predefinito vuoto

Quando è necessario inviare una notifica SMS, questo è un parametro obbligatorio, è necessario passare sia countryCode che number

countryCode

string

false

Prefisso internazionale del paese/regione, non è necessario inserire il segno “+”

number

string

false

Nessuna convalida del formato, solo la lunghezza massima è limitata a 13 cifre

customizeSettings

object

false

Configurazione personalizzata

notificationSettings

object

false

Configurazione personalizzata per le notifiche

customizeMessage

string

false

Notifica di messaggio esclusiva, limite di 200 caratteri

notificationLanguage

string

false

Lingua di notifica, per impostazione predefinita viene utilizzata la configurazione "Lingua di notifica predefinita"

en-US Inglese

zh-CN Cinese semplificato

zh-Hant Cinese tradizionale

ja-JP Giapponese

es-MX Spagnolo

pt-PT Portoghese
th-TH Thailandese
id-ID Indonesiano
vi-VN Vietnamita
ms-MY Malese
fil-PH Filippino
de-DE Tedesco
fr-FR Francese
ru-RU Russo
it-IT Italiano
ko-KR Coreano

signOrder

int

true

Ordine di firma del firmatario, il valore minimo è 1. Per le firme non ordinate, è possibile specificare lo stesso valore di ordine.

anySigner

boolean

false

Indica se è supportata la firma di una qualsiasi persona, predefinito false

true-Solo una persona con lo stesso signOrder deve firmare

false-Tutte le persone con lo stesso signOrder devono firmare

authModes

string

false

Metodo di verifica, predefinito noAuth

authConfig

object

false

Impostazioni del metodo di verifica

accessCode

object

false

Impostazioni della password di firma, quando authModes=accessCodeè obbligatorio

accessCode

string

false

Contenuto della password, non fa distinzione tra maiuscole e minuscole, può contenere lettere e numeri, lunghezza massima 45

promptInfo

string

false

Informazioni di suggerimento per la password di accesso, non possono contenere la password di accesso, lunghezza massima 30, quando authModes=accessCodeè obbligatorio. 

sms

object

false

Verifica SMS OTP, quando authModes=smsè obbligatorio

countryCode

string

false

Prefisso internazionale del paese/regione, non è necessario inserire il segno “+”

number

string

false

Nessun controllo del formato, solo la lunghezza massima è limitata a 13 cifre

idVerification

object

false

Impostazioni di verifica del documento d'identità, quando authModes=idVerificationè obbligatorio

name

string

false

Nome completo sul documento d'identità del firmatario, lunghezza massima 100 caratteri

emailAuth

object

false

Verifica OTP via email, quando authModes=emailAuthè obbligatorio

authEmail

string

false

Indirizzo email di verifica dell'identità del firmatario

digitalId

array

false

Verifica dell'identità elettronica, obbligatoria quando authModes=digitalId

authApp

string

false

APP utilizzata per la verifica dell'identità elettronica

singpass-Autenticazione con Singpass

iamsmart-Autenticazione con i AM Smart

idNumber

string

false

Numero del documento d'identità del firmatario in attesa di verifica

Quando authApp=singpassil formato di input è: lettera maiuscola + 7 o 8 cifre + lettera maiuscola

Quando authApp=iamsmartil formato di input è:

1. Una lettera maiuscola (A-Z) o due lettere maiuscole (AA-ZZ) come inizio della sequenza;

2. Seguito da 6 cifre;

3. Infine, un codice di controllo, che può essere una cifra (0-9) o una lettera (A-Z). Esempio: A888888(A)

whatsappAuth

object

false

Verifica OTP WhatsApp, obbligatoria quando authModes=whatsappAuth

countryCode

string

false

Prefisso internazionale del paese/regione, non è necessario inserire il simbolo “+”

number

string

false

Nessun controllo del formato, solo la lunghezza massima è limitata a 13 cifre

digitalSignature

boolean

false

Indica se abilitare la firma digitale, predefinito false

true-abilitata, false-non abilitata

freeFormSign

boolean

false

L'autore della firma è libero di apporre il sigillo? Valore predefinito: false

Note aggiuntive:

Quando si seleziona freeFormSign come true, non è necessario passare altri parametri sotto sealInfos. Se vengono passati contemporaneamente, freeFormSign ha la priorità su sealInfos e i parametri sotto sealInfos non avranno effetto

【Attenzione】La firma libera non limita il numero e la posizione dei timbri/firme che il firmatario può trascinare

sealInfos

array

false

Informazioni sull'attività di firma

fileKey

string

true

fileKey del documento da firmare

signConfigs

array

false

Informazioni sulla posizione del controllo. È necessario specificare le informazioni sulla posizione del controllo per poter eseguire la firma elettronica.

fieldType

string

false

Tipo di controllo, predefinito: signature

signature- Controllo firma

stamp- Controllo timbro

sizeRule

string

false

Modalità di visualizzazione delle dimensioni dell'area di firma

originalSize- Applica il timbro in base alle dimensioni effettive della firma/timbro

targetSize- Larghezza e altezza personalizzate dell'area firma/timbro

Quando sizeRule, height e width sono tutti vuoti, il sigillo/timbro viene applicato in base alle dimensioni effettive della firma/timbro;

Quando sizeRule è vuoto e height e width non sono vuoti, il sigillo/timbro viene applicato in base alle dimensioni specificate;

Quando sizeRule non è vuoto, il sigillo/timbro viene applicato in base al metodo di visualizzazione specificato.

height

int

false

Altezza del controllo di firma, applicabile quando fieldType è signature/stamp, l'unità è px, supporta solo l'inserimento di numeri interi positivi, predefinito auto (ovvero dimensione automatica del sistema);

Quando fieldType=signature, l'intervallo impostabile è 20-250px;

Quando fieldType=stamp, l'intervallo impostabile è 30-280px;

width

int

false

Larghezza del controllo di firma, applicabile quando fieldType è signature/stamp, l'unità è px, supporta solo l'inserimento di numeri interi positivi, predefinito auto (ovvero dimensione automatica del sistema);

Quando fieldType=signature, l'intervallo impostabile è 20-250px;

Quando fieldType=stamp, l'intervallo impostabile è 30-280px;

signatureOptions

string

false

Opzioni del controllo firma. Applicabile solo quando fieldType è signature

Parametri accettabili:

template: Firma modello

handDrawn: Firma disegnata a mano

upload: Carica immagine firma locale

È possibile selezionare più opzioni, separate da ",", per impostazione predefinita sono tutte selezionate

movable

boolean

false

Consenti lo spostamento della posizione durante la firma, predefinito false

false - Non consentire al firmatario di regolare la posizione dei propri controlli di firma

true - Consenti al firmatario di regolare la posizione dei propri controlli di firma

allowedOptions

array

false

Opzioni consentite per l'approvazione del firmatario, applicabile quando fieldType è approval. Il valore predefinito è ["approve", "decline"]

approve- Accetta

decline- Rifiuta

pageNo

string

false

Numero di pagina di firma; i numeri di pagina consecutivi sono collegati con "-", i numeri di pagina singoli sono collegati con ","

Esempio: 1-3,6-10

posX

float

false

Coordinata sull'asse x

【注意】若fieldType为signature，则坐标位置指签名区Angolo in basso a sinistra；

Se fieldType è stamp, la posizione delle coordinate si riferisce all'area del timbroPunto centralePosizione

Dal 3 febbraio 2026, se fieldType è signature o stamp, la posizione delle coordinate si riferisce alla posizione del punto centrale dell'area del timbro.

posY

float

false

Coordinata dell'asse y

【Attenzione】Se fieldType è signature, la posizione delle coordinate si riferisce all'area della firmaAngolo in basso a sinistra；

Se fieldType è stamp, la posizione delle coordinate si riferisce all'area del timbroPunto centralePosizione

Dal 3 febbraio 2026, se fieldType è signature o stamp, la posizione delle coordinate si riferisce alla posizione del punto centrale dell'area del timbro.

fillConfigs

array

false

Compila le informazioni del controllo

fieldName

string

false

Nome del controllo, limite di 128 caratteri

required

boolean

false

Obbligatorio o meno, obbligatorio per impostazione predefinita

true-Obbligatorio

false-Non obbligatorio

fieldType

string

false

Tipo di controllo:

1-Testo a riga singola

15-Casella di controllo

textField

object

false

Proprietà del controllo testo

overflowType

int

false

Valido solo per il testo, predefinito 1

1-Ridimensionamento automatico della dimensione del carattere

2-Limita l'input

minFontSize

float

false

Valido solo per il testo, valido solo per overflowType=1, predefinito 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

Larghezza del controllo, predefinita 160px

font

int

false

Valido solo per il testo, carattere, predefinito 宋体

1-宋体

2-新宋体

4-黑体

5-楷体

6-Arial

7-Helvetica

9-Times New Roman

10-仿宋

11-Georgia

12-Monospace

fontSize

float

false

Valido solo per il testo, dimensione del carattere, predefinita 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

Valido solo per il testo, colore esadecimale, predefinito nero #000

bold

boolean

false

Valido solo per il testo, se il carattere è in grassetto, predefinito false

true-Grassetto

false-Non grassetto

italic

boolean

false

Valido solo per il testo, se in corsivo, predefinito false

true-Corsivo

false-Non corsivo

underline

boolean

false

Valido solo per il testo, se il carattere deve essere sottolineato, predefinito false

true-Aggiungi sottolineatura

false-Non aggiungere sottolineatura

lineThrough

boolean

false

Valido solo per il testo, se aggiungere una linea di cancellazione, predefinito false

true-Aggiungi linea di cancellazione

false-Non aggiungere linea di cancellazione

horizontalAlignment

string

false

Valido solo per il testo, formato di allineamento orizzontale, predefinito left

LEFT-Allineato a sinistra

CENTER-Centrato

RIGHT-Allineato a destra

tickBoxField

object

false

Attributi della casella di controllo

tickOptions

array

false

Valido solo per tickBox, predefinito 1

1-Spunta

2-Croce

posX

float

false

Coordinata X orizzontale della posizione del controllo

posY

float

false

Coordinata Y verticale della posizione del controllo

pageNo

string

false

Numero di pagina in cui si trova il controllo

signDateConfigs

array

false

Informazioni sulla posizione della data di firma

movable

boolean

false

Consenti lo spostamento della posizione durante la firma, predefinito false

false-Non consentire al firmatario di modificare la posizione del proprio controllo di firma

true-Consenti al firmatario di modificare la posizione del proprio controllo di firma

pageNo

string

false

Numero di pagina di firma; i numeri di pagina consecutivi sono collegati con "-", i numeri di pagina singoli sono collegati con ","，Esempio: 1-3, 6-10;

Se non è continuo, inserire "," per separare.

posX

float

false

Offset dell'asse x, l'angolo inferiore sinistro della pagina è l'origine delle coordinate

posY

float

false

Offset dell'asse y, l'angolo inferiore sinistro della pagina è l'origine delle coordinate

signDateFormat

string

false

Formato della data di firma, il formato predefinito è aaaa-MM-gg

Formati supportati:

aaaa年MM月gg日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy

Nome del parametro

Tipo

Descrizione

envelopeId

string

ID busta

CCInfos

array

Raccolta di informazioni sui destinatari in copia conoscenza

userEmail

string

Indirizzo email del destinatario in copia conoscenza

userName

string

Nome del destinatario in copia conoscenza

signFiles

array

Raccolta di informazioni sui file firmati

fileKey

string

FileKey del file firmato

attachments

array

Raccolta allegati busta

fileKey

string

File fileKey

signerInfos

array

Informazioni sulla firma

businessId

string

Numero di pratica personalizzato dallo sviluppatore, limite di lunghezza 500

userEmail

string

Indirizzo email del firmatario

userName

string

Nome del firmatario

signOrder

int

Ordine di firma del firmatario, minimo 1

accessCode

string

Password di accesso alla pagina di firma