ดาวน์โหลดไฟล์

GET /esignglobal/v1/envelope/files/download

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

เมื่อซองลงนามอยู่ระหว่างดำเนินการหรือเสร็จสิ้นแล้ว สามารถดาวน์โหลดไฟล์ภายในซองได้ การดาวน์โหลดระหว่างกระบวนการลงนามอยู่ภายใต้การกำหนดค่าการดาวน์โหลดตามขั้นตอน สิทธิ์ในการดาวน์โหลด และกฎความชัดเจนของไฟล์ หากไฟล์ที่ต้องการดาวน์โหลดระหว่างกระบวนการลงนามจำเป็นต้องมีการสร้างภาพน้ำแบบอะซิงโครนัส อินเทอร์เฟซจะส่งกลับ ID งานดาวน์โหลด ซึ่งลูกค้าสามารถรับผลลัพธ์ของไฟล์ผ่านอินเทอร์เฟซสอบถามงานดาวน์โหลดหรือการเรียกกลับเมื่องานดาวน์โหลดเสร็จสิ้น

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

ชื่อพารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
envelopeId	string	true	ID ซอง
downloadType	string	false	ประเภทรูปแบบการดาวน์โหลดไฟล์: zip (ค่าเริ่มต้น): ส่งกลับลิงก์ดาวน์โหลดไฟล์บีบอัด list: ส่งกลับรายการไฟล์

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

GET https://……/esignglobal/v1/envelope/files/download?envelopeId=flow1234567890&downloadType=list

พารามิเตอร์การตอบสนอง

ชื่อพารามิเตอร์		ประเภท	คำอธิบาย
envelopeId		string	รหัสซองจดหมาย
envelopeStatus		int	สถานะซองจดหมาย 0- สร้างแล้ว (ร่าง) 1-กำลังลงนาม 2-เสร็จสิ้นแล้ว 3-หมดอายุ 5-ยกเลิกแล้ว
taskId		string	รหัสงานดาวน์โหลด จะส่งคืนเฉพาะเมื่ออยู่ระหว่างการลงนามในซองเอกสารและไฟล์จำเป็นต้องสร้างลายน้ำแบบอะซิงโครนัสเท่านั้น 【หมายเหตุ】เมื่อส่งกลับ taskId จะไม่คืนค่า downloadUrl, envelopeFiles และฟิลด์ผลลัพธ์ไฟล์อื่นๆ
downloadUrl		string	ลิงก์ดาวน์โหลดไฟล์ 【หมายเหตุ】ใช้งานได้ภายใน 30 นาที หากหมดอายุโปรดเรียก API อีกครั้งเพื่อรับลิงก์ดาวน์โหลด ส่งกลับเมื่อ downloadType=zip และสามารถส่งผลลัพธ์ไฟล์แบบซิงโครนัสได้; ไม่ส่งกลับฟิลด์นี้เมื่อมีการส่งค่า taskId
envelopeFiles		array	ชุดไฟล์ซองจดหมาย 【หมายเหตุ】จะส่งกลับเมื่อ downloadType=list และสามารถส่งกลับผลลัพธ์ไฟล์แบบซิงโครนัสได้; ไม่ส่งกลับฟิลด์นี้เมื่อส่งกลับ taskId
	fileType	string	ประเภทไฟล์ CONTRACT- เอกสารที่ลงนาม ATTACHMENT- ไฟล์แนบ CERTIFICATE- ใบรับรอง COMBINED- ไฟล์ PDF ที่รวม "เอกสารที่ลงนาม" และ "หลักฐานการลงนามเสร็จสิ้น" ไว้ด้วยกัน จะส่งกลับเมื่อเปิดใช้งาน "ดาวน์โหลดไฟล์ที่รวมในซอง"
	fileName	string	ชื่อไฟล์
	downloadUrl	string	ที่อยู่สำหรับดาวน์โหลดไฟล์ (ใช้งานได้ภายใน 60 นาที)

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

{
    "code": "0",
    "data": {
    "envelopeId": "xxxx",
      "downloadUrl": "下载地址",
      "envelopeStatus": 2
  },
  "message": "success"
}

เมื่อดำเนินการลงนามอยู่และไฟล์ต้องการการประกอบภาพน้ำแบบอะซิงโครนัส ตัวอย่างการตอบสนองมีดังนี้:

{
    "code": "0",
    "data": {
      "envelopeId": "xxxx",
      "envelopeStatus": 1,
      "taskId": "task1234567890"
  },
  "message": "success"
}