GET /esignglobal/v1/envelope/files/download
คำอธิบาย API
รองรับการดาวน์โหลดไฟล์ภายในซองเอกสารแบบรวมกลุ่ม เฉพาะเมื่อซองเอกสารเสร็จสมบูรณ์เท่านั้น
พารามิเตอร์คำขอ
ชื่อพารามิเตอร์ | ประเภท | จำเป็นต้องกรอก | คำอธิบาย |
envelopeId | string | true | รหัสซองเอกสาร |
downloadType | string | false | ประเภทรูปแบบการดาวน์โหลดไฟล์： |
ตัวอย่างคำขอ
GET https://……/esignglobal/v1/envelope/files/download?envelopeId=flow1234567890&downloadType=list
พารามิเตอร์การตอบกลับ
ชื่อพารามิเตอร์ | ประเภท | คำอธิบาย |
envelopeId | string | รหัสซองเอกสาร |
envelopeStatus | int | สถานะซองเอกสาร 0- สร้างแล้ว (ฉบับร่าง) 1- กำลังลงนาม 2- เสร็จสมบูรณ์ 3- หมดอายุ 5- ยกเลิกแล้ว |
downloadUrl | string | ที่อยู่ดาวน์โหลดไฟล์ 【หมายเหตุ】ใช้งานได้ภายใน 30 นาที หากหมดอายุโปรดเรียกใช้ API อีกครั้งเพื่อขอที่อยู่ดาวน์โหลดไฟล์ ส่งกลับเมื่อ downloadType=zip |
envelopeFiles | array | ชุดไฟล์ในซองเอกสาร ชุดไฟล์ในซองเอกสาร 【หมายเหตุ】ส่งกลับเมื่อ downloadType=list |
| fileType | string | ประเภทไฟล์ CONTRACT-เอกสารที่ลงนาม ATTACHMENT-ไฟล์แนบ CERTIFICATE-ใบรับรอง COMBINED-ไฟล์ PDF ที่รวม“เอกสารที่ลงนาม”และ“หลักฐานการลงนามเสร็จสิ้น”ไว้ด้วยกัน จะส่งคืนเมื่อเปิดใช้งาน“ดาวน์โหลดไฟล์ซองจดหมายแบบรวม” |
| fileName | string | ชื่อไฟล์ |
| downloadUrl | string | ลิงก์ดาวน์โหลดไฟล์ (ใช้งานได้ภายใน 60 นาที) |
ตัวอย่างการตอบกลับ
{
"code": "0",
"data": {
"envelopeId": "xxxx",
"downloadUrl": "下载地址",
"envelopeStatus": 2
},
"message": "success"
}
