Dettagli del modello di busta

GET /esignglobal/v1/envelopeTemplates/envelopeTemplateDetail

Descrizione dell'interfaccia

Recuperare le proprietà dettagliate di un "modello di busta" preconfigurato sul lato client (include la struttura del file, i ruoli dei partecipanti e tutte le chiavi identificative dei controlli predefiniti).

Parametri della richiesta

Nome del parametro

Tipo

Obbligatorio

Descrizione

envelopeTemplateId

string

true

ID del modello di busta

queryComponents

boolean

false

Indica se è necessario recuperare le informazioni sui controlli, valore predefinito false

true-Sì

false-No

Esempio di richiesta

 {
 	"envelopeTemplateId":"dc4be9641a3145bea97809018d7a9180",
 	"queryComponents":true
 }

Parametri di risposta

Nome del parametro					Tipo	Descrizione
code					int	Codice operativo, 0 indica successo, un valore diverso da 0 indica un errore.
message					string	Informazioni operative Valutare la situazione dell'errore in base a code, non fare affidamento sulla corrispondenza di message, poiché message potrebbe essere modificato.
data					object	Dati operativi
	envelopeTemplateId				string	ID modello involucro
	envelopeTemplateName				string	Nome del modello di flusso di lavoro
	envelopeTemplateStatus				int	Stato di attivazione del modello di flusso di lavoro 1-Attivo 0-Disattivato
	digitalSignature				boolean	Abilita firma digitale true-Attivato false-Disabilitato
	signFiles				array	Informazioni sul file
		documentId			string	ID del file
		fileName			string	Nome del file
	participants				array	Parte coinvolta
		participantId			string	ID della parte coinvolta
		participantSetMode			string	Requisiti di partecipazione (modalità di assegnazione dei partecipanti) presetSigner- Specificare durante l'uso del modello (assegnato autonomamente dall'utilizzatore del modello) dedicateSigner- Membro fisso (fissato nel modello e non modificabile) sender- Mittente
		participantInfos			object	Parte individuale
			userEmail		string	Email del firmatario
			phoneNumber		object	Numero di telefono, vuoto per impostazione predefinita Parametro obbligatorio per le notifiche SMS, devono essere inseriti sia countryCode che number
				countryCode	string	Codice internazionale del Paese o della regione, non è necessario inserire il “+”
				number	string	Nessuna convalida del formato, lunghezza massima di 13 caratteri
			userName		string	Nome della persona
			deliveryMethod		string	Modalità di notifica auto-invia notifica via email quando viene passato userEmail, invia notifica SMS quando viene passato phoneNumber none-non inviare notifiche messaggio email-invia notifica via email sms-invia notifica SMS WhatsApp-invia notifica WhatsApp
			customizeSettings		object	Configurazione personalizzata
				customizeMessage	string	Messaggio dedicato Limite massimo 1000 caratteri
				notificationLanguage	string	Lingua della notifica, predefinito inglese en-US Inglese zh-CN Cinese semplificato zh-Hant Cinese tradizionale ja 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	Ordine di firma 1-255 I partecipanti diversi possono essere ripetuti
		willingnessAuthModes			string	Metodo di intento del firmatario, separato da virgole inglesi noAuth-Nessuna verifica accessCode-Verifica tramite codice di firma sms-Verifica OTP SMS idVerification-Verifica documento d'identità emailAuth-Verifica OTP email digitalId-Autenticazione identità digitale whatsappAuth-Verifica OTP WhatsApp
			accessCode		object	Impostazione codice di firma, obbligatorio quando authModes=accessCode
				accessCode	string	Contenuto del codice, non distingue tra maiuscole e minuscole, può contenere lettere e numeri, lunghezza massima 45
				promptInfo	string	Testo di richiesta per il codice di accesso, non deve contenere il codice di accesso, lunghezza massima 30, obbligatorio quando authModes=1.
			sms		object	Verifica OTP SMS, obbligatorio quando authModes=sms
				countryCode	string	Codice internazionale del Paese o della regione, non è necessario inserire il simbolo '+'
				number	string	Nessuna verifica del formato, limite massimo di lunghezza 13 caratteri
			idVerification		object	Impostazioni verifica documento d'identità, obbligatorio quando authModes=idVerification
				name	string	Nome completo riportato sul documento d'identità del firmatario, lunghezza massima 100 caratteri
			emailAuth		object	Verifica OTP email, obbligatorio quando authModes=emailAuth
				authEmail	string	Indirizzo email per l'autenticazione del firmatario
			digitalId		array	Verifica dell'identità elettronica, obbligatoria quando authModes=digitalId
				authApp	string	App utilizzata per la verifica dell'identità elettronica singpass - Utilizza Singpass per l'autenticazione dell'identità iamsmart - Utilizza iAM SMART per l'autenticazione
				idNumber	string	Numero del documento d'identità del firmatario da verificare
			whatsappAuth		object	Validazione OTP WhatsApp, obbligatoria quando authModes=whatsappAuth
				countryCode	string	Codice internazionale del Paese o della regione, non è necessario inserire il simbolo "+"
				number	string	Nessuna convalida del formato, lunghezza massima limitata a 13 caratteri
		components			object	Informazioni sul controllo
	copiers				array	Imposta i destinatari in copia
		copierId			string	ID della parte coinvolta
		editable			boolean	Consenti modifica all'avvio
		CCInfos			object	Informazioni sui destinatari in copia
			userEmail		string	Indirizzo email
			userName		string	Nome personale
			customizeSettings		object	Configurazione personalizzata
				notificationSettings	object	Configurazione personalizzata per notifiche
				notificationLanguage	string	Lingua delle notifiche, impostazione predefinita: inglese en-US Inglese zh-CN Cinese semplificato zh-Hant Cinese tradizionale ja Giapponese ES-MX Spagnolo
	attachments				array	Informazioni allegato
		editable			boolean	Consenti modifica all'avvio
		fileKey			string	filekey allegato
		fileName			string	Nome allegato
		downloadUrl			string	Link di download del PDF bozza del documento, valido per 60 minuti.
components					array	Elenco controlli
	documentId				string	filekey del file di appartenenza del controllo
	componentId				string	ID del controllo
	componentKey				string	Key del controllo (identificatore del controllo inserito dall'utente durante la configurazione del modello di file)
	componentName				string	Nome del controllo
	componentType				string	Tipo di controllo 1, Testo 2, Numero 3, Data 6, Area di firma standard 8, Testo multilinea 9, Selezione multipla 10, Selezione singola 11, Immagine 14, Menu a discesa 15, Casella di controllo 20, Area timbro 21, Area di approvazione 22, Data di firma 23, Email 100, Renminbi
	componentDefaultValue				string	Valore predefinito del controllo
	componentPosition				object	Posizione del controllo
		componentPositionX			float	Coordinata orizzontale della posizione del controllo
		componentPositionY			float	Coordinata verticale della posizione del controllo
		componentPageNum			int	Numero di pagina del controllo
	componentSize				object	Dimensioni del controllo
		componentWidth			int	Larghezza del controllo (distanza dai margini sinistro e destro del rettangolo, unità in px)
		componentHeight			int	Altezza del controllo (distanza dai margini superiore e inferiore del rettangolo, unità in px)
	componentTextFormat				object	Stile dei caratteri del controllo
		font			int	Font di riempimento, predefinito 1, 1-Songti, 2-Xin Songti, 4-Heiti, 5-Kaiti
		fontSize			float	Dimensione del carattere di riempimento, predefinito 12 pt 42 pt 36 pt 26 pt 24 pt 22 pt 19 pt 16 pt 15 pt 14 pt 12 pt 10,5 pt 9 pt
		textColor			string	Colore del carattere, predefinito #000000 nero
		bold			boolean	Grassetto, predefinito false true-Sì false-No
		italic			boolean	Se in corsivo, predefinito false true-Sì false-No
		horizontalAlignment			string	Allineamento orizzontale, predefinito 1-allineato a sinistra LEFT-allineato a sinistra CENTER-centrato RIGHT-allineato a destra
		verticalAlignment			string	Allineamento verticale, predefinito 1-allineato in alto (per testo su più righe) TOP-allineato in alto MIDDLE-centrato BOTTOM-allineato in basso
		textLineSpacing			float	Interlinea, predefinita 1.0, supporta al massimo una cifra decimale, valore massimo 2.0 (per testo su più righe)
	required				boolean	Obbligatorio true-obbligatorio false-non obbligatorio
	componentMaxLength				string	Lunghezza massima compilabile del controllo (numero di caratteri cinesi)
	componentSpecialAttribute				object	Proprietà specifiche del controllo
		numberFormat			string	Formato numerico (controllo numerico) Intero: 0 Con una cifra decimale: 0.0 Con due cifre decimali: 0.00
		dateFormat			string	Formato data (controllo data)
		imageType			string	Tipo di immagine (controllo immagine) IDCard_widthwise Carta d'identità Orizzontale Blocca rapporto d'aspetto IDCard_longitudinal Carta d'identità Verticale Blocca rapporto d'aspetto other Altro Non blocca il rapporto d'aspetto
		options			array	Opzioni (controllo a discesa, controllo a scelta singola, controllo a scelta multipla)
			optionOrder		int	Ordine delle opzioni
			optionContent		string	Contenuto dell'opzione
			selected		boolean	Selezionato per impostazione predefinita
			optionPositionX		float	Coordinate X dell'elemento figlio rispetto al bordo del controllo padre
			optionPositionY		float	Coordinate Y dell'elemento figlio rispetto al bordo del controllo padre
			optionWidth		float	Larghezza dell'elemento figlio
			optionHeight		float	Altezza dell'elemento figlio
	signField				object	Proprietà dell'area di firma e sigillo standard
		fieldStyle			int32	Stile dell'area di firma e sigillo 1-Area di firma e sigillo a pagina singola 2-Area di firma e sigillo tra le pagine
		sizeRule			int	Specifiche del timbro 1-Sigilla secondo le dimensioni reali del timbro 2-Dimensioni personalizzate (adattate in base ad altezza e larghezza dell'area di firma)
		movable			boolean	true-È possibile spostare durante la firma false-Non è possibile spostare durante la firma
	stampField				object	Attributi dell'area del timbro
		fieldStyle			int	Stile dell'area di firma 1-Area di firma su pagina singola 2-Area di firma tra le pagine
		sizeRule			int	Specifiche del timbro 1-Firma con specifiche reali del timbro 2-Specifiche personalizzate (adattate in base ad altezza e larghezza dell'area di firma)
		movable			boolean	true-Spostabile durante la firma false-Non spostabile durante la firma
	signDateField				object	Attributi della data di firma
		dateFormat			string	Formato data: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	approvalField				object	Attributi dell'area di approvazione
		allowedOptions			array	Opzioni che consentono al firmatario di approvare, applicabili quando fieldType è approval. Il valore predefinito è ["approve", "decline"] approve-Approva decline-rifiuto

Esempio di risposta

{
  "code": "0",
  "data": {
    "envelopeTemplateName": "test",
    "signFiles": [
      {
        "fileDownloadUrl": "https://******",
        "fileName": "***.pdf",
        "documentId": "$eac****-d6f8-4b6b-bafe-******$3328404894"
      }
    ],
    "attachments": [],
    "digitalSignature": false,
    "envelopeTemplateStatus": 1,
    "independentComponents": [],
    "envelopeCategoryId": null,
    "envelopeTemplateId": "dc4be9641a3145bea97809018d7a9180",
    "participants": [
      {
        "participantFlag": "",
        "idVerification": null,
        "components": [
          {
            "componentType": "10",
            "componentId": "556b60f7bd324428908b41f3bbec8c54",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 485.42538,
              "componentPositionX": 35.96627,
              "componentPageNum": "1"
            },
            "componentSpecialAttribute": {
              "options": [
                {
                  "optionContent": "***",
                  "optionHeight": 32.923893,
                  "optionOrder": 0,
                  "optionPositionY": 85.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项二",
                  "optionHeight": 15.0,
                  "optionOrder": 1,
                  "optionPositionY": 60.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项三",
                  "optionHeight": 15.0,
                  "optionOrder": 2,
                  "optionPositionY": 35.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项四",
                  "optionHeight": 15.0,
                  "optionOrder": 3,
                  "optionPositionY": 10.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                }
              ],
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 128,
              "componentWidth": 144
            },
            "signDateField": null,
            "required": true,
            "stampField": null,
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "单选1",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          },
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "****",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "42750b92c7a***05134dd5342",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "presetSigner",
        "emailAuth": null
      },
      {
        "participantFlag": "***",
        "idVerification": null,
        "components": [
          {
            "componentType": "20",
            "componentId": "7c401b43cdc94b61a7813aa58ac82bbf",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 327.15793,
              "componentPositionX": 109.17395,
              "componentPageNum": "2"
            },
            "componentSpecialAttribute": {
              "options": null,
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 150,
              "componentWidth": 150
            },
            "signDateField": null,
            "required": true,
            "stampField": {
              "movable": false,
              "sizeRule": 1,
              "fieldStyle": 1
            },
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "图章区",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          }
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "***",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "b055dfce00c5******40cdabb23822ea4",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "dedicateSigner",
        "emailAuth": null
      }
    ],
    "copiers": []
  },
  "message": "SUCCESS"
}