Mulakan penandatanganan menggunakan templat amplop

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

Penerangan antara muka

Gunakan "templat sampul" yang telah dikonfigurasi sebelumnya di sisi halaman untuk memulakan penandatanganan.

Parameter permintaan

Nama parameter				Jenis	Diperlukan	Keterangan
envelopeTemplateId				string	true	ID templat sampul
envelopeConfig				object	true	Konfigurasi proses penandatanganan
	contractConfig			boolean	false	Konfigurasi penandatanganan kontrak
		envelopeRemark		array	false	Nota kontrak
	envelopeSubject			string	true	Tajuk proses penandatanganan ini
	expireAfterSeconds			int	false	Tarikh akhir penandatanganan bagi proses ini, tidak boleh menandatangani selepas tamat tempoh ini, cap masa Unix dalam milisaat, tempoh sah lalai dan maksimum ialah 90 hari
	callbackUrl			string	false	Alamat web untuk menerima pemberitahuan panggilan balik
	redirectUrl			string	false	Perlu merupakan alamat https yang sah
	signConfig			object	false	Item konfigurasi penandatanganan
		allowTransfer		boolean	false	Bolehkah penandatangan menyerahkan sampul ini kepada orang lain untuk ditandatangani, lalai false true-Membenarkan penandatangan dalam sampul mempunyai kuasa untuk menyerahkan sampul kepada orang lain; false-Tidak membenarkan penandatangan dalam sampul mempunyai kuasa untuk menyerahkan sampul kepada orang lain;
participants				array	false	Konfigurasi peserta
	participantId			string	true	ID peserta
	authConfig			object	false	Item konfigurasi pengesahan
		willingnessAuthModes		array	false	Kaedah niat pilihan penandatangan, lalai noAuth noAuth-Tiada pengesahan accessCode-Pengesahan menggunakan kata laluan penandatanganan sms-Pengesahan OTP SMS idVerification-Pengesahan dokumen pengenalan diri emailAuth-Pengesahan OTP e-mel digitalId-Pengesahan identiti digital whatsappAuth-Pengesahan OTP whatsapp
		accessCode		object	false	Tetapan kod tandatangan, diperlukan apabila authModes=accessCode
			accessCode	string	false	Kandungan kod, tidak sensitif huruf besar/kecil, boleh mengandungi huruf dan nombor, had panjang 45
			promptInfo	string	false	Mesej petunjuk kod akses, tidak boleh mengandungi kod akses, had panjang 30, diperlukan apabila authModes=1.
		sms		object	false	Pengesahan OTP SMS, diperlukan apabila authModes=sms
			countryCode	string	false	Kod antarabangsa negara atau wilayah, tiada keperluan untuk memasukkan “+”
			number	string	false	Tiada pengesahan format, hanya hadkan panjang maksimum kepada 13 digit
		idVerification		object	false	Tetapan pengesahan dokumen pengenalan, diperlukan apabila authModes=idVerification
			name	string	false	Nama penuh pada dokumen pengenalan penandatangan, panjang maksimum 100 aksara
		emailAuth		object	false	Pengesahan OTP e-mel, diperlukan apabila authModes=emailAuth
			authEmail	string	false	Alamat e-mel pengesahan identiti penandatangan
		digitalId		array	false	Pengesahan identiti digital, diperlukan apabila authModes=digitalId
			authApp	string	false	APP yang digunakan untuk pengesahan identiti digital singpass-Pengesahan identiti menggunakan Singpass iamsmart-Pengesahan identiti menggunakan MyDigitalID
			idNumber	string	false	Nombor dokumen pengenalan penandatangan yang perlu disahkan
		whatsappAuth		object	false	Validasi OTP WhatsApp, diperlukan apabila authModes=whatsappAuth
			countryCode	string	false	Kod antarabangsa negara/daerah, tidak perlu memasukkan “+”
			number	string	false	Tiada validasi format, hanya hadkan panjang maksimum kepada 13 digit
	participantInfos			object	false	Pihak individu
		userEmail		string	false	E-mel penandatangan
		phoneNumber		object	false	Nombor telefon, kosong secara lalai Parameter wajib apabila pemberitahuan SMS diperlukan, countryCode dan number mesti dimasukkan
			countryCode	string	false	Kod antarabangsa negara/daerah, tidak perlu memasukkan “+”
			number	string	false	Tiada validasi format, hanya hadkan panjang maksimum kepada 13 digit
		userName		string	false	Nama individu
		deliveryMethod		string	false	Kaedah pemberitahuan none-Tiada pemberitahuan mesej dihantar email-Pemberitahuan e-mel dihantar sms-Pemberitahuan SMS dihantar WhatsApp-Pemberitahuan WhatsApp dihantar
		customizeSettings		object	false	Konfigurasi tersuai
			customizeMessage	object	false	Konfigurasi tersuai jenis pemberitahuan
			notificationLanguage	string	false	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
copiers				array	false	Tambah penerima CC
	copierId			string	true	ID peserta
	CCInfos			object	false	Maklumat penerima CC
		userEmail		string	false	E-mel
		userName		string	false	Nama peribadi
		customizeSettings		object	false	Konfigurasi tersuai
			customizeMessage	object	false	Konfigurasi tersuai jenis pemberitahuan
			notificationLanguage	string	false	Bahasa pemberitahuan, secara lalai ialah bahasa Inggeris en-US Bahasa Inggeris zh-CN Bahasa Cina Sederhana zh-Hant Bahasa Cina Tradisional ja Bahasa Jepun ES-MX Bahasa Sepanyol
attchments				array	false	Maklumat lampiran (fail yang tidak memerlukan tandatangan)
	documentId			string	false	ID fail lampiran
	fileName			string	false	Nama fail lampiran
components				array	false	Senarai alat kawalan
	documentId			string	false	ID fail alat kawalan
	componentId			string	false	ID alat kawalan
	componentKey			string	false	Kunci alat kawalan, (pilih antara ID alat kawalan atau kunci alat kawalan)
	componentValue			string	false	Nilai isian alat kawalan
	editComponentValue			boolean	false	Mengawal sama ada pihak penandatangan boleh mengubah kandungan pra-isi bagi alat kawalan ini, secara lalai ialah true true-Penandatangan boleh mengubah nilai pra-disi false-Dikunci sebagai baca sahaja apabila terdapat nilai pra-disi, penandatangan tidak boleh mengubahnya

Contoh permintaan

{
  "envelopeTemplateId": "dc4be9641a3145b****9018d7a9180",
  "envelopeConfig": {
    "envelopeSubject": "*****"
  },
  "participants": [
    {
      "participantId": "42750b92c7a34******34dd5342",
      "participantInfos": {
        "userEmail": "***",
        "userName": "Preset Signer"
      }
    }
  ],
  "copiers": [],
  "attachments": [],
  "components": [
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142***2c3b02c3b5c663aa146",
      "componentId": "30c616512991***d68ab930210c",
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c74***2c3b5c663aa146",
      "componentId": "a130c54c1472444f***6c6e83a2f540"
    },
    {
      "componentValue": "123.4444",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "42b76dfbf15e4cf1***a409159c35"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c7***3b02c3b5c663aa146",
      "componentId": "556b60f7bd32442***3bbec8c54"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "7929410bb8754***497d6df30cb2"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c3***c663aa146",
      "componentId": "9e92a77b50b24cd***f6ade4b7d9"
    },
    {
      "componentValue": "123",
      "documentId": "d559142672c7402c3***b5c663aa146",
      "componentId": "9600135a35fb4ff***4ce42b6af"
    },
    {
      "componentValue": "0,1",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "d41cea8f288e***4c18c0289a"
    },
    {
      "componentValue": "1",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "9edab2c19***08b3c2dcc2d1a78171"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c74***c3b5c663aa146",
      "componentId": "4a6136cd81c54***01c113fcd30"
    },
    {
      "componentValue": "***",
      "documentId": "d559142672c7***02c3b5c663aa146",
      "componentId": "73d836894fb34***fb90fcd813"
    },
    {
      "componentValue": "***",
      "documentId": "d5591426***b02c3b5c663aa146",
      "componentId": "4e22fe4be9314a8***81d5354b51da4"
    }
  ]
}

Parameter respons

Nama parameter	Jenis	Keterangan
envelopeId	string	ID envelope

Contoh respons

{
  "code": "0",
  "data": {
    "envelopeId": "4e2eb9cc95044a7****a9a81f76397"
  },
  "message": "SUCCESS"
}