Semak butiran templat sampul surat

GET /esignglobal/v1/envelopeTemplates/envelopeTemplateDetail

Penerangan Antara Muka

Semak atribut terperinci bagi 'templat envelope' yang telah dikonfigurasi awal pada sisi halaman (termasuk struktur fail, peranan peserta, dan semua Kunci pengenal pasti komponen pratetap).

Parameter Permintaan

Nama Parameter

Jenis

Wajib

Keterangan

envelopeTemplateId

string

true

ID Templat Envelope

queryComponents

boolean

false

Adakah maklumat komponen perlu disemak, lalai false

true-ya

false-tidak

Contoh Permintaan

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

Parameter Respons

Nama Parameter					Jenis	Keterangan
code					int	Kod operasi, 0 menunjukkan kejayaan, bukan 0 menunjukkan ralat.
message					string	Maklumat operasi Sila gunakan code untuk menentukan keadaan ralat, jangan bergantung pada padanan message kerana message mungkin diubah suai.
data					object	Data operasi
	envelopeTemplateId				string	ID templat envelope
	envelopeTemplateName				string	Nama templat proses
	envelopeTemplateStatus				int	Status ketersediaan templat proses 1-Diaktifkan 0-Dinonaktifkan
	digitalSignature				boolean	Aktifkan tandatangan digital true-Aktif false-Dinonaktifkan
	signFiles				array	Maklumat fail
		documentId			string	ID fail
		fileName			string	Nama dokumen
	participants				array	Pihak terlibat
		participantId			string	ID Pihak Terlibat
		participantSetMode			string	Keperluan penyertaan (cara penetapan peserta) presetSigner-ditetapkan semasa menggunakan templat (ditentukan sendiri oleh pengguna templat) dedicateSigner-anggota tetap (dikunci dalam templat dan tidak boleh diubah) sender-pencetus
		participantInfos			object	Peserta individu
			userEmail		string	E-mel penandatangan
			phoneNumber		object	Nombor telefon, kosong secara lalai Parameter wajib jika pemberitahuan SMS diperlukan, countryCode dan number perlu dihantar
				countryCode	string	Kod antarabangsa negara/wilayah, tiada keperluan memasukkan “+”
				number	string	Tiada pengesahan format, hanya hadkan panjang maksimum kepada 13 digit
			userName		string	Nama individu
			deliveryMethod		string	Kaedah pemberitahuan auto-hantar pemberitahuan e-mel apabila userEmail dimasukkan, hantar pemberitahuan SMS apabila phoneNumber dimasukkan none-tidak menghantar pemberitahuan mesej email-hantar pemberitahuan e-mel sms-hantar pemberitahuan SMS WhatsApp-hantar pemberitahuan WhatsApp
			customizeSettings		object	Konfigurasi tersuai
				customizeMessage	string	Mesej eksklusif Had aksara 1000
				notificationLanguage	string	Bahasa pemberitahuan, lalai ialah bahasa Inggeris en-US Bahasa Inggeris zh-CN Cina Ringkas zh-Hant Cina Tradisional ja Bahasa Jepun es-MX Bahasa Sepanyol pt-PT Bahasa Portugis th-TH Bahasa Thai id-ID Bahasa Indonesia vi-VN Bahasa Vietnam ms-MY Bahasa Melayu fil-PH Bahasa Filipina de-DE Bahasa Jerman fr-FR Bahasa Perancis ru-RU Bahasa Rusia it-IT Bahasa Itali ko-KR Bahasa Korea
		signOrder			int	Susunan tandatangan 1-255 Peserta berbeza boleh diulang
		willingnessAuthModes			string	Penandatangan boleh memilih kaedah niat secara pilihan, dipisahkan dengan koma Inggeris noAuth-Tiada pengesahan accessCode-Sahkan menggunakan kata laluan tandatangan sms-Pengesahan OTP SMS idVerification-Pengesahan Dokumen Pengenalan emailAuth-Pengesahan OTP E-mel digitalId-Pengesahan Identiti Digital whatsappAuth-Pengesahan OTP WhatsApp
			accessCode		object	Tetapan kata laluan tandatangan, wajib diisi apabila authModes=accessCode
				accessCode	string	Kandungan kata laluan, tidak peka huruf besar/kecil, boleh mengandungi alfanumerik, had panjang 45
				promptInfo	string	Petunjuk kata laluan akses, tidak boleh mengandungi kata laluan akses, had panjang 30, wajib diisi apabila authModes=1.
			sms		object	Semakan OTP SMS, wajib diisi apabila authModes=sms
				countryCode	string	Kod antarabangsa negara/wilayah, tiada keperluan untuk memasukkan “+”
				number	string	Tiada semakan format, hanya had panjang maksimum 13 digit
			idVerification		object	Tetapan pengesahan dokumen pengenalan, wajib diisi apabila authModes=idVerification
				name	string	Nama penuh pada dokumen pengenalan penandatangan, panjang maksimum 100 aksara
			emailAuth		object	Semakan OTP e-mel, wajib diisi apabila authModes=emailAuth
				authEmail	string	Alamat e-mel pengesahan identiti penandatangan
			digitalId		array	Pengesahan identiti elektronik, diperlukan apabila authModes=digitalId
				authApp	string	Aplikasi yang digunakan untuk pengesahan identiti elektronik singpass-Gunakan Singpass untuk pengesahan identiti iamsmart-Gunakan iAM Smart untuk pengesahan identiti
				idNumber	string	Nombor dokumen pengenalan penandatangan yang perlu disahkan
			whatsappAuth		object	Pengesahan OTP WhatsApp, diperlukan apabila authModes=whatsappAuth
				countryCode	string	Kod antarabangsa negara/daerah, tiada keperluan untuk memasukkan “+”
				number	string	Tiada semakan format dilakukan, hanya hadkan panjang maksimum kepada 13 digit
		components			object	Maklumat widget
	copiers				array	Tetapkan pihak salinan
		copierId			string	ID pihak terlibat
		editable			boolean	Adakah dibenarkan mengubah semasa memulakan
		CCInfos			object	Maklumat pihak salinan
			userEmail		string	E-mel
			userName		string	Nama peribadi
			customizeSettings		object	Konfigurasi tersuai
				notificationSettings	object	Konfigurasi tersuai jenis pemberitahuan
				notificationLanguage	string	Bahasa pemberitahuan, lalai ialah bahasa Inggeris en-US Bahasa Inggeris zh-CN Bahasa Cina Ringkas zh-Hant Bahasa Cina Tradisional ja Bahasa Jepun ES-MX Bahasa Sepanyol
	attachments				array	Maklumat lampiran
		editable			boolean	Benarkan pengubahsuaian semasa dimulakan
		fileKey			string	filekey lampiran
		fileName			string	Nama lampiran
		downloadUrl			string	Pautan muat turun fail PDF draf sah selama 60 minit.
components					array	Senarai kawalan
	documentId				string	key fail bagi kawalan
	componentId				string	ID kawalan
	componentKey				string	Key kawalan (penanda kawalan yang diisi oleh pengguna semasa menetapkan templat fail)
	componentName				string	Nama kawalan
	componentType				string	Jenis kawalan 1, Teks 2, Nombor 3, Tarikh 6, Kawasan tandatangan biasa 8, Teks berbilang baris 9, Kotak semak 10, Pilihan tunggal 11, Imej 14, Kawalan pilihan seretan 15, Kawalan kotak semak 20, Kawasan cap 21, Kawasan Kelulusan 22, Tarikh Tandatangan 23, E-mel 100, Renminbi
	componentDefaultValue				string	Nilai Lalai Kawalan
	componentPosition				object	Kedudukan Kawalan
		componentPositionX			float	Koordinat-X Kedudukan Kawalan
		componentPositionY			float	Koordinat-Y Kedudukan Kawalan
		componentPageNum			int	Nombor Halaman Kawalan
	componentSize				object	Saiz Kawalan
		componentWidth			int	Lebar Kawalan (jarak margin kiri dan kanan segi empat tepat, dalam unit px)
		componentHeight			int	Tinggi Kawalan (jarak margin atas dan bawah segi empat tepat, dalam unit px)
	componentTextFormat				object	Gaya Aksara Kawalan
		font			int	Font Isian, lalai 1, 1-Songti, 2-Songti Baharu, 4-Heiti, 5-Kaiti
		fontSize			float	Saiz fon diisi, lalai 12-小四 42-初号 36-小初 26-一号 24-小一 22-二号 19-小二 16-三号 15-小三 14-四号 12-小四 10.5-五号 9-小五
		textColor			string	Warna fon, lalai #000000 hitam
		bold			boolean	Adakah ditebalkan, lalai false true-Ya false-Tidak
		italic			boolean	Adakah condong, lalai false true-Ya false-Tidak
		horizontalAlignment			string	Penjajaran mendatar, lalai 1-kiri LEFT-Kiri CENTER-Tengah RIGHT-Kanan
		verticalAlignment			string	Penjajaran menegak, lalai 1-atas (sesuai untuk teks berbilang baris) TOP-Atas MIDDLE-Tengah BOTTOM-Bawah
		textLineSpacing			float	Jarak baris, lalai 1.0 menyokong sehingga satu tempat perpuluhan, nilai maksimum 2.0 (sesuai untuk teks berbilang baris)
	required				boolean	Adakah wajib diisi true-Wajib diisi false-Tidak wajib diisi
	componentMaxLength				string	Had panjang maksimum input kawalan (bilangan aksara Cina)
	componentSpecialAttribute				object	Atribut khusus kawalan
		numberFormat			string	Format nombor (kawalan nombor) Integer: 0 Satu tempat perpuluhan: 0.0 Dua tempat perpuluhan: 0.00
		dateFormat			string	Format tarikh (kawalan tarikh)
		imageType			string	Jenis imej (kawalan imej) IDCard_widthwise Kad pengenalan Melintang Kunci nisbah IDCard_longitudinal Kad pengenalan Menegak Kunci nisbah other Lain-lain Tidak kunci nisbah
		options			array	Pilihan (kawalan senarai turun naik, kawalan pilihan tunggal, kawalan pilihan berbilang)
			optionOrder		int	Susunan pilihan
			optionContent		string	Kandungan pilihan
			selected		boolean	Adakah dipilih secara lalai
			optionPositionX		float	Koordinat X elemen anak dalam sempadan kawalan induk
			optionPositionY		float	Koordinat Y elemen anak dalam sempadan kawalan induk
			optionWidth		float	Lebar elemen anak
			optionHeight		float	Tinggi elemen anak
	signField				object	Sifat kawasan tandatangan biasa
		fieldStyle			int32	Gaya kawasan tandatangan 1-Kawasan tandatangan satu halaman 2-Kawasan tandatangan merentasi halaman
		sizeRule			int	Spesifikasi meterai 1-Tampal mengikut spesifikasi meterai sebenar 2-Spesifikasi tersuai (disesuaikan dengan lebar dan tinggi kawasan tandatangan)
		movable			boolean	true-Boleh digerakkan semasa penandatanganan false-Tidak boleh digerakkan semasa penandatanganan
	stampField				object	Atribut kawasan tandatangan
		fieldStyle			int	Gaya kawasan tandatangan 1-Kawasan tandatangan satu halaman 2-Kawasan tandatangan merentas halaman
		sizeRule			int	Spesifikasi cap 1-Cap mengikut spesifikasi cap sebenar 2-Spesifikasi tersuai (disesuaikan dengan lebar dan tinggi kawasan tandatangan)
		movable			boolean	true-Boleh digerakkan semasa menandatangani false-Tidak boleh digerakkan semasa menandatangani
	signDateField				object	Atribut tarikh penandatanganan
		dateFormat			string	Format tarikh: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	approvalField				object	Atribut kawasan kelulusan
		allowedOptions			array	Pilihan yang membenarkan penandatangan meluluskan, terpakai apabila fieldType ialah approval. Lalai kepada ["approve", "decline"] approve-Setujuan decline-penolakan

Contoh respons

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