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