Avvia busta rapidamente

POST /esignglobal/v1/envelope/createAndStart

Descrizione dell'interfaccia

Avvia rapidamente una busta, incluse le funzioni di creazione della busta, aggiunta di documenti da firmare e aggiunta di firmatari.

Supporta l'avvio automatico：Dopo che la chiamata all'interfaccia ha avuto successo, la busta viene creata e aperta con successo e la busta inizia automaticamente a circolare.
Supporta la chiusura automatica：La busta si chiude automaticamente dopo che tutte le parti firmatarie hanno completato la firma.

Parametri di richiesta

Nome parametro					Tipo	Obbligatorio	Descrizione
subject					string	true	Oggetto della busta Esempio: “Offer Letter”
remark					string	false	Note sulla busta，Lunghezza massima 1000 caratteri
signerSettings					object	false	Operazioni consentite al firmatario
	allowTransfer				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;
	allowModifyName				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, predefinita inglese en-US Inglese zh-CN Cinese semplificato zh-Hant Cinese tradizionale ja-JP Giapponese ES-MX Spagnolo
signFiles					array	true	Raccolta di informazioni sui documenti da firmare, l'ordine di visualizzazione è l'ordine di aggiunta dei file.
	fileKey				string	true	fileKey del documento da firmare, supporta solo il formato PDF
attachments					array	false	Raccolta di allegati della busta, l'ordine di visualizzazione è l'ordine di aggiunta dei file.
	fileKey				string	false	fileKey del file
signerInfos					array	true	Raccolta di informazioni sui firmatari
	businessId				string	false	Numero identificativo dell'attività personalizzato dallo sviluppatore, limite di lunghezza 500
	deliveryMethods				string	false	Modalità di notifica, predefinita su auto auto- Invia una notifica via email quando viene passato userEmail, invia una notifica via SMS quando viene passato phoneNumber none- Non inviare notifiche di messaggi email- Invia una notifica via email sms- Invia una notifica via SMS WhatsApp- Invia una notifica WhatsApp
	userEmail				string	true	Indirizzo email del firmatario
	userName				string	true	Nome del firmatario, utilizzato per visualizzare il nome del firmatario sulla 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 via SMS, questo parametro è obbligatorio, è necessario passare sia countryCode che number
		countryCode			string	false	Prefisso internazionale del paese/regione, non è necessario passare il segno “+”
		number			string	false	Nessuna verifica del formato, solo limite di lunghezza massima di 13 cifre
	customizeSettings				object	false	Configurazione personalizzata
		notificationSettings			object	false	Configurazione personalizzata per le notifiche
			customizeMessage		string	false	Notifiche di messaggi dedicate, limite di 200 caratteri
			notificationLanguage		string	false	Lingua di notifica, predefinita inglese en-US Inglese zh-CN Cinese semplificato zh-Hant Cinese tradizionale ja Giapponese ES-MX Spagnolo
	signOrder				int	true	Ordine di firma del firmatario, minimo 1. Per le firme non ordinate, è possibile specificare lo stesso valore di ordine.
	anySigner				boolean	false	Supporta 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 noAuth-Non verificare accessCode-Utilizza la password di firma per la verifica sms- Verifica SMS OTP idVerification- Verifica documento d'identità emailAuth- Verifica email OTP digitalId- Verifica dell'identità elettronica
	authConfig				object	false	Impostazioni del metodo di verifica
		accessCode			object	false	Impostazioni della password di firma, obbligatorie quando authModes=accessCodeè
			accessCode		string	false	Contenuto della password, non fa distinzione tra maiuscole e minuscole, può contenere lettere e numeri, lunghezza massima 45
			promptInfo		string	false	Messaggio di suggerimento per la password di accesso, non può contenere la password di accesso, lunghezza massima 30, obbligatorio quando authModes=1.
		sms			object	false	Verifica SMS OTP, obbligatoria quando authModes=smsè
			countryCode		string	false	Codice internazionale del paese/regione, non è necessario inserire il simbolo “+”
			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à, obbligatorie quando authModes=idVerificationè
			name		string	false	Nome completo del firmatario come appare sul documento d'identità, lunghezza massima 100 caratteri
		emailAuth			object	false	Verifica OTP via email, obbligatoria quando authModes=emailAuthè impostato
			authEmail		string	false	Indirizzo email di verifica dell'identità del firmatario
		digitalId			array	false	Autenticazione dell'identità elettronica, obbligatoria quando authModes=digitalId
			authApp		string	false	APP utilizzata per l'autenticazione dell'identità elettronica singpass - Utilizza Singpass per l'autenticazione
			idNumber		string	false	Numero del documento d'identità del firmatario da verificare
	digitalSignature				boolean	false	Indica se abilitare la firma digitale, predefinito false true - Abilita, false - Non abilita
	freeFormSign				boolean	false	Indica se il firmatario può apporre liberamente 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	Firma del file fileKey
		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 su signature signature- Controllo firma stamp- Controllo timbro approval- Controllo approvazione
			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 timbro viene applicato in base alle dimensioni effettive della firma/timbro; Quando sizeRule è vuoto e height e width non sono vuoti, il timbro viene applicato in base alle dimensioni specificate; Quando sizeRule non è vuoto, il timbro viene applicato in base alla modalità di visualizzazione specificata.
			height		int	false	Altezza del controllo di firma, applicabile quando fieldType è signature/stamp, l'unità è px, supporta solo numeri interi positivi, predefinito su 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, unità in px, supporta solo l'inserimento di interi positivi, auto predefinito (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 di firma. Applicabile solo quando fieldType è signature Parametri accettabili: template: firma da modello handDrawn: firma disegnata a mano upload: carica immagine della 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, false predefinito false - non consentire al firmatario di regolare la posizione del proprio controllo di firma true - consentire al firmatario di regolare la posizione del proprio controllo 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	Pagine da firmare; pagine consecutive sono collegate con "-", pagine singole sono collegate con "," Esempio: 1-3,6-10
			posX		float	false	Coordinata asse x 【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.
			posY		float	false	Coordinata 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 A partire dal 3 febbraio 2026, per fieldType di tipo 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 text, predefinito 1 1-Riduzione automatica della dimensione del carattere 2-Limita l'input
				minFontSize	float	false	Valido solo per text, 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, tipo di carattere, predefinito 宋体 (SimSun) 1-宋体 (SimSun) 2-新宋体 (NSimSun) 4-黑体 (SimHei) 5-楷体 (KaiTi) 6-Arial 7-Helvetica 9-Times New Roman 10-仿宋 (FangSong) 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 in grassetto
				italic	boolean	false	Valido solo per il testo, se è in corsivo, predefinito false true-Corsivo false-Non corsivo
				underline	boolean	false	Si applica solo al testo, indica se aggiungere una sottolineatura al font, predefinito false true - Aggiungi sottolineatura false - Non aggiungere sottolineatura
				lineThrough	boolean	false	Si applica solo al testo, indica se aggiungere una linea barrata, predefinito false true - Aggiungi linea barrata false - Non aggiungere linea barrata
				horizontalAlignment	string	false	Si applica solo al testo, formato di allineamento orizzontale, predefinito left LEFT - A sinistra CENTER - Centrato RIGHT - A destra
			tickBoxField		object	false	Attributi della casella di spunta
				tickOptions	array	false	Si applica solo a 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 regolare la posizione del proprio controllo di firma true - Consenti al firmatario di regolare 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 Supporta il formato specificato: aaaa年MM月gg日 yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MM dd yyyy dd MM 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 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 documenti firmati
	fileKey	string	fileKey del documento firmato
attachments		array	Raccolta di allegati della busta
	fileKey	string	fileKey del file
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
	signUrl	string	Indirizzo del link di firma
	signOrder	int	Ordine di firma del firmatario, il valore 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"
}