Lihat detail templat amplop

GET /esignglobal/v1/envelopeTemplates/envelopeTemplateDetail

Deskripsi Antarmuka

Mengambil atribut lengkap dari "template amplop" yang telah dikonfigurasi sebelumnya di sisi antarmuka (termasuk struktur file, peran partisipan, dan semua Control Key yang telah dipra-konfigurasi).

Parameter Permintaan

Nama Parameter

Tipe

Wajib

Keterangan

envelopeTemplateId

string

true

ID Template Amplop

queryComponents

boolean

false

Apakah informasi kontrol perlu diambil, default false

true-ya

false-tidak

Contoh Permintaan

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

Parameter Respons

Nama Parameter					Tipe	Keterangan
code					int	Kode bisnis, 0 berarti berhasil, selain 0 berarti terjadi kesalahan.
message					string	Informasi bisnis Tentukan kondisi kesalahan berdasarkan code, jangan mengandalkan pencocokan message karena message dapat diubah.
data					object	Data bisnis
	envelopeTemplateId				string	ID template amplop
	envelopeTemplateName				string	Nama template alur kerja
	envelopeTemplateStatus				int	Status ketersediaan template alur kerja 1-Aktif 0-Tidak aktif
	digitalSignature				boolean	Aktifkan tanda tangan digital true-Aktif false-Tidak aktif
	signFiles				array	Informasi file
		documentId			string	ID file
		fileName			string	Nama File
	participants				array	Pihak Peserta
		participantId			string	ID Pihak Peserta
		participantSetMode			string	Persyaratan Partisipasi (Cara Penentuan Peserta) presetSigner-Ditetapkan saat menggunakan template (ditentukan sendiri oleh pengguna template) dedicateSigner-Anggota Tetap (Terkunci dalam template dan tidak dapat diubah) sender-Pengirim
		participantInfos			object	Peserta Individu
			userEmail		string	Email Penandatangan
			phoneNumber		object	Nomor telepon, kosong secara default Parameter wajib jika diperlukan notifikasi SMS, countryCode dan number harus disertakan
				countryCode	string	Kode internasional negara/wilayah, tidak perlu menyertakan “+”
				number	string	Tidak ada validasi format, hanya membatasi panjang maksimal 13 digit
			userName		string	Nama Individu
			deliveryMethod		string	Metode Notifikasi auto-kirim notifikasi email saat userEmail dikirim, kirim notifikasi SMS saat phoneNumber dikirim none-tidak mengirim notifikasi pesan email-mengirim notifikasi email sms-mengirim notifikasi SMS WhatsApp-mengirim notifikasi WhatsApp
			customizeSettings		object	Konfigurasi kustom
				customizeMessage	string	Pesan eksklusif Batas karakter 1000
				notificationLanguage	string	Bahasa notifikasi, bawaan adalah bahasa Inggris en-US Bahasa Inggris zh-CN Bahasa Mandarin Sederhana zh-Hant Bahasa Mandarin Tradisional ja Bahasa Jepang es-MX Bahasa Spanyol pt-PT Bahasa Portugis th-TH Bahasa Thailand id-ID Bahasa Indonesia vi-VN Bahasa Vietnam ms-MY Bahasa Melayu fil-PH Bahasa Filipina de-DE Bahasa Jerman fr-FR Bahasa Prancis ru-RU Bahasa Rusia it-IT Bahasa Italia ko-KR Bahasa Korea
		signOrder			int	Urutan penandatanganan 1-255 Peserta berbeda dapat diulang
		willingnessAuthModes			string	Pilihan metode penandatangan, dipisahkan dengan koma bahasa Inggris noAuth-Tidak diverifikasi accessCode-Diverifikasi menggunakan kata sandi penandatanganan sms-Verifikasi OTP SMS idVerification-Verifikasi Dokumen Identitas emailAuth-Verifikasi OTP Email digitalId-Verifikasi Identitas Elektronik whatsappAuth-Verifikasi OTP WhatsApp
			accessCode		object	Pengaturan kata sandi penandatanganan, wajib diisi ketika authModes=accessCode
				accessCode	string	Isi kata sandi, tidak peka huruf besar/kecil, dapat berisi huruf dan angka, batas panjang 45
				promptInfo	string	Pesan petunjuk kata sandi akses, tidak boleh memuat kata sandi akses, batas panjang 30, wajib diisi ketika authModes=1.
			sms		object	Verifikasi OTP SMS, wajib diisi ketika authModes=sms
				countryCode	string	Kode internasional negara/wilayah, tidak perlu menyertakan tanda “+”
				number	string	Tidak dilakukan validasi format, hanya membatasi panjang maksimal 13 karakter
			idVerification		object	Pengaturan verifikasi dokumen identitas, wajib diisi ketika authModes=idVerification
				name	string	Nama lengkap pada dokumen identitas penandatangan, panjang maksimal 100 karakter
			emailAuth		object	Verifikasi OTP email, wajib diisi ketika authModes=emailAuth
				authEmail	string	Alamat email verifikasi identitas penandatangan
			digitalId		array	Verifikasi identitas elektronik, wajib diisi saat authModes=digitalId
				authApp	string	Aplikasi yang digunakan untuk verifikasi identitas elektronik singpass-Menggunakan Singpass untuk autentikasi identitas iamsmart-Menggunakan iAM Smart untuk autentikasi
				idNumber	string	Nomor dokumen identitas penandatangan yang akan diverifikasi
			whatsappAuth		object	Validasi OTP whatsapp, wajib diisi saat authModes=whatsappAuth
				countryCode	string	Kode internasional negara/wilayah, tidak perlu menyertakan tanda "+"
				number	string	Tidak melakukan validasi format, hanya membatasi panjang maksimal 13 karakter
		components			object	Informasi kontrol
	copiers				array	Atur pihak penerima salinan (CC)
		copierId			string	ID pihak peserta
		editable			boolean	Apakah diizinkan untuk diubah saat inisiasi
		CCInfos			object	Informasi pihak penerima salinan (CC)
			userEmail		string	Email
			userName		string	Nama pribadi
			customizeSettings		object	Konfigurasi Kustom
				notificationSettings	object	Konfigurasi Kustom Notifikasi
				notificationLanguage	string	Bahasa notifikasi, default bahasa Inggris en-US Bahasa Inggris zh-CN Bahasa Tionghoa Sederhana zh-Hant Bahasa Tionghoa Tradisional ja Bahasa Jepang ES-MX Bahasa Spanyol
	attachments				array	Informasi Lampiran
		editable			boolean	Izinkan modifikasi saat inisiasi
		fileKey			string	filekey lampiran
		fileName			string	Nama lampiran
		downloadUrl			string	Tautan unduhan file PDF draf dokumen, berlaku selama 60 menit.
components					array	Daftar kontrol
	documentId				string	key file kontrol
	componentId				string	ID kontrol
	componentKey				string	Key kontrol (identifikasi kontrol yang diisi oleh pengguna saat menyiapkan templat file)
	componentName				string	Nama kontrol
	componentType				string	Tipe kontrol 1, Teks 2, Angka 3, Tanggal 6, Area tanda tangan biasa 8, Teks multi-baris 9, Centang 10, Pilihan tunggal 11, Gambar 14, Kontrol pilihan dropdown 15, Kontrol kotak centang 20, Area stempel 21, Area Persetujuan 22, Tanggal Penandatanganan 23, Email 100, Renminbi
	componentDefaultValue				string	Nilai bawaan kontrol
	componentPosition				object	Posisi kontrol
		componentPositionX			float	Koordinat X posisi kontrol
		componentPositionY			float	Koordinat Y posisi kontrol
		componentPageNum			int	Nomor halaman kontrol
	componentSize				object	Ukuran kontrol
		componentWidth			int	Lebar kontrol (jarak margin kiri dan kanan persegi panjang, dalam satuan px)
		componentHeight			int	Tinggi kontrol (jarak margin atas dan bawah persegi panjang, dalam satuan px)
	componentTextFormat				object	Gaya karakter kontrol
		font			int	Font pengisian, default 1, 1-Songti, 2-Xin Songti, 4-Heiti, 5-Kaiti
		fontSize			float	Ukuran font pengisian, default 12-小四 42-初号 36-小初 26-一号 24-小一 22-二号 19-小二 16-三号 15-小三 14-四号 12-小四 10.5-五号 9-小五
		textColor			string	Warna font, default #000000 hitam
		bold			boolean	Cetak tebal, default false true-ya false-tidak
		italic			boolean	Apakah miring, default false true-ya false-tidak
		horizontalAlignment			string	Perataan horizontal, default 1-kiri LEFT-kiri CENTER-tengah RIGHT-kanan
		verticalAlignment			string	Perataan vertikal, default 1-atas (berlaku untuk teks multi-baris) TOP-atas MIDDLE-tengah BOTTOM-bawah
		textLineSpacing			float	Jarak baris, default 1.0 Mendukung hingga satu angka desimal, nilai maksimum 2.0 (berlaku untuk teks multi-baris)
	required				boolean	Apakah wajib diisi true-Wajib diisi false-Tidak wajib diisi
	componentMaxLength				string	Batas panjang maksimum pengisian kontrol (jumlah karakter Mandarin)
	componentSpecialAttribute				object	Atribut khusus kontrol
		numberFormat			string	Format angka (kontrol angka) Bilangan bulat: 0 Satu desimal: 0.0 Dua desimal: 0.00
		dateFormat			string	Format tanggal (kontrol tanggal)
		imageType			string	Tipe gambar (kontrol gambar) IDCard_widthwise Kartu Identitas Horizontal Kunci Rasio Aspek IDCard_longitudinal Kartu Identitas Vertikal Kunci Rasio Aspek other Lainnya Tidak mengunci rasio aspek
		options			array	Opsi (kontrol pilihan dropdown, kontrol pilihan tunggal, kontrol pilihan ganda)
			optionOrder		int	Urutan opsi
			optionContent		string	Konten Opsi
			selected		boolean	Dipilih secara default
			optionPositionX		float	Koordinat X elemen anak dalam bingkai kontrol induk
			optionPositionY		float	Koordinat Y elemen anak dalam bingkai kontrol induk
			optionWidth		float	Lebar elemen anak
			optionHeight		float	Tinggi elemen anak
	signField				object	Atribut area cap dan tanda tangan standar
		fieldStyle			int32	Gaya area cap dan tanda tangan 1-Area cap dan tanda tangan halaman tunggal 2-Area cap dan tanda tangan tepi sambungan
		sizeRule			int	Spesifikasi cap 1-Membubuhkan cap sesuai spesifikasi cap asli 2-Spesifikasi kustom (disesuaikan dengan lebar dan tinggi area penandatanganan)
		movable			boolean	true-Dapat dipindahkan saat penandatanganan false-Tidak dapat dipindahkan saat penandatanganan
	stampField				object	Properti Area Stempel
		fieldStyle			int	Gaya Area Tanda Tangan 1-Area Tanda Tangan Satu Halaman 2-Area Tanda Tangan Sepanjang Jahitan
		sizeRule			int	Spesifikasi Stempel 1-Tambahkan stempel sesuai spesifikasi asli 2-Spesifikasi kustom (disesuaikan dengan lebar dan tinggi area penandatanganan)
		movable			boolean	true-Dapat dipindahkan saat penandatanganan false-Tidak dapat dipindahkan saat penandatanganan
	signDateField				object	Properti Tanggal Penandatanganan
		dateFormat			string	Format tanggal: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	approvalField				object	Properti Area Persetujuan
		allowedOptions			array	Opsi yang memungkinkan penandatangan melakukan persetujuan, berlaku untuk fieldType approval. Nilai defaultnya adalah ["approve", "decline"] approve-Menyetujui decline-ditolak

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