ค้นหาข้อมูลรายละเอียดแม่แบบซองจดหมาย

GET /esignglobal/v1/envelopeTemplates/envelopeTemplateDetail

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

ค้นหาคุณสมบัติโดยละเอียดของ “แม่แบบซองเอกสาร” ที่กำหนดค่าไว้ล่วงหน้าในฝั่งหน้าเว็บ (ประกอบด้วยโครงสร้างไฟล์ บทบาทของผู้มีส่วนร่วม และ Key ระบุตัวควบคุมที่กำหนดไว้ล่วงหน้าทั้งหมด)

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

ชื่อพารามิเตอร์

ประเภท

จำเป็น

คำอธิบาย

envelopeTemplateId

string

true

ID แม่แบบซองเอกสาร

queryComponents

boolean

false

ต้องการดึงข้อมูลตัวควบคุมหรือไม่ ค่าเริ่มต้นคือ false

true-ใช่

false-ไม่

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

 {
 	"envelopeTemplateId":"dc4be9641a3145bea97809018d7a9180",
 	"queryComponents":true
 }

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

ชื่อพารามิเตอร์					ประเภท	คำอธิบาย
code					int	รหัสธุรกิจ, 0 หมายถึงสำเร็จ, ค่าอื่นหมายถึงเกิดข้อผิดพลาด
message					string	ข้อมูลธุรกิจ กรุณาตรวจสอบสถานะข้อผิดพลาดจาก code ไม่ควรอาศัยการจับคู่ message เนื่องจาก message อาจมีการปรับเปลี่ยนได้
data					object	ข้อมูลธุรกิจ
	envelopeTemplateId				string	ID แม่แบบซองจดหมาย
	envelopeTemplateName				string	ชื่อแม่แบบกระบวนการทำงาน
	envelopeTemplateStatus				int	สถานะความพร้อมใช้งานของแม่แบบกระบวนการทำงาน 1-เปิดใช้งาน 0-ปิดใช้งาน
	digitalSignature				boolean	เปิดใช้งานลายเซ็นดิจิทัล true-เปิดใช้งาน false-ปิดใช้งาน
	signFiles				array	ข้อมูลไฟล์
		documentId			string	ID ไฟล์
		fileName			string	ชื่อไฟล์
	participants				array	ผู้เข้าร่วม
		participantId			string	รหัสผู้เข้าร่วม
		participantSetMode			string	ข้อกำหนดการเข้าร่วม (วิธีการกำหนดผู้เข้าร่วม) presetSigner-ระบุเมื่อใช้งานเทมเพลต (ผู้ใช้เทมเพลตเป็นผู้กำหนดเอง) dedicateSigner-สมาชิกถาวร (ถูกตรึงไว้ในเทมเพลตและไม่สามารถแก้ไขได้) sender-ผู้เริ่มดำเนินการ
		participantInfos			object	ผู้เข้าร่วมส่วนบุคคล
			userEmail		string	อีเมลผู้ลงนาม
			phoneNumber		object	หมายเลขโทรศัพท์ ค่าเริ่มต้นเป็นค่าว่าง พารามิเตอร์บังคับเมื่อต้องการแจ้งเตือนทาง SMS โดยต้องส่งค่า countryCode และ number มาด้วย
				countryCode	string	รหัสประเทศหรือภูมิภาคแบบสากล ไม่ต้องใส่เครื่องหมาย “+”
				number	string	ไม่มีการตรวจสอบรูปแบบ จำกัดความยาวสูงสุดเพียง 13 หลัก
			userName		string	ชื่อส่วนบุคคล
			deliveryMethod		string	วิธีการแจ้งเตือน auto-ส่งการแจ้งเตือนทางอีเมลเมื่อระบุ userEmail และส่งการแจ้งเตือนทาง SMS เมื่อระบุ phoneNumber none-ไม่ส่งการแจ้งเตือนข้อความ email-ส่งการแจ้งเตือนทางอีเมล sms-ส่งการแจ้งเตือนทาง SMS WhatsApp-ส่งการแจ้งเตือนผ่าน WhatsApp
			customizeSettings		object	การกำหนดค่าเอง
				customizeMessage	string	ข้อความเฉพาะ จำนวนตัวอักษรสูงสุด 1000
				notificationLanguage	string	ภาษาสำหรับการแจ้งเตือน โดยตั้งค่าเริ่มต้นเป็นภาษาอังกฤษ en-US ภาษาอังกฤษ zh-CN ภาษาจีนตัวย่อ zh-Hant ภาษาจีนตัวเต็ม ja ภาษาญี่ปุ่น 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	ลำดับการลงนาม 1-255 สามารถใช้ซ้ำสำหรับผู้เข้าร่วมต่างกันได้
		willingnessAuthModes			string	ผู้ลงนามสามารถเลือกวิธีการแสดงความจำนงได้ โดยคั่นด้วยเครื่องหมายจุลภาคภาษาอังกฤษ noAuth-ไม่มีการตรวจสอบ accessCode-ยืนยันโดยใช้รหัสผ่านลงนาม sms-การยืนยัน OTP ผ่าน SMS idVerification-การยืนยันบัตรประจำตัว emailAuth-การยืนยัน OTP ผ่านอีเมล digitalId-การยืนยันตัวตนดิจิทัล whatsappAuth-การยืนยัน OTP ผ่าน WhatsApp
			accessCode		object	การตั้งค่ารหัสผ่านสำหรับการลงนาม จำเป็นต้องกรอกเมื่อ authModes=accessCode
				accessCode	string	เนื้อหาของรหัสผ่าน ไม่แยกตัวพิมพ์ใหญ่-เล็ก สามารถประกอบด้วยตัวอักษรและตัวเลขได้ จำกัดความยาวสูงสุด 45
				promptInfo	string	ข้อความแจ้งเตือนรหัสผ่านสำหรับเข้าถึง ไม่สามารถระบุรหัสผ่านสำหรับเข้าถึงได้ จำกัดความยาวสูงสุด 30 ต้องกรอกเมื่อ authModes=1
			sms		object	การตรวจสอบ OTP ผ่าน SMS จำเป็นต้องกรอกเมื่อ authModes=sms
				countryCode	string	รหัสระหว่างประเทศของภูมิภาค/ประเทศ ไม่ต้องส่งค่า “+”
				number	string	ไม่มีการตรวจสอบรูปแบบ จำกัดความยาวสูงสุดเพียง 13 หลัก
			idVerification		object	การตั้งค่าการยืนยันบัตรประจำตัว จำเป็นต้องกรอกเมื่อ authModes=idVerification
				name	string	ชื่อเต็มบนบัตรประจำตัวของผู้ลงนาม ความยาวสูงสุด 100 ตัวอักษร
			emailAuth		object	การตรวจสอบ OTP ผ่านอีเมล จำเป็นต้องกรอกเมื่อ authModes=emailAuth
				authEmail	string	ที่อยู่อีเมลสำหรับยืนยันตัวตนของผู้ลงนาม
			digitalId		array	การยืนยันตัวตนแบบดิจิทัล จำเป็นต้องกรอกเมื่อ authModes=digitalId
				authApp	string	แอปพลิเคชันที่ใช้สำหรับการยืนยันตัวตนแบบดิจิทัล singpass-ใช้ Singpass สำหรับการยืนยันตัวตน iamsmart-ใช้ iAM Smart สำหรับการยืนยันตัวตน
				idNumber	string	หมายเลขบัตรประจำตัวของผู้ลงนามที่ต้องตรวจสอบ
			whatsappAuth		object	การตรวจสอบ OTP ผ่าน WhatsApp จำเป็นต้องกรอกเมื่อ authModes=whatsappAuth
				countryCode	string	รหัสประเทศหรือภูมิภาคแบบสากล ไม่ต้องใส่เครื่องหมาย “+”
				number	string	ไม่มีการตรวจสอบรูปแบบ จำกัดความยาวสูงสุดเพียง 13 หลัก
		components			object	ข้อมูลคอนโทรล
	copiers				array	ตั้งค่าผู้รับสำเนา
		copierId			string	รหัสผู้เข้าร่วม
		editable			boolean	อนุญาตให้แก้ไขได้เมื่อเริ่มต้นหรือไม่
		CCInfos			object	ข้อมูลผู้รับสำเนา
			userEmail		string	อีเมล
			userName		string	ชื่อส่วนบุคคล
			customizeSettings		object	การตั้งค่าแบบกำหนดเอง
				notificationSettings	object	การตั้งค่าแบบกำหนดเองประเภทการแจ้งเตือน
				notificationLanguage	string	ภาษาสำหรับการแจ้งเตือน ค่าเริ่มต้นคือภาษาอังกฤษ en-US ภาษาอังกฤษ zh-CN ภาษาจีนตัวย่อ zh-Hant ภาษาจีนตัวเต็ม ja ภาษาญี่ปุ่น ES-MX ภาษาสเปน
	attachments				array	ข้อมูลไฟล์แนบ
		editable			boolean	อนุญาตให้แก้ไขได้เมื่อเริ่มดำเนินการหรือไม่
		fileKey			string	filekey ของไฟล์แนบ
		fileName			string	ชื่อไฟล์แนบ
		downloadUrl			string	ลิงก์ดาวน์โหลดไฟล์ PDF ฉบับร่าง มีอายุการใช้งาน 60 นาที
components					array	รายการคอนโทรล
	documentId				string	key ของไฟล์ที่คอนโทรลสังกัดอยู่
	componentId				string	ID ของคอนโทรล
	componentKey				string	คีย์ของคอนโทรล (ตัวระบุคอนโทรลที่ผู้ใช้กรอกเมื่อตั้งค่าเทมเพลตไฟล์)
	componentName				string	ชื่อคอนโทรล
	componentType				string	ประเภทคอนโทรล 1, ข้อความ 2, ตัวเลข 3, วันที่ 6, พื้นที่ลงนามทั่วไป 8, ข้อความหลายบรรทัด 9, กล่องกาเครื่องหมาย 10, ตัวเลือกเดียว 11, รูปภาพ 14, คอนโทรลตัวเลือกแบบเลื่อนลง 15, คอนโทรลกล่องกาเครื่องหมาย 20，พื้นที่ตราประทับ 21, พื้นที่อนุมัติ 22, วันที่ลงนาม 23, อีเมล 100, สกุลเงินหยวน
	componentDefaultValue				string	ค่าเริ่มต้นของคอนโทรล
	componentPosition				object	ตำแหน่งของคอนโทรล
		componentPositionX			float	พิกัดแกน X ของตำแหน่งคอนโทรล
		componentPositionY			float	พิกัดแกน Y ของตำแหน่งคอนโทรล
		componentPageNum			int	หมายเลขหน้าที่คอนโทรลตั้งอยู่
	componentSize				object	ขนาดของคอนโทรล
		componentWidth			int	ความกว้างของคอนโทรล (ระยะห่างขอบซ้ายขวาของรูปสี่เหลี่ยม หน่วยเป็น px)
		componentHeight			int	ความสูงของคอนโทรล (ระยะห่างขอบบนล่างของรูปสี่เหลี่ยม หน่วยเป็น px)
	componentTextFormat				object	รูปแบบตัวอักษรของคอนโทรล
		font			int	แบบอักษรสำหรับเติม, ค่าเริ่มต้น 1, 1-ซงไท่, 2-ซงไท่ใหม่, 4-เฮยไท่, 5-ไคไท่
		fontSize			float	ขนาดตัวอักษรเติม, ค่าเริ่มต้น 12-小四 42-初号 36-小初 26-一号 24-小一 22-二号 19-小二 16-三号 15-小三 14-四号 12-小四 10.5-五号 9-小五
		textColor			string	สีตัวอักษร, ค่าเริ่มต้น #000000 สีดำ
		bold			boolean	เป็นตัวหนาหรือไม่, ค่าเริ่มต้น false true-ใช่ false-ไม่
		italic			boolean	เป็นตัวเอียงหรือไม่ ค่าเริ่มต้นคือ false true-ใช่ false-ไม่
		horizontalAlignment			string	การจัดตำแหน่งแนวนอน ค่าเริ่มต้นคือ 1-จัดชิดซ้าย LEFT-จัดชิดซ้าย CENTER-จัดกึ่งกลาง RIGHT-จัดชิดขวา
		verticalAlignment			string	การจัดตำแหน่งแนวตั้ง ค่าเริ่มต้นคือ 1-จัดชิดบน (ใช้กับข้อความหลายบรรทัด) TOP-จัดชิดบน MIDDLE-จัดกึ่งกลาง BOTTOM-จัดชิดล่าง
		textLineSpacing			float	ระยะห่างระหว่างบรรทัด ค่าเริ่มต้นคือ 1.0 รองรับการป้อนทศนิยมได้สูงสุดหนึ่งตำแหน่ง ค่าสูงสุดคือ 2.0 (ใช้กับข้อความหลายบรรทัด)
	required				boolean	จำเป็นต้องกรอกหรือไม่ true-ต้องกรอก false-ไม่จำเป็นต้องกรอก
	componentMaxLength				string	ความยาวสูงสุดที่กรอกได้ของคอนโทรล (จำนวนตัวอักษรจีน)
	componentSpecialAttribute				object	คุณสมบัติเฉพาะของคอนโทรล
		numberFormat			string	รูปแบบตัวเลข (คอนโทรลตัวเลข) จำนวนเต็ม: 0 ทศนิยมหนึ่งตำแหน่ง: 0.0 ทศนิยมสองตำแหน่ง: 0.00
		dateFormat			string	รูปแบบวันที่ (คอนโทรลวันที่)
		imageType			string	ประเภทรูปภาพ (คอนโทรลรูปภาพ) IDCard_widthwise บัตรประชาชน แนวนอน ล็อกอัตราส่วน IDCard_longitudinal บัตรประชาชน แนวตั้ง ล็อกอัตราส่วน other อื่นๆ ไม่ล็อกอัตราส่วน
		options			array	ตัวเลือก (คอนโทรลเลือกจากเมนูแบบเลื่อนลง, คอนโทรลตัวเลือกเดียว, คอนโทรลหลายตัวเลือก)
			optionOrder		int	ลำดับตัวเลือก
			optionContent		string	เนื้อหาตัวเลือก
			selected		boolean	เลือกโดยค่าเริ่มต้นหรือไม่
			optionPositionX		float	พิกัด X ขององค์ประกอบย่อยภายในกรอบตัวควบคุมหลัก
			optionPositionY		float	พิกัด Y ขององค์ประกอบย่อยภายในกรอบตัวควบคุมหลัก
			optionWidth		float	ความกว้างขององค์ประกอบย่อย
			optionHeight		float	ความสูงขององค์ประกอบย่อย
	signField				object	คุณสมบัติของพื้นที่ลงนามและประทับตราทั่วไป
		fieldStyle			int32	รูปแบบพื้นที่ลงนามและประทับตรา 1-พื้นที่ลงนามและประทับตราหน้าเดียว 2-พื้นที่ลงนามและประทับตราข้ามหน้า
		sizeRule			int	ขนาดตราประทับ 1-ประทับตราตามขนาดจริงของตราประทับ 2-กำหนดขนาดเอง (ปรับตามความกว้างและความสูงของพื้นที่ลงนาม)
		movable			boolean	true-สามารถย้ายตำแหน่งได้ขณะลงนาม false-ไม่สามารถย้ายตำแหน่งได้ขณะลงนาม
	stampField				object	คุณสมบัติของพื้นที่ตราประทับ
		fieldStyle			int	รูปแบบพื้นที่ลายเซ็นและตราประทับ 1-พื้นที่ลายเซ็นและตราประทับหน้าเดียว 2-พื้นที่ลายเซ็นและตราประทับข้ามหน้ากระดาษ
		sizeRule			int	ขนาดตราประทับ 1-ประทับตราตามขนาดตราประทับจริง 2-กำหนดขนาดเอง (ปรับตามความกว้างและความสูงของพื้นที่ลงนาม)
		movable			boolean	true-สามารถย้ายตำแหน่งได้ขณะลงนาม false-ไม่สามารถย้ายตำแหน่งได้ขณะลงนาม
	signDateField				object	คุณสมบัติวันที่ลงนาม
		dateFormat			string	รูปแบบวันที่: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	approvalField				object	คุณสมบัติพื้นที่อนุมัติ
		allowedOptions			array	ตัวเลือกที่อนุญาตให้ผู้ลงนามอนุมัติ ใช้เมื่อ fieldType เป็น approval ค่าเริ่มต้นคือ ["approve", "decline"] approve-เห็นชอบ decline-ปฏิเสธ

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

{
  "code": "0",
  "data": {
    "envelopeTemplateName": "test",
    "signFiles": [
      {
        "fileDownloadUrl": "https://******",
        "fileName": "***.pdf",
        "documentId": "$eac****-d6f8-4b6b-bafe-******$3328404894"
      }
    ],
    "attachments": [],
    "digitalSignature": false,
    "envelopeTemplateStatus": 1,
    "independentComponents": [],
    "envelopeCategoryId": null,
    "envelopeTemplateId": "dc4be9641a3145bea97809018d7a9180",
    "participants": [
      {
        "participantFlag": "",
        "idVerification": null,
        "components": [
          {
            "componentType": "10",
            "componentId": "556b60f7bd324428908b41f3bbec8c54",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 485.42538,
              "componentPositionX": 35.96627,
              "componentPageNum": "1"
            },
            "componentSpecialAttribute": {
              "options": [
                {
                  "optionContent": "***",
                  "optionHeight": 32.923893,
                  "optionOrder": 0,
                  "optionPositionY": 85.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项二",
                  "optionHeight": 15.0,
                  "optionOrder": 1,
                  "optionPositionY": 60.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项三",
                  "optionHeight": 15.0,
                  "optionOrder": 2,
                  "optionPositionY": 35.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项四",
                  "optionHeight": 15.0,
                  "optionOrder": 3,
                  "optionPositionY": 10.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                }
              ],
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 128,
              "componentWidth": 144
            },
            "signDateField": null,
            "required": true,
            "stampField": null,
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "单选1",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          },
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "****",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "42750b92c7a***05134dd5342",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "presetSigner",
        "emailAuth": null
      },
      {
        "participantFlag": "***",
        "idVerification": null,
        "components": [
          {
            "componentType": "20",
            "componentId": "7c401b43cdc94b61a7813aa58ac82bbf",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 327.15793,
              "componentPositionX": 109.17395,
              "componentPageNum": "2"
            },
            "componentSpecialAttribute": {
              "options": null,
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 150,
              "componentWidth": 150
            },
            "signDateField": null,
            "required": true,
            "stampField": {
              "movable": false,
              "sizeRule": 1,
              "fieldStyle": 1
            },
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "图章区",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          }
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "***",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "b055dfce00c5******40cdabb23822ea4",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "dedicateSigner",
        "emailAuth": null
      }
    ],
    "copiers": []
  },
  "message": "SUCCESS"
}