ศูนย์นักพัฒนา

เพิ่มเอกสารเพื่อลงนาม

POST /esignglobal/v1/envelope/files/addSignFiles

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

เมื่อซองจดหมายยังไม่เปิดใช้งาน สามารถเพิ่มไฟล์ที่รอการลงนามในซองจดหมายได้ แต่ซองจดหมายที่เปิดใช้งานแล้วจะไม่รองรับการเพิ่มไฟล์ลงนามเพิ่มเติม

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

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

ประเภท

จำเป็น

คำอธิบาย

envelopeId

string

true

ID ซองจดหมาย

signFiles

array

true

ชุดข้อมูลข้อมูลไฟล์ลงนาม ลำดับการแสดงผลคือลำดับการเพิ่มไฟล์

 

fileKey

string

true

fileKey ของไฟล์ลงนาม รองรับเฉพาะรูปแบบ PDF เท่านั้น

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

{   
  "envelopeId": "9fbe6c8190824227bde29136b0145c81",
  "signFiles": [
  {
    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
  }
]
}

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

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

ประเภท

คำอธิบาย

code

int

รหัสธุรกิจ, 0 หมายถึงสำเร็จ, นอกเหนือจาก 0 หมายถึงผิดปกติ

message

string

ข้อมูลธุรกิจ

【ข้อควรระวัง】โปรดตัดสินสถานการณ์ข้อผิดพลาดตามรหัส (code) ไม่ควรขึ้นอยู่กับการจับคู่ข้อความ (message) เพราะข้อความ (message) อาจมีการปรับเปลี่ยน

data

object

ข้อมูลธุรกิจ

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

{
    "code": "0",
    "message": "success",
    "data": null
}

 

คำอธิบายอินเทอร์เฟซ
พารามิเตอร์คำขอ
ตัวอย่างคำขอ
พารามิเตอร์การตอบสนอง
ตัวอย่างการตอบสนอง