Invio rapido di un inviluppo

POST /esignglobal/v1/envelope/createAndStart

Descrizione dell'interfaccia

Avvio rapido del pacco, include funzionalità come la creazione del pacco, l'aggiunta di documenti in attesa di firma e l'aggiunta dei firmatari.

Supporto per l'avvio automatico: Dopo il successo della chiamata all'interfaccia, il pacco viene creato e avviato con successo; a questo punto, il pacco inizia automaticamente il flusso di lavoro.
Supporto per la terminazione automatica: Una volta che tutte le parti firmatarie hanno completato la firma, il pacco termina automaticamente.

Parametri di richiesta

Nome del parametro					Tipo	Obbligatorio	Descrizione
subject					string	true	Oggetto del pacco Esempio: "Lettera di offerta"
remark					string	false	Note del pacco, limite di lunghezza 1000 caratteri
signerSettings					object	false	Operazioni consentite ai firmatari
	allowTransfer				boolean	false	Se è consentito al firmatario di trasferire la busta a un altro per la firma, il valore predefinito è false true: consente al firmatario nella busta di avere il potere di trasferire la busta ad altri; false: non consente al firmatario nella busta di avere il potere di trasferire la busta ad altri;
	allowModifyName				boolean	false	Se è consentito alla parte firmataria di modificare il nome, valido solo per le firme dei modelli, il valore predefinito è false true: consente al firmatario di modificare il nome false: non consente al firmatario di modificare il nome
expireAfterSeconds					long	false	Scadenza della busta, dopo quanti secondi scade la busta Intervallo di scadenza: da 86.400 secondi (1 giorno) a 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: da 3.600 secondi (1 ora) a 259.200 secondi (30 giorni)
autoFinish					boolean	false	Controlla se la busta termina automaticamente, il valore predefinito è true true- La busta termina automaticamente false- La busta termina manualmente
CCInfos					array	false	Collezione delle informazioni sui destinatari in copia
	userEmail				string	false	Indirizzo email del destinatario in copia
	userName				string	false	Nome del destinatario in copia, utilizzato per visualizzare il nome del destinatario in copia sulla pagina di firma e sul pacco. [Attenzione]: non deve contenere i seguenti 9 caratteri speciali: / \ : * " < > \| ? nonché tutte le emoji
	customizeSettings				object	false	Configurazione personalizzata
		notificationSettings			object	false	Configurazione personalizzata per notifiche
			notificationLanguage		string	false	Lingua della notifica, di default utilizza la configurazione 'Lingua predefinita delle notifiche' en-US Inglese zh-CN Cinese semplificato zh-Hant Cinese tradizionale ja-JP Giapponese es-MX Spagnolo pt-PT Portoghese th-TH Thai 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	Collezione di informazioni sui documenti firmati, ordinata secondo l'ordine di aggiunta dei documenti.
	fileKey				string	true	fileKey del documento firmato, supporta solo il formato PDF
	documentFields				array	false	Elenco dei controlli dimensionali del documento. Utilizzato per aggiungere controlli dimensionali del documento non associati a firmatari su un documento specifico.
		fieldType			string	false	Tipo di controllo. Inserire eMeterai per indicare il controllo relativo alla tassa di bollo indonesiana.
		pageNo			string	false	Numero della pagina in cui si trova il controllo. Il controllo relativo alla tassa di bollo indonesiana supporta solo una singola pagina specificata; è necessario inserire un numero di pagina singolo, non sono supportati formati multipli continui o non continui come 1-3, 1,3 ecc.
		posX			float	false	Spostamento sull'asse x, con l'angolo in basso a sinistra della pagina come origine delle coordinate. L'intervallo delle coordinate è coerente con quello degli altri controlli.
		posY			float	false	Spostamento sull'asse y, con l'angolo in basso a sinistra della pagina come origine delle coordinate. L'intervallo delle coordinate è coerente con quello degli altri controlli.
attachments					array	false	Collezione di allegati busta, l'ordine di visualizzazione corrisponde all'ordine di aggiunta dei file.
	fileKey				string	false	fileKey del file
signerInfos					array	true	Collezione delle informazioni sui firmatari
	businessId				string	false	Numero di riferimento aziendale personalizzato dallo sviluppatore, limite di lunghezza 500
	roleTypes				array	false	Modalità di operazione del firmatario, valore predefinito `["sign", "fill"]` fill-compilazione sign-firma
	deliveryMethods				string	false	Modalità di notifica, il valore predefinito è auto auto- quando viene passato userEmail, invia una notifica via email; quando viene passato phoneNumber, invia una notifica SMS none- non inviare notifiche tramite messaggio email- inviare notifica via email sms- inviare notifica SMS WhatsApp- inviare notifica WhatsApp
	userEmail				string	false	Indirizzo email del firmatario
	userName				string	true	Nome del firmatario, utilizzato per visualizzare il nome del firmatario nella pagina di firma e nell'esposizione esterna della busta. [Nota] Non deve contenere i seguenti 9 caratteri speciali: / \ : * " < > \| ? e tutte le emoji
	minimumReadingDuration				int	false	Imposta il tempo di countdown obbligatorio per la lettura nella pagina delle impostazioni; il valore predefinito è 0 (unità: secondi, massimo 999) 0 o l'omissione del parametro indica che non è attivato, quindi non è necessario il countdown di lettura
	readToEndRequired				boolean	false	Indica se è obbligatorio leggere fino alla fine. Valore predefinito: false; true indica attivazione; false o l'omissione del parametro indicano disattivazione.
	phoneNumber				object	false	Numero di telefono, vuoto per impostazione predefinita Parametro obbligatorio quando è necessaria una notifica SMS; devono essere forniti sia countryCode che number
		countryCode			string	false	Codice internazionale del paese/regione, senza includere il simbolo '+'
		number			string	false	Nessuna convalida del formato, lunghezza massima limitata a 13 cifre
	customizeSettings				object	false	Configurazione personalizzata
		notificationSettings			object	false	Configurazione personalizzata per le notifiche
			customizeMessage		string	false	Notifiche dedicate ai messaggi, limite di caratteri: 200
			notificationLanguage		string	false	Lingua della 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, minimo 1. Per le firme non ordinate è possibile assegnare lo stesso valore di ordine.
	anySigner				boolean	false	Se è supportata la firma da chiunque, il valore predefinito è false true- Per lo stesso signOrder, è sufficiente la firma di una sola persona false- Per lo stesso signOrder, è richiesta la firma di tutte le persone
	authModes				string	false	Metodo di verifica, il valore predefinito è noAuth noAuth- Nessuna verifica accessCode- Verifica tramite password di firma sms- Verifica OTP via SMS idVerification- Verifica dell'identità con documento emailAuth- Verifica OTP via email digitalId- Verifica dell'identità elettronica whatsappAuth- Verifica OTP via WhatsApp
	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 distingue tra maiuscole e minuscole, può contenere lettere e numeri, lunghezza massima 45
			promptInfo		string	false	Messaggio di richiesta della password di accesso, non può contenere la password di accesso, lunghezza massima 30 caratteri, obbligatorio quando authModes=accessCode
		sms			object	false	Verifica OTP SMS, obbligatoria quando authModes=sms
			countryCode		string	false	Codice internazionale del paese/regione, senza il simbolo '+'
			number		string	false	Nessuna validazione del formato, lunghezza massima consentita di 13 caratteri
		idVerification			object	false	Impostazioni di verifica dell'identità tramite documento, obbligatorie quando authModes=idVerification
			name		string	false	Nome completo riportato sul documento d'identità del firmatario, lunghezza massima 100 caratteri
		emailAuth			object	false	Verifica OTP email, obbligatoria quando authModes=emailAuth
			authEmail		string	false	Indirizzo email per la verifica dell'identità del firmatario
		digitalId			array	false	Verifica dell'identità digitale, obbligatoria quando authModes=digitalId
			authApp		string	false	App utilizzata per la verifica dell'identità digitale singpass- Utilizzo di Singpass per l'autenticazione dell'identità iamsmart-Autenticazione dell'identità tramite i AM Smart
			idNumber		string	false	Numero del documento d'identità del firmatario in attesa di verifica Quando authApp=singpassla regola di input è: lettera maiuscola + 7 o 8 cifre numeriche + lettera maiuscola Quando authApp=iamsmartla regola di input è: 1. Una lettera maiuscola (A-Z) o due lettere maiuscole (AA-ZZ) come inizio della sequenza; 2. Seguite da 6 cifre numeriche; 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	Codice internazionale del paese/regione, senza il simbolo '+'
			number		string	false	Nessuna convalida del formato, lunghezza massima limitata a 13 caratteri
	digitalSignature				boolean	false	Se abilitare la firma digitale, valore predefinito false true - abilitato, false - disabilitato
	freeFormSign				boolean	false	Se il firmatario può applicare la firma liberamente, valore predefinito false Note aggiuntive: Quando freeFormSign è impostato su true, non è necessario fornire altri parametri sotto sealInfos. Se vengono forniti contemporaneamente, freeFormSign ha 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 la posizione del controllo per procedere con la firma elettronica.
			fieldType		string	false	Tipo di controllo, valore predefinito: signature signature- Controllo di firma stamp- Controllo timbro approval- Controllo approvazione
			required		boolean	false	Obbligatorietà, valore predefinito: obbligatorio true- Obbligatorio false- Facoltativo
			signFieldStyle		string	false	Modalità di applicazione del timbro nel controllo di firma, valore predefinito: normalSeal. normalSeal-Timbro ordinario pagingSeal-Timbro di giunzione Solo i controlli firma e timbro supportano la configurazione del timbro di giunzione.
			pagingSealMode		string	false	Intervallo di pagine per l'apposizione del timbro di giunzione, valore predefinito: all. all-Tutte le pagine assignedPages-Pagine specifiche even-Pagine pari odd-Pagine dispari Configurabile solo quando signFieldStyle=pagingSeal.
			sizeRule		string	false	Modalità di visualizzazione delle dimensioni dell'area di firma originalSize-Apposizione 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, l'apposizione avviene in base alle dimensioni effettive della firma/timbro; Quando sizeRule è vuoto ma height e width non lo sono, l'apposizione avviene in base alle dimensioni specificate; Quando sizeRule non è vuoto, l'apposizione avviene in base alla modalità di visualizzazione specificata; Il timbro di sovrapposizione non richiede la specifica di questo parametro; il timbro viene applicato in base alle dimensioni effettive.
			height		int	false	Altezza del controllo di firma, applicabile quando fieldType è signature/stamp, espressa in pixel. Accetta solo numeri interi positivi; il valore predefinito è auto (dimensioni automatiche del sistema); Quando fieldType=signature, l'intervallo impostabile è da 20 a 250 px; Quando fieldType=stamp, l'intervallo impostabile è da 30 a 280 px; Il timbro di sovrapposizione non richiede la specifica di questo parametro.
			width		int	false	Larghezza del controllo di firma, applicabile quando fieldType è signature/stamp, espressa in pixel. Accetta solo numeri interi positivi; il valore predefinito è auto (dimensioni automatiche del sistema); Quando fieldType=signature, l'intervallo impostabile è da 20 a 250 px; Quando fieldType=stamp, l'intervallo impostabile è da 30 a 280 px; Il timbro di sovrapposizione non richiede la specifica di questo parametro.
			signatureOptions		string	false	Opzioni del controllo di firma. Applicabile solo quando fieldType è signature Valori ammissibili: template: firma tramite modello handDrawn: firma disegnata a mano upload: caricamento locale dell'immagine della firma È possibile selezionare più opzioni, separate da ","; il valore predefinito è la selezione di tutte le opzioni
			movable		boolean	false	Consente lo spostamento della posizione al momento della firma, valore predefinito false false: non consente al firmatario di regolare la posizione dei propri controlli di firma true: consente al firmatario di regolare la posizione dei propri controlli di firma
			allowedOptions		array	false	Opzioni che consentono al firmatario di approvare, applicabili quando fieldType è approval. Valore predefinito: ["approve", "decline"] approve- Approva decline- Rifiuta
			pageNo		string	false	Pagine della firma; le pagine consecutive sono unite da "-", le pagine singole da "," Esempio: 1-3,6-10 Quando pagingSealMode=assignedPages, specifica l'intervallo di pagine per il timbro di sovrapposizione. Il timbro di sovrapposizione può essere utilizzato solo su documenti con più di una pagina.
			posX		float	false	Coordinate sull'asse x [Nota] Se fieldType è signature, le coordinate indicano l'area della firmaAngolo in basso a sinistra； Se fieldType è stamp, le coordinate indicano l'area del timbroPunto centralePosizione A partire dal 3 febbraio 2026, quando fieldType è signature o stamp, la posizione delle coordinate indica il punto centrale dell'area di timbratura. Per il timbro di sovrapposizione (骑缝章) si può trasmettere 0, ma non null; il controllo è fissato sul bordo destro del documento.
			posY		float	false	Coordinate sull'asse y [Nota] Se fieldType è signature, la posizione delle coordinate indica l'area di firmaAngolo in basso a sinistra； Se fieldType è stamp, la posizione delle coordinate indica l'area di timbraturaPunto centralePosizione A partire dal 3 febbraio 2026, quando fieldType è signature o stamp, la posizione delle coordinate indica il punto centrale dell'area di timbratura.
		fillConfigs			array	false	Compilare le informazioni del controllo
			fieldName		string	false	Nome del controllo, limite di caratteri: 128
			required		boolean	false	Obbligatorio o meno, obbligatorio per impostazione predefinita true-obbligatorio false-non obbligatorio
			fieldType		string	false	Tipo di controllo: 1-Testo su una riga 15-Casella di controllo
			textField		object	false	Proprietà del controllo testo
				overflowType	int	false	Si applica solo a text, valore predefinito 1 1-Riduzione automatica della dimensione del carattere 2-Limitazione dell'input
				minFontSize	float	false	Si applica solo a text e solo quando overflowType=1, valore 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, valore predefinito 160px
				font	int	false	Si applica solo a text, tipo di carattere, valore predefinito SimSun 1-SimSun 2-New SimSun 4-HeiTi 5-KaiTi 6-Arial 7-Helvetica 9-Times New Roman 10-FangSong 11-Georgia 12-Monospace
				fontSize	float	false	Si applica solo a text, dimensione del carattere, valore predefinito 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	Si applica solo al testo, colore in esadecimale, predefinito nero #000
				bold	boolean	false	Si applica solo al testo, se il carattere è in grassetto, predefinito false true-grassetto false-non grassetto
				italic	boolean	false	Si applica solo al testo, se il carattere è in corsivo, predefinito false true-corsivo false-non corsivo
				underline	boolean	false	Si applica solo al testo, se il carattere ha la sottolineatura, predefinito false true-con sottolineatura false-senza sottolineatura
				lineThrough	boolean	false	Si applica solo al testo, se il carattere ha il barrato, predefinito false true-con barrato false-senza barrato
				horizontalAlignment	string	false	Si applica solo al testo, allineamento orizzontale centrato, predefinito left LEFT-allineato a sinistra CENTER-Centrato RIGHT-A destra
			tickBoxField		object	false	Proprietà della casella di controllo
				tickOptions	array	false	Si applica solo a tickBox, valore predefinito 1 1-Voce selezionata 2-Voce non selezionata
			posX		float	false	Coordinate X orizzontali della posizione del controllo
			posY		float	false	Coordinate Y verticali 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	Consente lo spostamento della posizione durante la firma, valore predefinito false false-Non è consentito al firmatario di regolare la posizione dei propri controlli di firma true-È consentito al firmatario di regolare la posizione dei propri controlli di firma
			pageNo		string	false	Numeri di pagina da firmare; per pagine consecutive utilizzare "-" come separatore, per pagine singole utilizzare ",", ad esempio: 1-3, 6-10; Se le pagine non sono consecutive, utilizzare "," come separatore.
			posX		float	false	Spostamento sull'asse x, con l'origine delle coordinate nell'angolo in basso a sinistra della pagina
			posY		float	false	Spostamento sull'asse y, con l'origine delle coordinate nell'angolo in basso a sinistra della pagina
			signDateFormat		string	false	Formato della data di firma, il formato predefinito è yyyy-MM-dd Supporta i seguenti formati: yyyy anno MM mese dd giorno yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MMM dd,yyyy dd MMM yyyy

Esempio di richiesta

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

Parametri di risposta

Nome del parametro		Tipo	Descrizione
envelopeId		string	ID del pacco
CCInfos		array	Collezione delle informazioni sui destinatari in copia
	userEmail	string	Indirizzo email del destinatario in copia
	userName	string	Nome del destinatario in copia
signFiles		array	Collezione delle informazioni sui documenti da firmare
	fileKey	string	Chiudi il file con fileKey
attachments		array	Collezione di allegati del pacco
	fileKey	string	File con fileKey
signerInfos		array	Informazioni sulla firma
	recipientId	string	ID del firmatario
	businessId	string	Numero di riferimento aziendale personalizzato dallo sviluppatore, limite di lunghezza 500
	userEmail	string	Indirizzo email del firmatario
	userName	string	Nome del firmatario
	signUrl	string	URL del link di firma
	signOrder	int	Ordine di firma del firmatario, minimo 1
	accessCode	string	Password di accesso alla pagina di firma

Esempio di risposta

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