Sunting Penandatangan

POST/esignglobal/v1/envelope/recipients/editSigners

Penerangan Antara Muka

Mengemas kini maklumat penandatangan yang belum selesai menandatangani dalam sampul surat.

Selepas pembangun mencipta sampul surat, jika terdapat kesilapan dalam maklumat hubungan penandatangan, nama penandatangan, konfigurasi pemberitahuan atau kaedah pengesahan identiti, atau jika perlu menukar maklumat penandatangan, pembangun boleh menggunakan antara muka ini untuk mengemas kini maklumat penandatangan yang belum selesai menandatangani bagi mengelakkan sampul surat dibatalkan dan dihantar semula akibat maklumat yang salah.

Perhatian

Hanya menyokong pengubahan maklumat penandatangan yang belum selesai menandatangani.
Penandatangan dalam status akhir seperti telah ditandatangani atau ditolak tidak disokong untuk diubah.
Apabila sampul surat berada dalam status akhir atau telah dibatalkan, maklumat penandatangan tidak disokong untuk diubah.
Apabila kaedah pemberitahuan merangkumi SMS dan e-mel serentak, tidak disokong untuk hanya mengubah phoneNumber。
Antara muka akan membandingkan maklumat penandatangan yang dimasukkan dengan maklumat penandatangan semasa; jika maklumat tidak sepadan, maklumat penandatangan yang berkaitan akan dikemas kini.

Parameter Permintaan

Nama Parameter				Jenis	Wajib Dinyatakan	Penerangan
envelopeId				string	true	ID Sampul Surat
signerInfos				object	true	Maklumat penandatangan
	recipientId			string	true	ID penyerta
	businessId			string	false	Nombor perniagaan tersuai pembangun, had panjang 500
	deliveryMethods			string	false	Kaedah pemberitahuan, lalai auto auto-Hantar pemberitahuan e-mel apabila userEmail disediakan, hantar pemberitahuan SMS apabila phoneNumber disediakan none-Tidak menghantar pemberitahuan mesej email-Hantar pemberitahuan e-mel sms-Hantar pemberitahuan SMS WhatsApp-Hantar pemberitahuan WhatsApp
	userEmail			string	false	Alamat e-mel penandatangan
	userName			string	true	Nama penandatangan, digunakan untuk memaparkan nama penandatangan pada halaman tandatangan dan amplop. [Nota] Tidak boleh mengandungi 9 aksara istimewa berikut: / \ : * " < > \| ？ serta semua emoji
	minimumReadingDuration			int	false	Masa undur bacaan wajib halaman, nilai lalai ialah 0 (unit: saat, had maksimum 999) 0 atau tidak diisi bermaksud tidak diaktifkan, tiada undur masa bacaan diperlukan
	readToEndRequired			boolean	false	Menunjukkan sama ada perlu dibaca sepenuhnya. Lalai false; true menunjukkan diaktifkan, false atau tidak dihantar menunjukkan tidak diaktifkan.
	phoneNumber			object	false	Nombor telefon, kosong secara lalai Parameter wajib apabila pemberitahuan SMS diperlukan, countryCode dan number perlu dihantar
		countryCode		string	false	Kod antarabangsa negara atau wilayah, tiada keperluan untuk memasukkan “+”
		number		string	false	Tiada pengesahan format, hanya had panjang maksimum 13 digit
	customizeSettings			object	false	Konfigurasi tersuai
		notificationSettings		object	false	Konfigurasi tersuai untuk pemberitahuan
			customizeMessage	string	false	Pemberitahuan mesej khusus, had aksara 200
			notificationLanguage	string	false	Bahasa pemberitahuan, secara lalai menggunakan konfigurasi “bahasa pemberitahuan lalai” en-US Bahasa Inggeris zh-CN Bahasa Cina Ringkas zh-Hant Bahasa Cina Tradisional ja-JP 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
	authModes			string	false	Kaedah pengesahan, lalai ialah noAuth noAuth-Tiada pengesahan accessCode-Pengesahan menggunakan kata laluan tandatangan sms-Pengesahan OTP SMS idVerification-Pengesahan dokumen pengenalan emailAuth-Pengesahan OTP e-mel digitalId-Pengesahan identiti elektronik whatsappAuth-Pengesahan OTP WhatsApp
	authConfig			object	false	Tetapan kaedah pengesahan
		accessCode		object	false	Tetapan kata laluan tandatangan, wajib diisi apabila authModes=accessCode
			accessCode	string	false	Kandungan kata laluan, tidak sensitif kes, boleh mengandungi aksara alfanumerik, had panjang 45
			promptInfo	string	false	Petanda kata laluan akses, tidak boleh mengandungi kata laluan akses, had panjang 30, wajib diisi apabila authModes=1.
		sms		object	false	Pengesahan OTP SMS, wajib diisi apabila authModes=sms
			countryCode	string	false	Kod panggilan antarabangsa negara/daerah, tiada keperluan untuk memasukkan “+”
			number	string	false	Tiada pengesahan format, hanya hadkan panjang maksimum kepada 13 digit
		idVerification		object	false	Tetapan pengesahan dokumen pengenalan diri, wajib diisi apabila authModes=idVerification
			name	string	false	Nama penuh pada dokumen pengenalan diri penandatangan, panjang maksimum 100 aksara
		emailAuth		object	false	Pengesahan OTP e-mel, wajib diisi apabila authModes=emailAuth
			authEmail	string	false	Alamat e-mel pengesahan identiti penandatangan
		digitalId		array	false	Pengesahan identiti elektronik, wajib diisi apabila authModes=digitalId
			authApp	string	false	APP yang digunakan untuk pengesahan identiti elektronik singpass-Pengesahan identiti menggunakan Singpass
			idNumber	string	false	Nombor dokumen pengenalan penandatangan yang perlu disahkan
		whatsappAuth		object	false	Pengesahan OTP WhatsApp, diperlukan apabila authModes=whatsappAuth
			countryCode	string	false	Kod antarabangsa negara atau wilayah, tidak perlu memasukkan "+"
			number	string	false	Tiada semakan format, hanya hadkan panjang maksimum kepada 13 digit

Contoh respons

{
  "code": 0,
  "message": "success",
  "data": {
    "envelopeId": "9fbe6c8190824227bde29136b0145c81",
    "signerInfos": [
      {
        "recipientId": "recipient_123456789",
        "businessId": "biz-20260604-001",
        "userEmail": "new_signer@example.com",
        "userName": "Alex Chen"
      }
    ]
  }
}