เริ่มการลงนามโดยใช้แม่แบบซอง

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

คำอธิบาย API

ใช้ "แม่แบบซองเอกสาร" ที่กำหนดค่าไว้ล่วงหน้าบนหน้าเว็บเพื่อเริ่มการลงนาม

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

ชื่อพารามิเตอร์				ประเภท	ต้องระบุ	คำอธิบาย
envelopeTemplateId				string	true	รหัสแม่แบบซองเอกสาร
envelopeConfig				object	true	การตั้งค่าขั้นตอนการลงนาม
	contractConfig			boolean	false	การตั้งค่าการลงนามในสัญญา
		envelopeRemark		array	false	หมายเหตุสัญญา
	envelopeSubject			string	true	หัวข้อของขั้นตอนการลงนามครั้งนี้
	expireAfterSeconds			int	false	เวลาสิ้นสุดการลงนามของขั้นตอนครั้งนี้ หากเลยเวลานี้ไปแล้วจะไม่สามารถลงนามได้อีก ใช้รูปแบบ Unix Timestamp หน่วยมิลลิวินาที ค่าเริ่มต้นและระยะเวลาสูงสุดคือ 90 วัน
	callbackUrl			string	false	ที่อยู่เว็บสำหรับรับการแจ้งเตือนแบบ Callback
	redirectUrl			string	false	ต้องเป็นที่อยู่ https ที่ถูกต้อง
	signConfig			object	false	รายการกำหนดค่าการลงนาม
		allowTransfer		boolean	false	อนุญาตให้ผู้ลงนามโอนซองนี้ให้ผู้อื่นลงนามหรือไม่ ค่าเริ่มต้นคือ false true-อนุญาตให้ผู้ลงนามในซองมีสิทธิ์โอนซองให้ผู้อื่น; false-ไม่อนุญาตให้ผู้ลงนามในซองมีสิทธิ์โอนซองให้ผู้อื่น;
participants				array	false	การตั้งค่าผู้เข้าร่วม
	participantId			string	true	รหัสผู้เข้าร่วม
	authConfig			object	false	รายการกำหนดค่าการยืนยันตัวตน
		willingnessAuthModes		array	false	วิธีการแสดงเจตจำนงที่ผู้ลงนามสามารถเลือกได้ ค่าเริ่มต้นคือ noAuth noAuth-ไม่มีการตรวจสอบ accessCode-ใช้รหัสผ่านสำหรับการลงนามเพื่อตรวจสอบ sms-การตรวจสอบด้วย OTP ผ่าน SMS idVerification-การตรวจสอบด้วยเอกสารระบุตัวตน emailAuth-การตรวจสอบด้วย OTP ทางอีเมล digitalId-การตรวจสอบตัวตนดิจิทัล whatsappAuth-การตรวจสอบด้วย OTP ผ่าน WhatsApp
		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 ในการยืนยันตัวตน iamsmart-ใช้ iAM SMART ในการยืนยันตัวตน
			idNumber	string	false	หมายเลขเอกสารประจำตัวของผู้ลงนามที่ต้องการให้ทำการยืนยัน
		whatsappAuth		object	false	การตรวจสอบ OTP ของ WhatsApp จำเป็นต้องกรอกเมื่อ authModes=whatsappAuth
			countryCode	string	false	รหัสระหว่างประเทศของภูมิภาคหรือประเทศ ไม่ต้องใส่เครื่องหมาย “+”
			number	string	false	ไม่มีการตรวจสอบรูปแบบ จำกัดความยาวสูงสุดเพียง 13 หลัก
	participantInfos			object	false	ผู้เข้าร่วมรายบุคคล
		userEmail		string	false	อีเมลของผู้ลงนาม
		phoneNumber		object	false	หมายเลขโทรศัพท์ ค่าเริ่มต้นเป็นค่าว่าง พารามิเตอร์บังคับเมื่อต้องการแจ้งเตือนผ่านข้อความ SMS ต้องส่งทั้ง countryCode และ number
			countryCode	string	false	รหัสระหว่างประเทศของภูมิภาคหรือประเทศ ไม่ต้องใส่เครื่องหมาย “+”
			number	string	false	ไม่มีการตรวจสอบรูปแบบ จำกัดความยาวสูงสุดเพียง 13 หลัก
		userName		string	false	ชื่อส่วนบุคคล
		deliveryMethod		string	false	วิธีการแจ้งเตือน none-ไม่ส่งการแจ้งเตือนข้อความ email-ส่งการแจ้งเตือนทางอีเมล sms-ส่งการแจ้งเตือนทางข้อความ SMS WhatsApp-ส่งการแจ้งเตือนทาง WhatsApp
		customizeSettings		object	false	การตั้งค่าแบบกำหนดเอง
			customizeMessage	object	false	การตั้งค่าแบบกำหนดเองประเภทการแจ้งเตือน
			notificationLanguage	string	false	ภาษาการแจ้งเตือน ค่าเริ่มต้นคือภาษาอังกฤษ en-US ภาษาอังกฤษ zh-CN ภาษาจีนตัวย่อ zh-Hant ภาษาจีนตัวเต็ม ja ภาษาญี่ปุ่น ES-MX ภาษาสเปน
copiers				array	false	เพิ่มผู้รับสำเนา
	copierId			string	true	ID ผู้เข้าร่วม
	CCInfos			object	false	ข้อมูลผู้รับสำเนา
		userEmail		string	false	อีเมล
		userName		string	false	ชื่อส่วนบุคคล
		customizeSettings		object	false	การตั้งค่าแบบกำหนดเอง
			customizeMessage	object	false	การตั้งค่าแบบกำหนดเองประเภทการแจ้งเตือน
			notificationLanguage	string	false	ภาษาการแจ้งเตือน ค่าเริ่มต้นคือภาษาอังกฤษ en-US ภาษาอังกฤษ zh-CN ภาษาจีนตัวย่อ zh-Hant ภาษาจีนตัวเต็ม ja ภาษาญี่ปุ่น ES-MX ภาษาสเปน
attchments				array	false	ข้อมูลไฟล์แนบเพิ่มเติม (ไฟล์ที่ไม่ต้องลงนาม)
	documentId			string	false	รหัสไฟล์แนบ
	fileName			string	false	ชื่อไฟล์แนบ
components				array	false	รายการคอนโทรล
	documentId			string	false	รหัสไฟล์ที่คอนโทรลสังกัดอยู่
	componentId			string	false	id ของคอนโทรล
	componentKey			string	false	key ของคอนโทรล (เลือกอย่างใดอย่างหนึ่งระหว่าง id ของคอนโทรลหรือ key ของคอนโทรล)
	componentValue			string	false	ค่าที่เติมลงในคอนโทรล
	editComponentValue			boolean	false	ควบคุมว่าผู้ลงนามของคอนโทรลนี้สามารถแก้ไขข้อมูลที่กรอกไว้ล่วงหน้าได้หรือไม่ โดยค่าเริ่มต้นคือ true true-ผู้ลงนามสามารถแก้ไขค่าที่กรอกไว้ล่วงหน้าได้ false-เมื่อมีค่าที่กรอกไว้ล่วงหน้าจะถูกล็อกเป็นโหมดอ่านอย่างเดียว ผู้ลงนามไม่สามารถแก้ไขได้

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

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

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

ชื่อพารามิเตอร์	ประเภท	คำอธิบาย
envelopeId	string	รหัสซอง

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

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