สร้างซองด่วน

POST /esignglobal/v1/envelope/createAndStart

คำอธิบายอินเทอร์เฟซ

เริ่มสร้างซองเอกสารอย่างรวดเร็ว รวมถึงการสร้างซองเอกสาร เพิ่มไฟล์ที่รอการลงนาม เพิ่มผู้ลงนาม ฯลฯ

รองรับการเปิดอัตโนมัติ: หลังจากเรียกใช้ API สำเร็จ จะเป็นการสร้างและเปิดซองเอกสารสำเร็จ โดยซองเอกสารจะเริ่มดำเนินการต่อโดยอัตโนมัติ
รองรับการสิ้นสุดอัตโนมัติ: หลังจากทุกฝ่ายที่เกี่ยวข้องกับการลงนามลงนามเสร็จสิ้น ซองเอกสารจะสิ้นสุดโดยอัตโนมัติ

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

ชื่อพารามิเตอร์					ประเภท	จำเป็น	คำอธิบาย
subject					string	true	หัวข้อซองเอกสาร ตัวอย่าง: “Offer Letter”
remark					string	false	หมายเหตุซองเอกสาร จำกัดความยาว 1,000 ตัวอักษร
signerSettings					object	false	การดำเนินการที่อนุญาตให้ผู้ลงนามทำได้
	allowTransfer				boolean	false	อนุญาตให้ผู้ลงนามส่งต่อซองนี้ให้ผู้อื่นลงนามได้หรือไม่ ค่าเริ่มต้นคือ false true-อนุญาตให้ผู้ลงนามในซองมีสิทธิ์ส่งต่อซองให้ผู้อื่น; false-ไม่อนุญาตให้ผู้ลงนามในซองมีสิทธิ์ส่งต่อซองให้ผู้อื่น;
	allowModifyName				boolean	false	อนุญาตให้ผู้ลงนามแก้ไขชื่อได้หรือไม่ มีผลเฉพาะกับการลงนามในเทมเพลต ค่าเริ่มต้นคือ false true-อนุญาตให้ผู้ลงนามแก้ไขชื่อ false-ไม่อนุญาตให้ผู้ลงนามแก้ไขชื่อ
expireAfterSeconds					long	false	เวลาหมดอายุของซอง ระบุจำนวนวินาทีหลังจากนั้นซองจะหมดอายุ ช่วงเวลาที่กำหนด: 86,400 วินาที (1 วัน) ~ 7,776,000 วินาที (90 วัน)
redirectUrl					string	false	ต้องเป็นที่อยู่ https ที่ถูกต้อง
callBackUrl					string	false	ที่อยู่สำหรับเรียกกลับ (ความยาวสูงสุด 500 ตัวอักษร) ต้องเป็นไปตามโปรโตคอล https
sendLaterAfterSeconds					long	false	รองรับการเลื่อนการส่งของผู้ใช้ หน่วยเป็นวินาที ช่วงเวลาที่รองรับ: 3,600 วินาที (1 ชั่วโมง) ~ 259,200 วินาที (30 วัน)
autoFinish					boolean	false	ควบคุมว่าซองจะสิ้นสุดอัตโนมัติหรือไม่ ค่าเริ่มต้นคือ true true-ซองสิ้นสุดอัตโนมัติ false-ซองสิ้นสุดด้วยตนเอง
CCInfos					array	false	ชุดข้อมูลผู้รับสำเนา
	userEmail				string	false	ที่อยู่อีเมลของผู้รับสำเนา
	userName				string	false	ชื่อของผู้รับสำเนา ใช้แสดงชื่อผู้รับสำเนาในหน้าลงนามและบนซองจดหมาย 【หมายเหตุ】: ห้ามใช้ตัวอักษรพิเศษทั้ง 9 ตัวต่อไปนี้: / \ : * " < > \| ? และห้ามใช้อิโมจิทั้งหมด
	ccOrder				int	false	ตำแหน่งลำดับของผู้รับสำเนาในขั้นตอนการลงนาม โดยจะใช้ลำดับร่วมกับ signOrder ของผู้ลงนาม หากไม่ระบุ จะใช้ตรรกะการแจ้งเตือนผู้รับสำเนาเดิม
	customizeSettings				object	false	การกำหนดค่าแบบกำหนดเอง
		notificationSettings			object	false	การกำหนดค่าแบบกำหนดเองสำหรับประเภทการแจ้งเตือน
			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 ภาษาเกาหลี
signFiles					array	true	ข้อมูลชุดเอกสารที่ลงนาม แสดงตามลำดับการเพิ่มเอกสาร
	fileKey				string	true	fileKey ของเอกสารที่ลงนาม รองรับเฉพาะรูปแบบ PDF เท่านั้น
	documentFields				array	false	รายการคอนโทรลมิติไฟล์ ใช้เพื่อเพิ่มคอนโทรลมิติไฟล์ที่ไม่ผูกกับผู้ลงนามบนไฟล์ที่กำหนด
		fieldType			string	false	ประเภทคอนโทรล ส่งค่า eMeterai เพื่อแสดงคอนโทรลภาษีอากรของอินโดนีเซีย
		pageNo			string	false	หมายเลขหน้าที่มีคอนโทรล คอนโทรลภาษีอากรของอินโดนีเซียรองรับเพียงการระบุหน้าเดียว ต้องส่งหมายเลขหน้าเดี่ยว ไม่รองรับรูปแบบหลายหน้าต่อเนื่องหรือไม่ต่อเนื่อง เช่น 1-3, 1,3 เป็นต้น
		posX			float	false	ค่าเบี่ยงเบนแกน x จุดกำเนิดพิกัดอยู่ที่มุมล่างซ้ายของหน้า ขอบเขตพิกัดสอดคล้องกับขอบเขตพิกัดของคอนโทรลอื่นๆ
		posY			float	false	ค่าการเลื่อนแกน y โดยที่จุดกำเนิดของพิกัดอยู่ที่มุมล่างซ้ายของหน้ากระดาษ ขอบเขตของพิกัดจะสอดคล้องกับขอบเขตของพิกัดในองค์ประกอบอื่นๆ
attachments					array	false	ชุดไฟล์แนบแบบซองจดหมาย แสดงตามลำดับเวลาที่เพิ่มไฟล์
	fileKey				string	false	fileKey ของไฟล์
signerInfos					array	true	ชุดข้อมูลของผู้ลงนาม
	businessId				string	false	หมายเลขธุรกิจที่กำหนดโดยนักพัฒนา มีความยาวสูงสุด 500 ตัวอักษร
	roleTypes				array	false	วิธีการดำเนินการของผู้ลงนาม ค่าเริ่มต้นคือ `["sign", "fill"]` fill-กรอกข้อมูล sign-ลงนาม
	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 ภาษาเกาหลี
	signOrder				int	true	ลำดับการลงนามของผู้ลงนาม มีค่าต่ำสุดคือ 1 สามารถระบุลำดับเดียวกันสำหรับการลงนามแบบไม่มีลำดับได้
	signTaskSuspend				boolean	false	ตั้งค่าโหนดบล็อกกระบวนการก่อนตำแหน่งลงนามนี้หรือไม่ ค่าเริ่มต้นคือ false true-ตั้งค่าโหนดบล็อก; false-ไม่ตั้งค่าโหนดบล็อก การกำหนดค่าการบล็อกภายในกลุ่มหรือ (OR) ที่มี signOrder เดียวกันต้องสอดคล้องกัน
	suspensionKey				string	false	ตัวระบุโหนดบล็อก มีความยาวสูงสุด 500 ตัวอักษร และต้องเป็นค่าเดียวภายในซองเอกสารเดียวกัน จำเป็นต้องมีเมื่อ signTaskSuspend=true; ห้ามส่งเมื่อ signTaskSuspend=false หรือไม่ได้ส่งเข้ามา
	suspendReason				string	false	สาเหตุของการบล็อก เมื่อส่งเข้ามาจะต้องไม่ว่างเปล่า และความยาวสูงสุด 50 ตัวอักษร ส่งได้เฉพาะเมื่อ signTaskSuspend=true; หากไม่ส่งเข้ามา จะถือว่าโดยปกติแล้วจำเป็นต้องรอให้ระบบภายนอกดำเนินการ ห้ามส่งเมื่อ signTaskSuspend=false หรือไม่ได้ส่งเข้ามา
	anySigner				boolean	false	รองรับการลงนามโดยบุคคลใดก็ได้หรือไม่ ค่าเริ่มต้นคือ false true-เพียงคนเดียวในกลุ่มที่มี signOrder เดียวกันก็เพียงพอที่จะลงนาม false-ทุกคนในกลุ่มที่มี signOrder เดียวกันต้องลงนาม
	authModes				string	false	วิธีการตรวจสอบ ค่าเริ่มต้นคือ noAuth noAuth-ไม่มีการตรวจสอบ accessCode-ใช้รหัสผ่านลงนามเพื่อตรวจสอบ sms-การตรวจสอบด้วย SMS OTP idVerification-การตรวจสอบด้วยบัตรประจำตัว emailAuth-การตรวจสอบด้วยอีเมล OTP digitalId-การตรวจสอบตัวตนอิเล็กทรอนิกส์ whatsappAuth-การตรวจสอบด้วย WhatsApp OTP
	authConfig				object	false	การตั้งค่าวิธีการตรวจสอบ
		accessCode			object	false	การตั้งค่ารหัสผ่านลายเซ็น เมื่อ authModes=accessCodeจำเป็นต้องกรอก
			accessCode		string	false	เนื้อหาข้อความรหัสผ่าน ไม่แยกตัวพิมพ์ใหญ่-เล็ก สามารถประกอบด้วยตัวอักษรและตัวเลข ความยาวจำกัดสูงสุด 45 ตัวอักษร
			promptInfo		string	false	ข้อความแจ้งเตือนรหัสผ่านสำหรับการเข้าถึง ห้ามมีข้อความรหัสผ่านสำหรับการเข้าถึงอยู่ภายใน ความยาวจำกัดสูงสุด 30 ตัวอักษร เมื่อ authModes=accessCodeจำเป็นต้องกรอก
		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 สำหรับการยืนยันตัวตน iamsmart- ใช้ i AM Smart สำหรับการยืนยันตัวตน
			idNumber		string	false	หมายเลขบัตรประจำตัวของผู้ลงนามที่ต้องทำการยืนยัน เมื่อ authApp=singpassรูปแบบข้อมูลที่ส่งเข้าคือ: ตัวอักษรพิมพ์ใหญ่ + ตัวเลข 7 หรือ 8 หลัก + ตัวอักษรพิมพ์ใหญ่ เมื่อ authApp=iamsmartรูปแบบข้อมูลที่ส่งเข้าคือ: 1. ตัวอักษรพิมพ์ใหญ่หนึ่งตัว (A-Z) หรือสองตัว (AA-ZZ) เป็นส่วนเริ่มต้นของลำดับ; 2. ตามด้วยตัวเลข 6 หลัก; 3. สุดท้ายคือรหัสตรวจสอบ ซึ่งอาจเป็นตัวเลข (0-9) หรือตัวอักษร (A-Z) ตัวอย่าง: A888888(A)
		whatsappAuth			object	false	การยืนยัน OTP ผ่าน WhatsApp จำเป็นต้องมีเมื่อ authModes=whatsappAuth
			countryCode		string	false	รหัสระหว่างประเทศของภูมิภาค/ประเทศ ไม่ต้องใส่เครื่องหมาย “+”
			number		string	false	ไม่ตรวจสอบรูปแบบ จำกัดความยาวสูงสุดเพียง 13 หลัก
	digitalSignature				boolean	false	เปิดใช้งานลายเซ็นดิจิทัลหรือไม่ ค่าเริ่มต้นคือ false true-เปิดใช้งาน, false-ไม่เปิดใช้งาน
	tsp				string	false	เลือก TSP ที่ผู้ลงนามจะใช้ ค่าเริ่มต้นคือ false หากไม่ได้ตั้งค่า ผู้ลงนามจะเลือก TSP ที่ต้องการใช้เอง โดยค่าที่เป็นไปได้มีดังนี้: vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha
	freeFormSign				boolean	false	ผู้ลงนามสามารถประทับตรา/ลายเซ็นได้อย่างอิสระหรือไม่ ค่าเริ่มต้นคือ false คำอธิบายเพิ่มเติม: เมื่อตั้งค่า freeFormSign เป็น true ไม่จำเป็นต้องส่งพารามิเตอร์อื่นๆ ภายใต้ sealInfos หากส่งทั้งสองอย่างพร้อมกัน freeFormSign จะมีความสำคัญสูงกว่า sealInfos และพารามิเตอร์ภายใต้ sealInfos จะไม่มีผล [ข้อควรระวัง]การประทับตรา/ลายเซ็นแบบอิสระ หมายถึงไม่จำกัดจำนวนและตำแหน่งของตราประทับ/ลายเซ็นที่ผู้ลงนามสามารถลากวางได้
	documentVisibility				object	false	การกำหนดค่าความโปร่งใสของเอกสาร ค่าเริ่มต้นคือมองเห็นทั้งหมด
		documentViewType			string	false	กลยุทธ์การมองเห็น ค่าเริ่มต้นคือ all; all หมายถึงสามารถดูเอกสารทั้งหมดในซองจดหมายได้, limited หมายถึงสามารถดูเฉพาะเอกสารที่ตนเองลงนามและเอกสารเสริมที่อนุญาตให้มองเห็นได้เท่านั้น
		viewableFileKeys			array	false	รายการ fileKey ที่ระบุให้ผู้ลงนามฝ่ายอื่นอนุญาตให้ดูเพิ่มเติม; สามารถส่งและจะมีผลเฉพาะเมื่อ documentViewType=limited เท่านั้น
	sealInfos				array	false	ข้อมูลงานลงนาม
		fileKey			string	true	fileKey ของเอกสารลงนาม
		signConfigs			array	false	ข้อมูลตำแหน่งของคอนโทรล ต้องระบุข้อมูลตำแหน่งของคอนโทรลจึงจะสามารถทำลายเซ็นอิเล็กทรอนิกส์ได้
			fieldType		string	false	ประเภทของคอนโทรล ค่าเริ่มต้นคือ signature signature-คอนโทรลลายเซ็น stamp-คอนโทรลตราประทับ approval-คอนโทรลการอนุมัติ
			required		boolean	false	เป็นค่าบังคับหรือไม่ ค่าเริ่มต้นเป็นค่าบังคับ true-ค่าบังคับ false-ไม่บังคับ
			signFieldStyle		string	false	วิธีการวางตราประทับของคอนโทรลลงนาม ค่าเริ่มต้นคือ normalSeal normalSeal-ตราประทับธรรมดา pagingSeal-ตราประทับข้ามหน้า เฉพาะคอนโทรลลายเซ็นและคอนโทรลตราประทับเท่านั้นที่รองรับการตั้งค่าตราประทับข้ามหน้า
			pagingSealMode		string	false	ช่วงจำนวนหน้าที่วางตราประทับข้ามหน้า ค่าเริ่มต้นคือ all all-หมายเลขหน้าทั้งหมด assignedPages-หมายเลขหน้าเฉพาะ even-หน้าคู่ odd-หน้าคี่ รองรับการระบุเฉพาะเมื่อ signFieldStyle=pagingSeal เท่านั้น
			sizeRule		string	false	วิธีการแสดงขนาดพื้นที่ลงนาม originalSize-วางตราตามขนาดจริงของลายเซ็น/ตราประทับ targetSize-กำหนดความกว้างและความสูงของพื้นที่ลายเซ็น/ตราประทับเอง เมื่อ sizeRule, height และ width เป็นค่าว่างทั้งหมด จะวางตราตามขนาดจริงของลายเซ็น/ตราประทับ; เมื่อ sizeRule เป็นค่าว่าง แต่ height และ width มีค่า จะวางตราตามขนาดที่กำหนด; เมื่อ sizeRule มีค่า จะวางตราตามวิธีการแสดงผลที่กำหนด; ไม่จำเป็นต้องระบุพารามิเตอร์นี้สำหรับตราเย็บกระดาษ โดยจะวางตราตามขนาดจริงเท่านั้น
			height		int	false	ความสูงขององค์ประกอบลงนาม ใช้ได้กับ fieldType เป็น signature/stamp หน่วยเป็น px รองรับเฉพาะจำนวนเต็มบวก ค่าเริ่มต้นคือ auto (ระบบคำนวณขนาดอัตโนมัติ); เมื่อ fieldType=signature สามารถตั้งค่าได้ในช่วง 20-250px; เมื่อ fieldType=stamp สามารถตั้งค่าได้ในช่วง 30-280px; ไม่จำเป็นต้องระบุพารามิเตอร์นี้สำหรับตราเย็บกระดาษ
			width		int	false	ความกว้างขององค์ประกอบลงนาม ใช้ได้กับ fieldType เป็น signature/stamp หน่วยเป็น px รองรับเฉพาะจำนวนเต็มบวก ค่าเริ่มต้นคือ auto (ระบบคำนวณขนาดอัตโนมัติ); เมื่อ fieldType=signature สามารถตั้งค่าได้ในช่วง 20-250px; เมื่อ fieldType=stamp สามารถตั้งค่าได้ในช่วง 30-280px; ตราประทับข้ามหน้าไม่ต้องระบุพารามิเตอร์นี้
			signatureOptions		string	false	ตัวเลือกสำหรับวิดเจ็ตลายเซ็น ใช้ได้เฉพาะเมื่อ fieldType เป็น signature ค่าที่ส่งเข้าได้: template: ลายเซ็นจากเทมเพลต handDrawn: ลายเซ็นวาดด้วยมือ upload: อัปโหลดรูปภาพลายเซ็นจากเครื่องท้องถิ่น aiHandDrawn: ลายเซ็นเขียนด้วยมือโดย AI สามารถเลือกได้หลายค่า คั่นด้วย "," ค่าเริ่มต้นคือเลือกทั้งหมด
			movable		boolean	false	อนุญาตให้ย้ายตำแหน่งขณะลงนาม ค่าเริ่มต้นเป็น false false - ไม่อนุญาตให้ผู้ลงนามปรับตำแหน่งวิดเจ็ตการลงนามของตนเอง true - อนุญาตให้ผู้ลงนามปรับตำแหน่งวิดเจ็ตการลงนามของตนเอง
			allowedOptions		array	false	ตัวเลือกที่อนุญาตให้ผู้ลงนามอนุมัติ ใช้ได้เมื่อ fieldType เป็น approval ค่าเริ่มต้นคือ ["approve", "decline"] approve- ยอมรับ decline-ปฏิเสธ
			pageNo		string	false	หมายเลขหน้าลงนาม; ใช้ "-" เชื่อมต่อหมายเลขหน้าที่ต่อเนื่องกัน และใช้ "," แยกหมายเลขหน้าที่ไม่ต่อเนื่องกัน ตัวอย่าง: 1-3,6-10 เมื่อ pagingSealMode=assignedPages ให้ส่งช่วงหมายเลขหน้าที่ประทับตราข้ามหน้า โดยตราข้ามหน้าใช้ได้เฉพาะกับไฟล์ที่มีมากกว่า 1 หน้าเท่านั้น
			posX		float	false	พิกัดแกน x 【หมายเหตุ】หาก fieldType เป็น signature พิกัดจะหมายถึงตำแหน่งของพื้นที่ลายเซ็นมุมซ้ายล่าง； หาก fieldType เป็น stamp พิกัดจะหมายถึงตำแหน่งของพื้นที่การประทับตราจุดศูนย์กลางตำแหน่ง ตั้งแต่วันที่ 3 กุมภาพันธ์ 2026 เป็นต้นไป หาก fieldType เป็น signature หรือ stamp พิกัดจะหมายถึงตำแหน่งจุดศูนย์กลางของพื้นที่การประทับตรา สามารถส่งค่า 0 สำหรับตราข้ามหน้าได้ แต่ไม่สามารถส่ง null ได้ โดยองค์ประกอบจะถูกตรึงไว้ที่ขอบขวาของเอกสาร
			posY		float	false	พิกัดแกน y 【หมายเหตุ】หาก fieldType เป็น signature พิกัดจะหมายถึงตำแหน่งของพื้นที่ลายเซ็นมุมซ้ายล่าง； หาก fieldType เป็น stamp ตำแหน่งพิกัดหมายถึงพื้นที่ประทับตราจุดศูนย์กลางตำแหน่ง ตั้งแต่วันที่ 3 กุมภาพันธ์ 2026 เป็นต้นไป หาก fieldType เป็น signature หรือ stamp ตำแหน่งพิกัดหมายถึงจุดศูนย์กลางของพื้นที่ประทับตรา
		fillConfigs			array	false	กรอกข้อมูลคอนโทรล
			fieldName		string	false	ชื่อคอนโทรล จำกัดความยาวตัวอักษรที่ 128
			required		boolean	false	เป็นค่าบังคับหรือไม่ ค่าเริ่มต้นคือบังคับ true-บังคับ false-ไม่บังคับ
			fieldType		string	false	ประเภทคอนโทรล: 1-ข้อความบรรทัดเดียว 15-ช่องทำเครื่องหมาย
			textField		object	false	คุณสมบัติของคอนโทรลข้อความ
				overflowType	int	false	มีผลเฉพาะกับ text เท่านั้น ค่าเริ่มต้นคือ 1 1-ปรับขนาดตัวอักษรอัตโนมัติ 2-จำกัดการป้อนข้อมูล
				minFontSize	float	false	มีผลเฉพาะกับ text, มีผลเฉพาะเมื่อ overflowType=1, ค่าเริ่มต้นคือ 8 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
				width	int	false	ความกว้างของคอนโทรล, ค่าเริ่มต้นคือ 160px
				font	int	false	มีผลเฉพาะกับ text, ฟอนต์, ค่าเริ่มต้นคือ Songti 1-Songti 2-New Songti 4-Heiti 5-Kaiti 6-Arial 7-Helvetica 9-Times New Roman 10-Fangsong 11-Georgia 12-Monospace
				fontSize	float	false	มีผลเฉพาะกับ text, ขนาดฟอนต์, ค่าเริ่มต้นคือ 12 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
				textColor	string	false	มีผลเฉพาะกับ text, สีในรูปแบบ hex, ค่าเริ่มต้นคือสีดำ #000
				bold	boolean	false	มีผลเฉพาะกับ text, ตัวอักษรเป็นตัวหนาหรือไม่, ค่าเริ่มต้นคือ false true-ตัวหนา false-ไม่ตัวหนา
				italic	boolean	false	มีผลเฉพาะกับ text, ตัวอักษรเป็นตัวเอียงหรือไม่, ค่าเริ่มต้นคือ false true-ตัวเอียง false-ไม่ตัวเอียง
				underline	boolean	false	มีผลเฉพาะกับ text เท่านั้น กำหนดว่าจะเพิ่มขีดเส้นใต้หรือไม่ ค่าเริ่มต้นคือ false true-เพิ่มขีดเส้นใต้ false-ไม่เพิ่มขีดเส้นใต้
				lineThrough	boolean	false	มีผลเฉพาะกับ text เท่านั้น กำหนดว่าจะเพิ่มขีดฆ่าหรือไม่ ค่าเริ่มต้นคือ false true-เพิ่มขีดฆ่า false-ไม่เพิ่มขีดฆ่า
				horizontalAlignment	string	false	มีผลเฉพาะกับ text เท่านั้น จัดรูปแบบให้อยู่กึ่งกลางแนวนอน ค่าเริ่มต้นคือ left LEFT-ชิดซ้าย CENTER-กึ่งกลาง RIGHT-ชิดขวา
			tickBoxField		object	false	คุณสมบัติของช่องทำเครื่องหมาย
				tickOptions	array	false	มีผลเฉพาะกับ tickBox เท่านั้น ค่าเริ่มต้นคือ 1 1-ถูกเลือก 2-叉
			posX		float	false	ตำแหน่ง X ขององค์ประกอบควบคุม
			posY		float	false	ตำแหน่ง Y ขององค์ประกอบควบคุม
			pageNo		string	false	หมายเลขหน้าที่มีองค์ประกอบควบคุมอยู่
		signDateConfigs			array	false	ข้อมูลตำแหน่งวันที่ลงนาม
			movable		boolean	false	อนุญาตให้เคลื่อนย้ายตำแหน่งขณะลงนาม ค่าเริ่มต้นคือ false false - ไม่อนุญาตให้ผู้ลงนามปรับตำแหน่งองค์ประกอบควบคุมการลงนามของตนเอง true - อนุญาตให้ผู้ลงนามปรับตำแหน่งองค์ประกอบควบคุมการลงนามของตนเอง
			pageNo		string	false	หมายเลขหน้าลงนาม; หน้าต่อเนื่องใช้ "-" คั่น, หน้าไม่ต่อเนื่องใช้ "," คั่น ตัวอย่าง: 1-3, 6-10; หากไม่ต่อเนื่อง ให้ใช้ "," เพื่อแบ่ง
			posX		float	false	ค่าเบี่ยงเบนแกน x จุดกำเนิดพิกัดอยู่ที่มุมล่างซ้ายของหน้า
			posY		float	false	ค่าเบี่ยงเบนแกน y จุดกำเนิดพิกัดอยู่ที่มุมล่างซ้ายของหน้า
			signDateFormat		string	false	รูปแบบวันที่ลงนาม รูปแบบเริ่มต้นคือ yyyy-MM-dd รองรับรูปแบบที่กำหนด: yyyy ปี MM เดือน dd วัน yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MMM dd,yyyy dd MMM yyyy

ตัวอย่างคำขอ

{
    "subject": "员工入职合约",
    "remark": "这是描述",
    "expireAfterSeconds": 86400,
    "redirectUrl": "https://app-sml.esignglobal.com/home/main/esign/contract/list/inbox",
    "CCInfos": [
      {
        "userEmail": "cc_user@esignglobal.com",
        "userName": "cc_user_name",
        "ccOrder": 1
      }
    ],
    "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
    "signerInfos": [
      {
        "userEmail": "sender_user@tsign.cn",
        "userName": "sender_user_name",
        "phoneNumber": {
        	"countryCode": "86",
        	"number": "158****9242"
        }
        "signOrder": 1,
        "signTaskSuspend": true,
        "suspensionKey": "approval-node-001",
        "suspendReason": "等待外部审批",
        "authModes": "sms",
        "authConfig": {
            "sms": {
                "countryCode": "86",
                "number": "158****9242"
            }
        },
        "sealInfos": [
        {
            "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
            "signConfigs": [
              {
                "fieldType": "stamp",
                "pageNo": "1,3-5",
                "posX": 100.22222,
                "posY": 100.11111
              }
              "fillConfigs": [
              {
                "fieldId": "df0dd777bc774a2ba3fec4d108de242d",
                "fieldKey": "必填单行文本自动缩小字号最小字号Arial",
                "pageNo": "1",
                "posX": "88.70021",
                "posY": 745.409,
                "fieldType": "1",
                "required": true,
                "textField": {
                    "overflowType": "1",
                    "minFontSize": 8,
                    "font": "6",
                    "fontSize": "12",
                    "textColor": "#54ACD2",
                    "bold": false,
                    "italic": true,
                    "lineThrough": false,
                    "horizontalAlignment": "RIGHT"
                }
              },
              {
                  "fieldId": "888b899853544c49bd819d9f6d1e52cf",
                  "fieldKey": "必填勾选控件不限制选中样式不显示边框",
                  "pageNo": "3",
                  "posX": 451.77127,
                  "posY": 429.07626,
                  "fieldType": "15",
                  "required": true,
                  "tickBoxField": {
                      "tickOptions": [1,2],
                      "showBorder": false
                  }
                }
              ]
            ],
            "signDateConfigs":[
              {
                "pageNo":"1",
                "posX": 100.22,
                "posY": 100,
                "signDateFormat": "dd MMM yyyy"
              }
            ]
        }
      ]
    }
  ]
}

พารามิเตอร์การตอบกลับ

ชื่อพารามิเตอร์		ประเภท	คำอธิบาย
envelopeId		string	ID ห่อเอกสาร
CCInfos		array	ชุดข้อมูลผู้รับสำเนา
	userEmail	string	ที่อยู่อีเมลของผู้รับสำเนา
	userName	string	ชื่อของผู้รับสำเนา
signFiles		array	ชุดข้อมูลไฟล์ลายเซ็น
	fileKey	string	fileKey ของไฟล์ลายเซ็น
attachments		array	ชุดข้อมูลไฟล์แนบในห่อเอกสาร
	fileKey	string	fileKey ของไฟล์
signerInfos		array	ข้อมูลลายเซ็น
	recipientId	string	ID ผู้ลงนาม
	businessId	string	หมายเลขธุรกิจที่กำหนดโดยผู้พัฒนาเอง ความยาวจำกัดที่ 500
	userEmail	string	ที่อยู่อีเมลของผู้ลงนาม
	userName	string	ชื่อของผู้ลงนาม
	signUrl	string	ที่อยู่ลิงก์การลงนาม
	signOrder	int	ลำดับการลงนามของผู้ลงนาม ค่าต่ำสุดคือ 1
	accessCode	string	รหัสผ่านสำหรับการเข้าถึงหน้าลงนาม

ตัวอย่างการตอบสนอง

{
  "code": "0",
    "data": {
    "signerInfos": [
      {
        "accessCode": "123456",
        "userEmail": "sender_user@tsign.cn",
        "signUrl": "http://app-test.esignglobal-inc.com/home/main/sign/start/base/dosign?envelopeId=4cd738a60225445f9d5f3afec468a639&signature=eyJhbGciOiJIUzI1NiIsInppcCI6IkRFRiJ9.eNqqVkrOzytJrShRsqpWSs0rS83JL0gNSSzO9kxRslJKtjC1MDKxTDVIMzA0SU4xSTIwNjAxSDRNTTVKMTIxTFOqrQUAAAD__w.YMBA5X9O8Ylk7x2rma-s1WxGwo2cjqy-O9CCQopzw88&tenantToken=AA0DDgQ0Y2Q3MzhhNjAyMjU0NDVmOWQ1ZjNhZmVjNDY4YTYzuQ4GNGNkNzM4YTYwMjI1NDQ1ZjlkNWYzYWZlYzQ2OGE2M7kOCjRjZDczOGE2MDIyNTQ0NWY5ZDVmM2FmZWM0NjhhNjO5AIBjNDIwMzg1ZDMyYzU0MGE4YTk1ZTE3ZTNkZmZjMDNm4g%3D%3D",
        "userName": "sender_user_name",
        "signOrder": "1"
      }
    ],
      "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
      "envelopeId": "4cd738a60225445f9d5f3afec468a639"
  },
  "message": "success"
}