Tingnan ang mga detalye ng template ng sobre

GET /esignglobal/v1/envelopeTemplates/envelopeTemplateDetail

Deskripsyon ng interface

Mag-query ng detalyadong mga katangian ng isang “envelope template” na paunang naka-configure sa panig ng pahina (kasama ang istruktura ng file, mga papel ng mga kalahok, at lahat ng mga preset na Key ng identifier ng kontrol).

Mga parameter ng request

Pangalan ng parameter

Uri

Kailangan

Paliwanag

envelopeTemplateId

string

true

ID ng envelope template

queryComponents

boolean

false

Kung kailangan mag-query ng impormasyon ng kontrol, default ay false

true-Oo

false-Hindi

Halimbawa ng request

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

Mga parameter ng response

Pangalan ng parameter					Uri	Paliwanag
code					int	Kodigo ng operasyon, ang 0 ay nangangahulugang tagumpay, ang hindi 0 ay nangangahulugang error.
message					string	Impormasyon ng operasyon Gamitin ang code upang matukoy ang error, iwasan ang pagtutugma ng message dahil maaari itong baguhin.
data					object	Data ng operasyon
	envelopeTemplateId				string	ID ng template ng envelope
	envelopeTemplateName				string	Pangalan ng template ng proseso
	envelopeTemplateStatus				int	Status ng availability ng template ng proseso 1-Aktibo 0-Inaktibo
	digitalSignature				boolean	I-enable ang digital signature true-Aktibo false-Hindi Aktibo
	signFiles				array	Impormasyon ng file
		documentId			string	ID ng file
		fileName			string	Pangalan ng File
	participants				array	Participante
		participantId			string	ID ng Participante
		participantSetMode			string	Mga Kinakailangan sa Pagsali (Paraan ng Pagtukoy sa mga Participante) presetSigner-Tinukoy kapag gumagamit ng template (sariling itatakda ng gumagamit ng template) dedicateSigner-Nakatakdang miyembro (nakapaloob sa template at hindi mababago) sender-Nagsimula
		participantInfos			object	Indibidwal na Participante
			userEmail		string	Email ng Nagpirmahan
			phoneNumber		object	Numero ng telepono, default ay walang laman Kinakailangang parameter kapag kailangan ng SMS na abiso, dapat ipasok ang countryCode at number pareho
				countryCode	string	Pandaigdigang code ng bansa/rehiyon, hindi kailangang magpasok ng "+"
				number	string	Walang pagpapatunay ng format, limitado lamang ang haba sa maximum na 13 karakter
			userName		string	Pangalan ng Indibidwal
			deliveryMethod		string	Paraan ng Abiso auto-kapag ipinasa ang userEmail, magpadala ng abiso sa email; kapag ipinasa ang phoneNumber, magpadala ng abiso sa SMS none-huwag magpadala ng abiso sa mensahe email-magpadala ng abiso sa email sms-magpadala ng abiso sa SMS WhatsApp-magpadala ng abiso sa WhatsApp
			customizeSettings		object	Pasadyang konfigurasyon
				customizeMessage	string	Eksklusibong mensahe Limitasyon ng karakter: 1000
				notificationLanguage	string	Wika ng abiso, default ay Ingles en-US Ingles zh-CN Simplipikadong Tsino zh-Hant Tradisyonal na Tsino ja Wikang Hapon es-MX Espanyol pt-PT Portuges th-TH Thai id-ID Indonesian vi-VN Vietnamese ms-MY Malay fil-PH Filipino de-DE Aleman fr-FR Pranses ru-RU Ruso it-IT Italyano ko-KR Koreano
		signOrder			int	Pagkakasunod-sunod ng pagpirma 1-255 Maaaring maulit ang mga kalahok
		willingnessAuthModes			string	Paraan ng pagpirmâ (opsyonal), hiwalayan gamit ang English comma noAuth-Walang pagpapatunay accessCode-Patunayan gamit ang signing password sms-Pagpapatunay ng SMS OTP idVerification-Pagpapatunay ng ID emailAuth-Pagpapatunay ng Email OTP digitalId-Pagpapatunay ng Digital na Identidad whatsappAuth-Pagpapatunay ng WhatsApp OTP
			accessCode		object	Konpigurasyon ng passcode sa pag-sign, required kapag ang authModes=accessCode
				accessCode	string	Nilalaman ng passcode, hindi sensitibo sa kapital at maliit na titik, maaaring maglaman ng mga letra at numero, maximum na haba ay 45
				promptInfo	string	Paalala sa access passcode, huwag isama ang access passcode, maximum na haba ay 30, required kapag ang authModes=1.
			sms		object	Pagpapatunay ng SMS OTP, required kapag ang authModes=sms
				countryCode	string	International code ng bansa o rehiyon, hindi kailangang lagyan ng “+”
				number	string	Walang format validation, limitado lamang ang maximum na haba na 13 karakter
			idVerification		object	Konpigurasyon ng pagpapatunay ng ID, required kapag ang authModes=idVerification
				name	string	Buong pangalan ng nag-sign sa ID, maximum na haba ay 100 karakter
			emailAuth		object	Pagpapatunay ng Email OTP, required kapag ang authModes=emailAuth
				authEmail	string	Email address ng nag-sign para sa pagpapatunay ng identidad
			digitalId		array	Veripikasyon ng digital na identidad, kinakailangan kapag ang authModes=digitalId
				authApp	string	APP na ginagamit para sa veripikasyon ng digital na identidad singpass-Gamitin ang Singpass para sa pagpapatunay ng identidad iamsmart-Gamitin ang iAM Smart para sa pagpapatunay
				idNumber	string	Numero ng ID card ng nag-sign na kailangang ipatunayan
			whatsappAuth		object	Pagpapatunay ng OTP sa whatsapp, kinakailangan kapag ang authModes=whatsappAuth
				countryCode	string	Code ng bansa o rehiyon, hindi na kailangang maglagay ng “+”
				number	string	Walang pag-check ng format, limitado lamang ang haba sa maximum na 13 karakter
		components			object	Impormasyon ng kontrol
	copiers				array	Itakda ang mga tinatanggap sa CC
		copierId			string	ID ng kalahok
		editable			boolean	May pahintulot bang pagbabago sa panahon ng paglunsad?
		CCInfos			object	Impormasyon ng mga tinatanggap sa CC
			userEmail		string	Email
			userName		string	Personal na pangalan
			customizeSettings		object	Pasadyang konfigurasyon
				notificationSettings	object	Pasadyang konfigurasyon para sa mga abiso
				notificationLanguage	string	Wika ng abiso, ang default ay Ingles en-US Ingles zh-CN Simpladong Tsino zh-Hant Tradisyonal na Tsino ja Hapones ES-MX Espanyol
	attachments				array	Impormasyon ng attachment
		editable			boolean	Pinapayagan ba ang pagbabago kapag nagsisimula?
		fileKey			string	attachment filekey
		fileName			string	Pangalan ng attachment
		downloadUrl			string	Link sa pag-download ng PDF na draft ng dokumento, valid sa loob ng 60 minuto.
components					array	Listahan ng mga kontrol
	documentId				string	File key ng kontrol
	componentId				string	ID ng kontrol
	componentKey				string	Key ng kontrol (tagapagkilala ng kontrol na nilalagyan ng gumagamit kapag nagse-setup ng template ng file)
	componentName				string	Pangalan ng kontrol
	componentType				string	Uri ng kontrol 1, Teksto 2, Numero 3, Petsa 6, Karaniwang lugar ng pagpirma 8, Maramihang linya ng teksto 9, Checkbox 10, Radio button 11, Larawan 14, Dropdown na kontrol 15, Kontrol sa checkbox 20, Lugar ng selyo 21, Rehiyon ng Pag-apruba 22, Petsa ng Pagpirma 23, Email 100, Renminbi
	componentDefaultValue				string	Default na halaga ng kontrol
	componentPosition				object	Lokasyon ng kontrol
		componentPositionX			float	Pahalang na koordinado ng lokasyon ng kontrol
		componentPositionY			float	Patayo na koordinado ng lokasyon ng kontrol
		componentPageNum			int	Bilang ng pahina ng kontrol
	componentSize				object	Sukat ng kontrol
		componentWidth			int	Lapad ng kontrol (distansya ng kaliwa't kanang margin ng parihaba, nasa px)
		componentHeight			int	Taas ng kontrol (distansya ng itaas't ibabang margin ng parihaba, nasa px)
	componentTextFormat				object	Estilo ng karakter ng kontrol
		font			int	Font para sa punla, default 1, 1-Songti, 2-New Songti, 4-Heiti, 5-Kaiti
		fontSize			float	Laki ng font, default 12-小四 42-初号 36-小初 26-一号 24-小一 22-二号 19-小二 16-三号 15-小三 14-四号 12-小四 10.5-五号 9-小五
		textColor			string	Kulay ng font, default #000000 itim
		bold			boolean	Ba itong bold, default false true-Oo false-Hindi
		italic			boolean	Italika ba?, default false true-Oo false-Hindi
		horizontalAlignment			string	Pahalang na pagkakahanay, default 1-kaliwa LEFT-Kaliwa CENTER-Gitna RIGHT-Kanan
		verticalAlignment			string	Patayong pagkakahanay, default 1-itaas (para sa maraming linya ng teksto) TOP-Itaas MIDDLE-Gitna BOTTOM-Ilalim
		textLineSpacing			float	Espasyo sa pagitan ng mga linya, default 1.0, pinapayagan ang hanggang isang desimal, maximum na halaga 2.0 (para sa maraming linya ng teksto)
	required				boolean	Kailangan bang punan? true-Kailangan false-Opsyonal
	componentMaxLength				string	Pinakamataas na haba ng pagpuno ng kontrol (bilang ng mga karakter sa Tsino)
	componentSpecialAttribute				object	Natatanging katangian ng kontrol
		numberFormat			string	Format ng numero (kontrol ng numero) Buong numero: 0 Isang desimal: 0.0 Dalawang desimal: 0.00
		dateFormat			string	Format ng petsa (kontrol ng petsa)
		imageType			string	Uri ng imahe (kontrol ng imahe) IDCard_widthwise ID Card Pahalang I-lock ang Aspect Ratio IDCard_longitudinal ID Card Patayo I-lock ang Aspect Ratio other Iba Pa Huwag i-lock ang Aspect Ratio
		options			array	Mga Opsyon (kontrol ng dropdown, kontrol ng radio, kontrol ng checkbox)
			optionOrder		int	Pagkakasunod-sunod ng mga Opsyon
			optionContent		string	Nilalaman ng pagpipilian
			selected		boolean	Kung default na naka-select
			optionPositionX		float	X koordinado ng anak na elemento sa loob ng hangganan ng parent control
			optionPositionY		float	Y koordinado ng anak na elemento sa loob ng hangganan ng parent control
			optionWidth		float	Lapad ng anak na elemento
			optionHeight		float	Taas ng anak na elemento
	signField				object	Mga katangian ng karaniwang lugar ng lagda at selyo
		fieldStyle			int32	Estilo ng lugar ng lagda at selyo 1-Lugar ng lagda at selyo sa iisang pahina 2-Lugar ng cross-page na lagda at selyo
		sizeRule			int	Mga sukat ng selyo 1-I-stamp ayon sa aktwal na sukat ng selyo 2-Kustom na sukat (naaayon sa lapad at taas ng lugar ng paglagda)
		movable			boolean	true-Nakagalaw habang naglalagda false-Hindi nakagalaw habang naglalagda
	stampField				object	Katangian ng Lugar ng Selyo
		fieldStyle			int	Estilo ng Lugar ng Pagpirma at Selyo 1-Lugar ng Pagpirma at Selyo sa Isahang Pahina 2-Lugar ng Pagpirma at Selyo sa Pagkakabit ng Pahina
		sizeRule			int	Espesipikasyon ng Selyo 1-I-stampa ayon sa aktwal na sukat ng selyo 2-Kustomisadong sukat (umaangkop sa lapad at taas ng lugar ng pagpirma)
		movable			boolean	true-Nakagalaw habang nagpupirma false-Hindi nakagalaw habang nagpupirma
	signDateField				object	Katangian ng Petsa ng Pagpirma
		dateFormat			string	Format ng petsa: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	approvalField				object	Katangian ng Lugar ng Pag-apruba
		allowedOptions			array	Mga opsyon upang payagan ang nagpupirma na mag-apruba, ginagamit kapag ang fieldType ay approval. Ang default ay ["approve", "decline"] approve-Tumugoy Tanggihan

Halimbawa ng Tugon

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