แก้ไขผู้ลงนาม

POST/esignglobal/v1/envelope/recipients/editSigners

คำอธิบาย API

แก้ไขข้อมูลผู้ลงนามที่ยังไม่เสร็จสิ้นการลงนามในซองเอกสาร

หลังจากสร้างซองเอกสารแล้ว หากนักพัฒนาพบว่าข้อมูลการติดต่อ ชื่อผู้ลงนาม การตั้งค่าการแจ้งเตือน หรือวิธีการตรวจสอบตัวตนกรอกผิด หรือต้องการเปลี่ยนข้อมูลผู้ลงนาม สามารถใช้ API นี้เพื่ออัปเดตข้อมูลผู้ลงนามที่ยังไม่เสร็จสิ้นการลงนามได้ เพื่อป้องกันไม่ให้ซองเอกสารถูกยกเลิกและต้องส่งใหม่เนื่องจากข้อมูลผิดพลาด

ข้อควรระวัง

รองรับเฉพาะการแก้ไขข้อมูลผู้ลงนามที่ยังไม่เสร็จสิ้นการลงนามเท่านั้น
ไม่รองรับการแก้ไขผู้ลงนามที่อยู่ในสถานะสิ้นสุดแล้ว เช่น ลงนามเรียบร้อยแล้ว หรือปฏิเสธการลงนาม
เมื่อซองเอกสารอยู่ในสถานะสิ้นสุดหรือถูกยกเลิกแล้ว จะไม่สามารถแก้ไขข้อมูลผู้ลงนามได้
เมื่อวิธีการแจ้งเตือนประกอบด้วยทั้งข้อความสั้น (SMS) และอีเมลพร้อมกัน จะไม่รองรับการแก้ไขเพียง phoneNumber。
API จะทำการเปรียบเทียบข้อมูลผู้ลงนามที่ส่งเข้ามากับข้อมูลผู้ลงนามปัจจุบัน หากข้อมูลไม่ตรงกัน จะทำการอัปเดตข้อมูลผู้ลงนามที่เกี่ยวข้อง

พารามิเตอร์คำขอ

ชื่อพารามิเตอร์				ประเภท	จำเป็นต้องกรอกหรือไม่	คำอธิบาย
envelopeId				string	true	รหัสซองเอกสาร
signerInfos				object	true	ข้อมูลผู้ลงนาม
	recipientId			string	true	ID ของผู้เข้าร่วม
	businessId			string	false	หมายเลขอ้างอิงธุรกิจที่นักพัฒนากำหนดเอง จำกัดความยาวสูงสุด 500
	deliveryMethods			string	false	วิธีการแจ้งเตือน โดยค่าเริ่มต้นคือ auto auto-เมื่อส่ง userEmail จะแจ้งเตือนทางอีเมล เมื่อส่ง phoneNumber จะแจ้งเตือนทาง SMS none-ไม่ส่งการแจ้งเตือนข้อความ email-ส่งการแจ้งเตือนทางอีเมล sms-ส่งการแจ้งเตือนทาง SMS WhatsApp-ส่งการแจ้งเตือนผ่าน WhatsApp
	userEmail			string	false	ที่อยู่อีเมลของผู้ลงนาม
	userName			string	true	ชื่อผู้ลงนาม ใช้แสดงชื่อผู้ลงนามบนหน้าลงนามและซองเอกสารภายนอก 【หมายเหตุ】ห้ามใช้ตัวอักขระพิเศษ 9 ตัวต่อไปนี้: / \ : * " < > \| ? รวมถึงอิโมจิทั้งหมด
	minimumReadingDuration			int	false	ตั้งเวลานับถอยหลังบังคับอ่านหน้ากระดาษ ค่าเริ่มต้นคือ 0 (หน่วย: วินาที, สูงสุด 999) 0 หรือไม่ได้ระบุหมายถึงไม่เปิดใช้งาน ไม่ต้องมีการนับถอยหลังสำหรับการอ่าน
	readToEndRequired			boolean	false	ระบุว่าจำเป็นต้องอ่านจนจบหรือไม่ ค่าเริ่มต้นคือ false; true หมายถึงการเปิดใช้งาน false หรือไม่ระบุค่าหมายถึงการปิดใช้งาน
	phoneNumber			object	false	หมายเลขโทรศัพท์ ค่าเริ่มต้นเป็นค่าว่าง พารามิเตอร์บังคับเมื่อต้องการแจ้งเตือนผ่านข้อความ SMS ต้องส่งค่าทั้ง countryCode และ number
		countryCode		string	false	รหัสระหว่างประเทศของภูมิภาค ไม่ต้องใส่เครื่องหมาย “+”
		number		string	false	ไม่มีการตรวจสอบรูปแบบ จำกัดความยาวสูงสุดเพียง 13 หลัก
	customizeSettings			object	false	การตั้งค่าแบบกำหนดเอง
		notificationSettings		object	false	การตั้งค่าแบบกำหนดเองสำหรับประเภทการแจ้งเตือน
			customizeMessage	string	false	การแจ้งเตือนข้อความเฉพาะ จำกัดจำนวนตัวอักษร 200 ตัว
			notificationLanguage	string	false	ภาษาการแจ้งเตือน ค่าเริ่มต้นใช้การตั้งค่า “ภาษาการแจ้งเตือนเริ่มต้น” en-US ภาษาอังกฤษ zh-CN ภาษาจีนตัวย่อ zh-Hant ภาษาจีนตัวเต็ม ja-JP ภาษาญี่ปุ่น es-MX ภาษาสเปน pt-PT ภาษาโปรตุเกส th-TH ภาษาไทย id-ID ภาษาอินโดนีเซีย vi-VN ภาษาเวียดนาม ms-MY ภาษามาเลเซีย fil-PH ภาษาฟิลิปปินส์ de-DE ภาษาเยอรมัน fr-FR ภาษาฝรั่งเศส ru-RU ภาษารัสเซีย it-IT ภาษาอิตาลี ko-KR ภาษาเกาหลี
	authModes			string	false	วิธีการตรวจสอบ ค่าเริ่มต้นคือ noAuth noAuth-ไม่มีการตรวจสอบ accessCode-ใช้รหัสผ่านลายเซ็นในการตรวจสอบ sms-ยืนยันด้วย SMS OTP idVerification-ยืนยันด้วยบัตรประจำตัว emailAuth-การยืนยัน OTP ผ่านอีเมล digitalId-การยืนยันตัวตนอิเล็กทรอนิกส์ whatsappAuth-การยืนยัน OTP ผ่าน WhatsApp
	authConfig			object	false	การตั้งค่าวิธีการยืนยัน
		accessCode		object	false	การตั้งค่ารหัสผ่านสำหรับการลงนาม จำเป็นต้องกรอกเมื่อ authModes=accessCode
			accessCode	string	false	เนื้อหารหัสผ่าน ไม่แยกตัวพิมพ์ใหญ่เล็ก สามารถประกอบด้วยตัวอักษรและตัวเลขได้ จำกัดความยาวสูงสุด 45
			promptInfo	string	false	ข้อความแจ้งเตือนรหัสผ่านสำหรับการเข้าถึง ห้ามมีข้อความรหัสผ่านสำหรับการเข้าถึงอยู่ภายใน จำกัดความยาวสูงสุด 30 จำเป็นต้องกรอกเมื่อ authModes=1
		sms		object	false	การตรวจสอบ OTP ผ่าน SMS จำเป็นต้องกรอกเมื่อ authModes=sms
			countryCode	string	false	รหัสระหว่างประเทศของภูมิภาคหรือประเทศ ไม่ต้องใส่เครื่องหมาย “+”
			number	string	false	ไม่มีการตรวจสอบรูปแบบ จำกัดความยาวสูงสุดเพียง 13 หลัก
		idVerification		object	false	การตั้งค่าการยืนยันบัตรประจำตัว จำเป็นต้องกรอกเมื่อ authModes=idVerification
			name	string	false	ชื่อเต็มบนบัตรประจำตัวของผู้ลงนาม ความยาวสูงสุด 100 ตัวอักษร
		emailAuth		object	false	การตรวจสอบ OTP ผ่านอีเมล จำเป็นต้องกรอกเมื่อ authModes=emailAuth
			authEmail	string	false	ที่อยู่อีเมลสำหรับยืนยันตัวตนของผู้ลงนาม
		digitalId		array	false	การยืนยันตัวตนอิเล็กทรอนิกส์ จำเป็นต้องกรอกเมื่อ authModes=digitalId
			authApp	string	false	แอปพลิเคชันที่ใช้ในการยืนยันตัวตนแบบอิเล็กทรอนิกส์ singpass-ใช้ Singpass ในการยืนยันตัวตน
			idNumber	string	false	หมายเลขบัตรประจำตัวของผู้ลงนามที่ต้องตรวจสอบ
		whatsappAuth		object	false	การยืนยัน OTP ทาง WhatsApp จำเป็นต้องกรอกเมื่อ authModes=whatsappAuth
			countryCode	string	false	รหัสประเทศหรือภูมิภาคระหว่างประเทศ ไม่ต้องส่งค่า “+”
			number	string	false	ไม่ตรวจสอบรูปแบบ จำกัดความยาวสูงสุดเพียง 13 หลัก

ตัวอย่างการตอบกลับ

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