eSign.AIeSign.AI
Trung tâm nhà phát triển

Thêm tệp ký

POST /esignglobal/v1/envelope/files/addSignFiles

Mô tả giao diện

Khi phong bì chưa được mở, có thể thêm các tài liệu cần ký vào phong bì; những phong bì đã mở không hỗ trợ bổ sung tài liệu ký.

Tham số yêu cầu

Tên tham số

Kiểu dữ liệu

Bắt buộc

Giải thích

envelopeId

string

true

ID phong bì

signFiles

array

true

Tập hợp thông tin tài liệu ký, thứ tự hiển thị theo thứ tự thêm tài liệu.

 

fileKey

string

true

fileKey của tài liệu ký, chỉ hỗ trợ định dạng PDF

 documentFieldsarrayfalseDanh sách điều khiển cấp độ tài liệu. Dùng để thêm các điều khiển cấp độ tài liệu không gắn với người ký trên một tài liệu cụ thể.
  

fieldType

string

false

Loại điều khiển. Truyền eMeterai để biểu thị điều khiển thuế tem Indonesia.

  

pageNo

string

false

Số trang mà điều khiển nằm trên đó. Điều khiển thuế tem Indonesia chỉ hỗ trợ chỉ định một trang đơn lẻ, cần truyền một số trang duy nhất, không hỗ trợ các định dạng nhiều trang liên tiếp hoặc không liên tiếp như 1-3, 1,3.

  posXfloatfalseĐộ lệch trục x, gốc tọa độ là góc dưới bên trái của trang. Phạm vi tọa độ giống với phạm vi tọa độ của các điều khiển khác.
  posYfloatfalseĐộ lệch trục y, gốc tọa độ là góc dưới bên trái của trang. Phạm vi tọa độ giống với phạm vi tọa độ của các điều khiển khác.

Ví dụ yêu cầu

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

Tham số phản hồi

Tên tham số

Kiểu dữ liệu

Mô tả

code

int

Mã nghiệp vụ, 0 biểu thị thành công, khác 0 biểu thị lỗi.

message

string

Thông tin nghiệp vụ

[Lưu ý] Vui lòng dựa vào code để xác định tình trạng lỗi, không nên phụ thuộc vào việc khớp message vì message có thể được điều chỉnh.

data

object

Dữ liệu nghiệp vụ

Ví dụ phản hồi

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